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
NetCommandMsg Class Reference

#include <NetCommandMsg.h>

Inherits MemoryPoolObject.

Inherited by NetAckBothCommandMsg, NetAckStage1CommandMsg, NetAckStage2CommandMsg, NetChatCommandMsg, NetDestroyPlayerCommandMsg, NetDisconnectChatCommandMsg, NetDisconnectFrameCommandMsg, NetDisconnectKeepAliveCommandMsg, NetDisconnectPlayerCommandMsg, NetDisconnectScreenOffCommandMsg, NetDisconnectVoteCommandMsg, NetFileAnnounceCommandMsg, NetFileCommandMsg, NetFileProgressCommandMsg, NetFrameCommandMsg, NetFrameResendRequestCommandMsg, NetGameCommandMsg, NetKeepAliveCommandMsg, NetPacketRouterAckCommandMsg, NetPacketRouterQueryCommandMsg, NetPlayerLeaveCommandMsg, NetProgressCommandMsg, NetRunAheadCommandMsg, NetRunAheadMetricsCommandMsg, and NetWrapperCommandMsg.

Public Member Functions

 NetCommandMsg ()
 
UnsignedInt GetTimestamp ()
 
void SetTimestamp (UnsignedInt timestamp)
 
void setExecutionFrame (UnsignedInt frame)
 
void setPlayerID (UnsignedInt playerID)
 
void setID (UnsignedShort id)
 
UnsignedInt getExecutionFrame ()
 
UnsignedInt getPlayerID ()
 
UnsignedShort getID ()
 
void setNetCommandType (NetCommandType type)
 
NetCommandType getNetCommandType ()
 
virtual Int getSortNumber ()
 
void attach ()
 
void detach ()
 
virtual AsciiString getContentsAsAsciiString (void)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 

Protected Attributes

UnsignedInt m_timestamp
 
UnsignedInt m_executionFrame
 
UnsignedInt m_playerID
 
UnsignedShort m_id
 
NetCommandType m_commandType
 
Int m_referenceCount
 

Additional Inherited Members

- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPool * getObjectMemoryPool ()=0
 

Detailed Description

Definition at line 39 of file NetCommandMsg.h.

Constructor & Destructor Documentation

◆ NetCommandMsg()

NetCommandMsg::NetCommandMsg ( )

Base constructor

Definition at line 36 of file NetCommandMsg.cpp.

Member Function Documentation

◆ attach()

void NetCommandMsg::attach ( )

Adds one to the reference count.

Definition at line 59 of file NetCommandMsg.cpp.

◆ detach()

void NetCommandMsg::detach ( )

Subtracts one from the reference count. If the reference count is 0, the this object is destroyed.

Definition at line 66 of file NetCommandMsg.cpp.

◆ getContentsAsAsciiString()

virtual AsciiString NetCommandMsg::getContentsAsAsciiString ( void )
inlinevirtual

Reimplemented in NetGameCommandMsg.

Definition at line 60 of file NetCommandMsg.h.

◆ getExecutionFrame()

UnsignedInt NetCommandMsg::getExecutionFrame ( )
inline

Definition at line 50 of file NetCommandMsg.h.

◆ getID()

UnsignedShort NetCommandMsg::getID ( )
inline

Definition at line 52 of file NetCommandMsg.h.

◆ getNetCommandType()

NetCommandType NetCommandMsg::getNetCommandType ( )
inline

Definition at line 54 of file NetCommandMsg.h.

◆ getPlayerID()

UnsignedInt NetCommandMsg::getPlayerID ( )
inline

Definition at line 51 of file NetCommandMsg.h.

◆ getSortNumber()

Int NetCommandMsg::getSortNumber ( )
virtual

Returns the value by which this type of message should be sorted.

Reimplemented in NetAckBothCommandMsg, NetAckStage1CommandMsg, and NetAckStage2CommandMsg.

Definition at line 81 of file NetCommandMsg.cpp.

◆ GetTimestamp()

UnsignedInt NetCommandMsg::GetTimestamp ( )
inline

Definition at line 45 of file NetCommandMsg.h.

◆ setExecutionFrame()

void NetCommandMsg::setExecutionFrame ( UnsignedInt frame)
inline

Definition at line 47 of file NetCommandMsg.h.

◆ setID()

void NetCommandMsg::setID ( UnsignedShort id)
inline

Definition at line 49 of file NetCommandMsg.h.

◆ setNetCommandType()

void NetCommandMsg::setNetCommandType ( NetCommandType type)
inline

Definition at line 53 of file NetCommandMsg.h.

◆ setPlayerID()

void NetCommandMsg::setPlayerID ( UnsignedInt playerID)
inline

Definition at line 48 of file NetCommandMsg.h.

◆ SetTimestamp()

void NetCommandMsg::SetTimestamp ( UnsignedInt timestamp)
inline

Definition at line 46 of file NetCommandMsg.h.

Member Data Documentation

◆ m_commandType

NetCommandType NetCommandMsg::m_commandType
protected

Definition at line 68 of file NetCommandMsg.h.

◆ m_executionFrame

UnsignedInt NetCommandMsg::m_executionFrame
protected

Definition at line 64 of file NetCommandMsg.h.

◆ m_id

UnsignedShort NetCommandMsg::m_id
protected

Definition at line 66 of file NetCommandMsg.h.

◆ m_playerID

UnsignedInt NetCommandMsg::m_playerID
protected

Definition at line 65 of file NetCommandMsg.h.

◆ m_referenceCount

Int NetCommandMsg::m_referenceCount
protected

Definition at line 69 of file NetCommandMsg.h.

◆ m_timestamp

UnsignedInt NetCommandMsg::m_timestamp
protected

Definition at line 63 of file NetCommandMsg.h.

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