Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
GameSpyGameSlot Class Reference

#include <StagingRoomGameInfo.h>

Inherits GameSlot, and GameSlot.

Public Member Functions

 GameSpyGameSlot ()
 
Int getProfileID (void) const
 
void setProfileID (Int id)
 
AsciiString getLoginName (void) const
 
void setLoginName (AsciiString name)
 
AsciiString getLocale (void) const
 
void setLocale (AsciiString name)
 
Int getWins (void) const
 
Int getLosses (void) const
 
void setWins (Int wins)
 
void setLosses (Int losses)
 
Int getSlotRankPoints (void) const
 
Int getFavoriteSide (void) const
 
void setSlotRankPoints (Int val)
 
void setFavoriteSide (Int val)
 
void setPingString (AsciiString pingStr)
 
AsciiString getPingString (void) const
 
Int getPingAsInt (void) const
 
 GameSpyGameSlot ()
 
Int getProfileID (void)
 
void setProfileID (Int id)
 
AsciiString getLoginName (void)
 
void setLoginName (AsciiString name)
 
AsciiString getLocale (void)
 
void setLocale (AsciiString name)
 
- Public Member Functions inherited from GameSlot
 GameSlot ()
 
virtual void reset ()
 
void setAccept (void)
 Accept the current options.
 
void unAccept (void)
 Unaccept (options changed, etc)
 
Bool isAccepted (void) const
 Non-human slots are always accepted.
 
void setMapAvailability (Bool hasMap)
 Set whether the slot has the map.
 
Bool hasMap (void) const
 Non-human slots always have the map.
 
void setState (SlotState state, UnicodeString name=UnicodeString::TheEmptyString, UnsignedInt IP=0)
 Set the slot's state (human, AI, open, etc)
 
SlotState getState (void) const
 Get the slot state.
 
void setColor (Int color)
 
Int getColor (void) const
 
void setStartPos (Int startPos)
 
Int getStartPos (void) const
 
void setPlayerTemplate (Int playerTemplate)
 
Int getPlayerTemplate (void) const
 
void setTeamNumber (Int teamNumber)
 
Int getTeamNumber (void) const
 
void setName (UnicodeString name)
 
UnicodeString getName (void) const
 
void setIP (UnsignedInt IP)
 
UnsignedInt getIP (void) const
 
void setPort (UnsignedShort port)
 
UnsignedShort getPort (void) const
 
void setNATBehavior (FirewallHelperClass::FirewallBehaviorType NATBehavior)
 
FirewallHelperClass::FirewallBehaviorType getNATBehavior () const
 
void saveOffOriginalInfo (void)
 
Int getOriginalPlayerTemplate (void) const
 
Int getOriginalColor (void) const
 
Int getOriginalStartPos (void) const
 
Int getApparentPlayerTemplate (void) const
 
Int getApparentColor (void) const
 
Int getApparentStartPos (void) const
 
UnicodeString getApparentPlayerTemplateDisplayName (void) const
 
Bool isHuman (void) const
 Is this slot occupied by a human player?
 
Bool isOccupied (void) const
 Is this slot occupied (by a human or an AI)?
 
Bool isAI (void) const
 Is this slot occupied by an AI?
 
Bool isPlayer (AsciiString userName) const
 Does this slot contain the given user?
 
Bool isPlayer (UnicodeString userName) const
 Does this slot contain the given user?
 
Bool isPlayer (UnsignedInt ip) const
 Is this slot at this IP?
 
Bool isOpen (void) const
 
void setLastFrameInGame (UnsignedInt frame)
 
void markAsDisconnected (void)
 
UnsignedInt lastFrameInGame (void) const
 
Bool disconnected (void) const
 
void mute (Bool isMuted)
 
Bool isMuted (void) const
 

Protected Attributes

Int m_profileID
 
AsciiString m_gameSpyLogin
 
AsciiString m_gameSpyLocale
 
AsciiString m_pingStr
 
Int m_pingInt
 
Int m_wins
 
Int m_losses
 
Int m_rankPoints
 
Int m_favoriteSide
 
- Protected Attributes inherited from GameSlot
SlotState m_state
 
Bool m_isAccepted
 
Bool m_hasMap
 
Bool m_isMuted
 
Int m_color
 color, or -1 for random
 
Int m_startPos
 start position, or -1 for random
 
Int m_playerTemplate
 PlayerTemplate.
 
Int m_teamNumber
 alliance, -1 for none
 
Int m_origColor
 color, or -1 for random
 
Int m_origStartPos
 start position, or -1 for random
 
Int m_origPlayerTemplate
 PlayerTemplate.
 
UnicodeString m_name
 Only valid for human players.
 
UnsignedInt m_IP
 Only valid for human players in LAN/WOL.
 
UnsignedShort m_port
 Only valid for human players in LAN/WOL.
 
FirewallHelperClass::FirewallBehaviorType m_NATBehavior
 The NAT behavior for this slot's player.
 
UnsignedInt m_lastFrameInGame
 
Bool m_disconnected
 

Detailed Description

Definition at line 37 of file StagingRoomGameInfo.h.

Constructor & Destructor Documentation

◆ GameSpyGameSlot() [1/2]

GameSpyGameSlot::GameSpyGameSlot ( )

Definition at line 59 of file StagingRoomGameInfo.cpp.

◆ GameSpyGameSlot() [2/2]

