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

#include <FrameDataManager.h>

Inherits MemoryPoolObject.

Public Member Functions

 FrameDataManager (Bool isLocal)
 
void init ()
 
void reset ()
 
void update ()
 
void addNetCommandMsg (NetCommandMsg *msg)
 
void setIsLocal (Bool isLocal)
 
FrameDataReturnType allCommandsReady (UnsignedInt frame, Bool debugSpewage)
 
NetCommandList * getFrameCommandList (UnsignedInt frame)
 
UnsignedInt getCommandCount (UnsignedInt frame)
 
void setFrameCommandCount (UnsignedInt frame, UnsignedInt commandCount)
 
UnsignedInt getFrameCommandCount (UnsignedInt frame)
 
void zeroFrames (UnsignedInt startingFrame, UnsignedInt numFrames)
 
void destroyGameMessages ()
 
void resetFrame (UnsignedInt frame, Bool isAdvancing=TRUE)
 
void setQuitFrame (UnsignedInt frame)
 
UnsignedInt getQuitFrame ()
 
Bool getIsQuitting ()
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 

Protected Attributes

FrameData * m_frameData
 
Bool m_isLocal
 
Bool m_isQuitting
 
UnsignedInt m_quitFrame
 

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 34 of file FrameDataManager.h.

Constructor & Destructor Documentation

◆ FrameDataManager()

FrameDataManager::FrameDataManager ( Bool isLocal)

Constructor. isLocal tells it whether its the frame data manager for the local player or not.

Definition at line 34 of file FrameDataManager.cpp.

Member Function Documentation

◆ addNetCommandMsg()

void FrameDataManager::addNetCommandMsg ( NetCommandMsg * msg)

Add a network command to the appropriate frame.

Definition at line 90 of file FrameDataManager.cpp.

◆ allCommandsReady()

FrameDataReturnType FrameDataManager::allCommandsReady ( UnsignedInt frame,
Bool debugSpewage )

Returns true if all the commands for the given frame are ready.

Definition at line 105 of file FrameDataManager.cpp.

◆ destroyGameMessages()

void FrameDataManager::destroyGameMessages ( )

Destroy all the commands held by this object.

Definition at line 181 of file FrameDataManager.cpp.

◆ getCommandCount()

UnsignedInt FrameDataManager::getCommandCount ( UnsignedInt frame)

Returns the command count for the given frame.

Definition at line 141 of file FrameDataManager.cpp.

◆ getFrameCommandCount()

UnsignedInt FrameDataManager::getFrameCommandCount ( UnsignedInt frame)

Definition at line 159 of file FrameDataManager.cpp.

◆ getFrameCommandList()

NetCommandList * FrameDataManager::getFrameCommandList ( UnsignedInt frame)

Returns the command list for the given frame.

Definition at line 114 of file FrameDataManager.cpp.

◆ getIsQuitting()

Bool FrameDataManager::getIsQuitting ( )

returns true if this frame data manager is quitting.

Definition at line 205 of file FrameDataManager.cpp.

◆ getQuitFrame()

UnsignedInt FrameDataManager::getQuitFrame ( )

returns the quit frame.

Definition at line 198 of file FrameDataManager.cpp.

◆ init()

void FrameDataManager::init ( )

Initialize all of the frame datas associated with this manager.

Definition at line 61 of file FrameDataManager.cpp.

◆ reset()

void FrameDataManager::reset ( )

Reset the state of all the frames.

Definition at line 77 of file FrameDataManager.cpp.

◆ resetFrame()

void FrameDataManager::resetFrame ( UnsignedInt frame,
Bool isAdvancing = TRUE )

Reset the contents of the given frame.

Definition at line 122 of file FrameDataManager.cpp.

◆ setFrameCommandCount()

void FrameDataManager::setFrameCommandCount ( UnsignedInt frame,
UnsignedInt commandCount )

Set the frame command count for the given frame.

Definition at line 150 of file FrameDataManager.cpp.

◆ setIsLocal()

void FrameDataManager::setIsLocal ( Bool isLocal)

◆ setQuitFrame()

void FrameDataManager::setQuitFrame ( UnsignedInt frame)

Sets the quit frame, also sets the isQuitting flag.

Definition at line 190 of file FrameDataManager.cpp.

◆ update()

void FrameDataManager::update ( )

update function. Does nothing at this time.

Definition at line 84 of file FrameDataManager.cpp.

◆ zeroFrames()

void FrameDataManager::zeroFrames ( UnsignedInt startingFrame,
UnsignedInt numFrames )

Set both the command count and the frame command count to 0 for the given frames.

Definition at line 168 of file FrameDataManager.cpp.

Member Data Documentation

◆ m_frameData

FrameData* FrameDataManager::m_frameData
protected

Definition at line 60 of file FrameDataManager.h.

◆ m_isLocal

Bool FrameDataManager::m_isLocal
protected

Definition at line 61 of file FrameDataManager.h.

◆ m_isQuitting

Bool FrameDataManager::m_isQuitting
protected

Definition at line 63 of file FrameDataManager.h.

◆ m_quitFrame

UnsignedInt FrameDataManager::m_quitFrame
protected

Definition at line 64 of file FrameDataManager.h.

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