Odamex
Setting the Standard in Multiplayer Doom
agOdalaunch::Xbox Class Reference

Xbox Class. More...

#include <xbox_main.h>

Static Public Member Functions

static char * InetNtoa (struct in_addr in)
 Network Byte Order address to ascii string.
static struct hostentGetHostByName (const char *name)
 Get Host by Name.
static int InitializeJoystick (void)
 Initialize the Xbox joystick.
static void EnableJoystickUpdates (bool enable)
 Enable or disable Xbox joystick updates.
static void MountPartitions ()
 Mount Xbox partitions.
static void UnMountPartitions ()
 Unmount Xbox partitions.
static void OutputDebugString (const char *str,...)
 Output a string for debugging.
static int InitLogFile ()
 Initialize the log file.
static void CloseLogFile ()
 Close the log file.
static void InitNet ()
 Initialize the network adapter.
static void CloseNetwork ()
 Close the network adapter.
static void EnableDebugConsole ()
 Enable the debug console.

Detailed Description

Xbox Class.

The Xbox class provides utilities and function overrides that are needed for the Xbox platform.


Member Function Documentation

void agOdalaunch::Xbox::CloseLogFile ( ) [static]

Close the log file.

This function closes the Xbox log file.

void agOdalaunch::Xbox::CloseNetwork ( ) [static]

Close the network adapter.

Close the Xbox network adapter and release any leased IP address.

void agOdalaunch::Xbox::EnableDebugConsole ( ) [static]

Enable the debug console.

This function enables the debug console which causes debug output to be sent to the debug console.

void agOdalaunch::Xbox::EnableJoystickUpdates ( bool  enable) [static]

Enable or disable Xbox joystick updates.

The Xbox joystick can be enabled or disabled by passing true or false to this function.

Parameters:
enabletrue or false.
struct hostent * agOdalaunch::Xbox::GetHostByName ( const char *  name) [static, read]

Get Host by Name.

This is a custom implementation of gethostbyname() for Xbox. gethostbyname() returns a hostent structure for the provided hostname or IP address.

Parameters:
nameA hostname or IP address.
Returns:
A filled in hostent structure or NULL on error.
char * agOdalaunch::Xbox::InetNtoa ( struct in_addr  in) [static]

Network Byte Order address to ascii string.

This is a custom implementation of inet_ntoa() for Xbox. inet_ntoa() converts an internet address in network byte order to an ascii string.

Parameters:
inNetwork address.
Returns:
Address ascii string.
int agOdalaunch::Xbox::InitializeJoystick ( void  ) [static]

Initialize the Xbox joystick.

This function initializes the Xbox joystick which will move the cursor within the launcher as well as activate widgets.

Returns:
0 on success, -1 on error.
int agOdalaunch::Xbox::InitLogFile ( ) [static]

Initialize the log file.

This function open the Xbox log file for writing.

Returns:
0 on success, -1 on error.
void agOdalaunch::Xbox::InitNet ( ) [static]

Initialize the network adapter.

Initialize the Xbox network adapter and attempt to obtain an IP address.

void agOdalaunch::Xbox::MountPartitions ( ) [static]

Mount Xbox partitions.

This function mounts the Xbox partitions which makes them available for reading and writing.

void agOdalaunch::Xbox::OutputDebugString ( const char *  str,
  ... 
) [static]

Output a string for debugging.

Provided a string, with optional standard variable arguments, this function will write the contents to a debug file and, if running in the debugger, print the string to the debug console.

Parameters:
strThe formatted string.
...Standard variable arguments.
void agOdalaunch::Xbox::UnMountPartitions ( ) [static]

Unmount Xbox partitions.

This function unmounts the Xbox partitions.


The documentation for this class was generated from the following files:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends