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

#include <CaveSystem.h>

Inherits SubsystemInterface, and Snapshot.

Public Member Functions

 CaveSystem ()
 
 ~CaveSystem ()
 
void init ()
 
void reset ()
 
void update ()
 
Bool canSwitchIndexToIndex (Int oldIndex, Int newIndex)
 
void registerNewCave (Int theIndex)
 
void unregisterCave (Int theIndex)
 
TunnelTrackergetTunnelTrackerForCaveIndex (Int theIndex)
 
- Public Member Functions inherited from SubsystemInterface
 SubsystemInterface ()
 
virtual ~SubsystemInterface ()
 
virtual void postProcessLoad ()
 
virtual void draw (void)
 
void UPDATE (void)
 
void DRAW (void)
 
AsciiString getName (void)
 
void setName (AsciiString name)
 
- Public Member Functions inherited from Snapshot
 Snapshot (void)
 
 ~Snapshot (void)
 

Protected Member Functions

virtual void crc (Xfer *xfer)
 run the "light" crc check on this data structure
 
virtual void xfer (Xfer *xfer)
 
virtual void loadPostProcess (void)
 

Additional Inherited Members

- Protected Attributes inherited from SubsystemInterface
AsciiString m_name
 

Detailed Description

System responsible for Crates as code objects - ini, new/delete etc

Definition at line 45 of file CaveSystem.h.

Constructor & Destructor Documentation

◆ CaveSystem()

CaveSystem::CaveSystem ( )

Definition at line 39 of file CaveSystem.cpp.

◆ ~CaveSystem()

CaveSystem::~CaveSystem ( )

Definition at line 43 of file CaveSystem.cpp.

Member Function Documentation

◆ canSwitchIndexToIndex()

Bool CaveSystem::canSwitchIndexToIndex ( Int oldIndex,
Int newIndex )

Definition at line 68 of file CaveSystem.cpp.

◆ crc()

virtual void CaveSystem::crc ( Xfer * xfer)
inlineprotectedvirtual

run the "light" crc check on this data structure

Implements Snapshot.

Definition at line 64 of file CaveSystem.h.

◆ getTunnelTrackerForCaveIndex()

TunnelTracker * CaveSystem::getTunnelTrackerForCaveIndex ( Int theIndex)

Definition at line 121 of file CaveSystem.cpp.

◆ init()

void CaveSystem::init ( )
virtual
  • Assign any default values to data required for the class
    • Allocate any memory and resources needed throughout the lifetime of the class

Implements SubsystemInterface.

Definition at line 47 of file CaveSystem.cpp.

◆ loadPostProcess()

virtual void CaveSystem::loadPostProcess ( void )
inlineprotectedvirtual

post process phase for loading save games. All save systems have their xfer run using XferLoad mode, and then all systems each have their post process run

Implements Snapshot.

Definition at line 66 of file CaveSystem.h.

◆ registerNewCave()

void CaveSystem::registerNewCave ( Int theIndex)

Definition at line 92 of file CaveSystem.cpp.

◆ reset()

void CaveSystem::reset ( )
virtual
  • Any system should be able to reset all data and go back to an empty state that is ready to accept a completely new set of data. Reset() can expect to be used in the context of resetting the engine in order to start or load a new game.
    • Do NOT free and re-allocate resources needed, where possible reorganize and re-initialize the resources already allocated.
    • After a reset, the system does not need to be in EXACTLY the same state as a fresh instantiation. If there are persistent state information for the system make sure you maintain it while restoring or re-initializing other transient parts.

Implements SubsystemInterface.

Definition at line 51 of file CaveSystem.cpp.

◆ unregisterCave()

void CaveSystem::unregisterCave ( Int theIndex)

Definition at line 114 of file CaveSystem.cpp.

◆ update()

void CaveSystem::update ( )
virtual
  • Update methods are the place to do system per frame processing. You should call the system update once each time through the game loop to service the system.
    • Note that currently the GameClient and GameLogic will be updating at different rates where the logic is running real time, and the client will adjust how many loops can be done during one server time slice in order to improve performance on low end machines.

Implements SubsystemInterface.

Definition at line 64 of file CaveSystem.cpp.

◆ xfer()

void CaveSystem::xfer ( Xfer * xfer)
protectedvirtual

Xfer Method Version Info 1: Initial version

Implements Snapshot.

Definition at line 139 of file CaveSystem.cpp.


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