GameSpyGameSlot::GameSpyGameSlot ( )

Member Function Documentation

◆ getFavoriteSide()

Int GameSpyGameSlot::getFavoriteSide ( void ) const
inline

Definition at line 53 of file StagingRoomGameInfo.h.

◆ getLocale() [1/2]

AsciiString GameSpyGameSlot::getLocale ( void )
inline

Definition at line 51 of file GameSpyGameInfo.h.

◆ getLocale() [2/2]

AsciiString GameSpyGameSlot::getLocale ( void ) const
inline

Definition at line 45 of file StagingRoomGameInfo.h.

◆ getLoginName() [1/2]

AsciiString GameSpyGameSlot::getLoginName ( void )
inline

Definition at line 49 of file GameSpyGameInfo.h.

◆ getLoginName() [2/2]

AsciiString GameSpyGameSlot::getLoginName ( void ) const
inline

Definition at line 43 of file StagingRoomGameInfo.h.

◆ getLosses()

Int GameSpyGameSlot::getLosses ( void ) const
inline

Definition at line 48 of file StagingRoomGameInfo.h.

◆ getPingAsInt()

Int GameSpyGameSlot::getPingAsInt ( void ) const
inline

Definition at line 59 of file StagingRoomGameInfo.h.

◆ getPingString()

AsciiString GameSpyGameSlot::getPingString ( void ) const
inline

Definition at line 58 of file StagingRoomGameInfo.h.

◆ getProfileID() [1/2]

Int GameSpyGameSlot::getProfileID ( void )
inline

Definition at line 47 of file GameSpyGameInfo.h.

◆ getProfileID() [2/2]

Int GameSpyGameSlot::getProfileID ( void ) const
inline

Definition at line 41 of file StagingRoomGameInfo.h.

◆ getSlotRankPoints()

Int GameSpyGameSlot::getSlotRankPoints ( void ) const
inline

Definition at line 52 of file StagingRoomGameInfo.h.

◆ getWins()

Int GameSpyGameSlot::getWins ( void ) const
inline

Definition at line 47 of file StagingRoomGameInfo.h.

◆ setFavoriteSide()

void GameSpyGameSlot::setFavoriteSide ( Int val)
inline

Definition at line 55 of file StagingRoomGameInfo.h.

◆ setLocale() [1/2]

void GameSpyGameSlot::setLocale ( AsciiString name)
inline

Definition at line 46 of file StagingRoomGameInfo.h.

◆ setLocale() [2/2]

void GameSpyGameSlot::setLocale ( AsciiString name)
inline

Definition at line 52 of file GameSpyGameInfo.h.

◆ setLoginName() [1/2]

void GameSpyGameSlot::setLoginName ( AsciiString name)
inline

Definition at line 44 of file StagingRoomGameInfo.h.

◆ setLoginName() [2/2]

void GameSpyGameSlot::setLoginName ( AsciiString name)
inline

Definition at line 50 of file GameSpyGameInfo.h.

◆ setLosses()

void GameSpyGameSlot::setLosses ( Int losses)
inline

Definition at line 50 of file StagingRoomGameInfo.h.

◆ setPingString()

void GameSpyGameSlot::setPingString ( AsciiString pingStr)

Definition at line 449 of file StagingRoomGameInfo.cpp.

◆ setProfileID() [1/2]

void GameSpyGameSlot::setProfileID ( Int id)
inline

Definition at line 42 of file StagingRoomGameInfo.h.

◆ setProfileID() [2/2]

void GameSpyGameSlot::setProfileID ( Int id)
inline

Definition at line 48 of file GameSpyGameInfo.h.

◆ setSlotRankPoints()

void GameSpyGameSlot::setSlotRankPoints ( Int val)
inline

Definition at line 54 of file StagingRoomGameInfo.h.

◆ setWins()

void GameSpyGameSlot::setWins ( Int wins)
inline

Definition at line 49 of file StagingRoomGameInfo.h.

Member Data Documentation

◆ m_favoriteSide

Int GameSpyGameSlot::m_favoriteSide
protected

Definition at line 69 of file StagingRoomGameInfo.h.

◆ m_gameSpyLocale

AsciiString GameSpyGameSlot::m_gameSpyLocale
protected

Definition at line 64 of file StagingRoomGameInfo.h.

◆ m_gameSpyLogin

AsciiString GameSpyGameSlot::m_gameSpyLogin
protected

Definition at line 63 of file StagingRoomGameInfo.h.

◆ m_losses

Int GameSpyGameSlot::m_losses
protected

Definition at line 68 of file StagingRoomGameInfo.h.

◆ m_pingInt

Int GameSpyGameSlot::m_pingInt
protected

Definition at line 67 of file StagingRoomGameInfo.h.

◆ m_pingStr

AsciiString GameSpyGameSlot::m_pingStr
protected

Definition at line 66 of file StagingRoomGameInfo.h.

◆ m_profileID

Int GameSpyGameSlot::m_profileID
protected

Definition at line 62 of file StagingRoomGameInfo.h.

◆ m_rankPoints

Int GameSpyGameSlot::m_rankPoints
protected

Definition at line 69 of file StagingRoomGameInfo.h.

◆ m_wins

Int GameSpyGameSlot::m_wins
protected

Definition at line 68 of file StagingRoomGameInfo.h.

The documentation for this class was generated from the following files: