Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
NetAckStage2CommandMsg Class Reference

#include <NetCommandMsg.h>

Inherits NetCommandMsg.

Public Member Functions

 NetAckStage2CommandMsg (NetCommandMsg *msg)
 
 NetAckStage2CommandMsg ()
 
UnsignedShort getCommandID ()
 
void setCommandID (UnsignedShort commandID)
 
UnsignedByte getOriginalPlayerID ()
 
void setOriginalPlayerID (UnsignedByte originalPlayerID)
 
virtual Int getSortNumber ()
 
- Public Member Functions inherited from NetCommandMsg
 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 ()
 
void attach ()
 
void detach ()
 
virtual AsciiString getContentsAsAsciiString (void)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 

Protected Attributes

UnsignedShort m_commandID
 
UnsignedByte m_originalPlayerID
 
- Protected Attributes inherited from NetCommandMsg
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 MemoryPoolgetObjectMemoryPool ()=0
 

Detailed Description

The NetAckStage2CommandMsg is the NetCommandMsg representation of an ack message for all eventual recipients. (when this is returned, all the players in the relay mask have received the packet)

Definition at line 152 of file NetCommandMsg.h.

Constructor & Destructor Documentation

◆ NetAckStage2CommandMsg() [1/2]

NetAckStage2CommandMsg::NetAckStage2CommandMsg ( NetCommandMsg * msg)

Constructor. Sets the member variables according to the given message.

Definition at line 348 of file NetCommandMsg.cpp.

◆ NetAckStage2CommandMsg() [2/2]

NetAckStage2CommandMsg::NetAckStage2CommandMsg ( )

Constructor. Sets the member variables to default values.

Definition at line 357 of file NetCommandMsg.cpp.

Member Function Documentation

◆ getCommandID()

UnsignedShort NetAckStage2CommandMsg::getCommandID ( )

Returns the command ID of the command being ack'd.

Definition at line 370 of file NetCommandMsg.cpp.

◆ getOriginalPlayerID()

UnsignedByte NetAckStage2CommandMsg::getOriginalPlayerID ( )

Get the player id of the player who originally sent the command.

Definition at line 384 of file NetCommandMsg.cpp.

◆ getSortNumber()

Int NetAckStage2CommandMsg::getSortNumber ( )
virtual

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

Reimplemented from NetCommandMsg.

Definition at line 395 of file NetCommandMsg.cpp.

◆ setCommandID()

void NetAckStage2CommandMsg::setCommandID ( UnsignedShort commandID)

Set the command ID of the command being ack'd.

Definition at line 377 of file NetCommandMsg.cpp.

◆ setOriginalPlayerID()

void NetAckStage2CommandMsg::setOriginalPlayerID ( UnsignedByte originalPlayerID)

Set the player id of the player who originally sent the command.

Definition at line 391 of file NetCommandMsg.cpp.

Member Data Documentation

◆ m_commandID

UnsignedShort NetAckStage2CommandMsg::m_commandID
protected

Definition at line 167 of file NetCommandMsg.h.

◆ m_originalPlayerID

UnsignedByte NetAckStage2CommandMsg::m_originalPlayerID
protected

Definition at line 168 of file NetCommandMsg.h.


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