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

#include <Locomotor.h>

Inherits SubsystemInterface.

Public Member Functions

 LocomotorStore ()
 
 ~LocomotorStore ()
 
void init ()
 
void reset ()
 
void update ()
 
const LocomotorTemplatefindLocomotorTemplate (NameKeyType namekey) const
 
LocomotorTemplatefindLocomotorTemplate (NameKeyType namekey)
 
LocomotornewLocomotor (const LocomotorTemplate *tmpl) const
 
LocomotorTemplatenewOverride (LocomotorTemplate *locoTemplate)
 
- 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)
 

Static Public Member Functions

static void parseLocomotorTemplateDefinition (INI *ini)
 

Additional Inherited Members

- Protected Attributes inherited from SubsystemInterface
AsciiString m_name
 

Detailed Description

The "store" used to hold all the LocomotorTemplates in existence. This is usually used when creating an Object, but can be used at any time after that. (It is explicitly OK to swap an Object's Locomotor out at any given time.)

Definition at line 468 of file Locomotor.h.

Constructor & Destructor Documentation

◆ LocomotorStore()

LocomotorStore::LocomotorStore ( )

Definition at line 517 of file Locomotor.cpp.

◆ ~LocomotorStore()

LocomotorStore::~LocomotorStore ( )

Definition at line 522 of file Locomotor.cpp.

Member Function Documentation

◆ findLocomotorTemplate() [1/2]

LocomotorTemplate * LocomotorStore::findLocomotorTemplate ( NameKeyType namekey)

Definition at line 534 of file Locomotor.cpp.

◆ findLocomotorTemplate() [2/2]

const LocomotorTemplate * LocomotorStore::findLocomotorTemplate ( NameKeyType namekey) const

Find the LocomotorTemplate with the given name. If no such LocomotorTemplate exists, return null.

Definition at line 547 of file Locomotor.cpp.

◆ init()

void LocomotorStore::init ( )
inlinevirtual
  • 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 475 of file Locomotor.h.

◆ newLocomotor()

Locomotor * LocomotorStore::newLocomotor ( const LocomotorTemplate * tmpl) const
inline

Definition at line 485 of file Locomotor.h.

◆ newOverride()

LocomotorTemplate * LocomotorStore::newOverride ( LocomotorTemplate * locoTemplate)

Definition at line 587 of file Locomotor.cpp.

◆ parseLocomotorTemplateDefinition()

void LocomotorStore::parseLocomotorTemplateDefinition ( INI * ini)
static

Definition at line 607 of file Locomotor.cpp.

◆ reset()

void LocomotorStore::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 569 of file Locomotor.cpp.

◆ update()

void LocomotorStore::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 564 of file Locomotor.cpp.


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