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

#include <Module.h>

Inherits Snapshot.

Inherited by AutoFindHealingUpdateModuleData, BattlePlanUpdateModuleData, BeaconClientUpdateModuleData, BehaviorModuleData, CleanupHazardUpdateModuleData, CommandButtonHuntUpdateModuleData, DemoTrapUpdateModuleData, DynamicGeometryInfoUpdateModuleData, FiringTrackerModuleData, HordeUpdateModuleData, LaserUpdateModuleData, ObjectDefectionHelperModuleData, ObjectRepulsorHelperModuleData, ObjectSMCHelperModuleData, ObjectWeaponStatusHelperModuleData, ParticleUplinkCannonUpdateModuleData, PilotFindVehicleUpdateModuleData, PointDefenseLaserUpdateModuleData, ProneUpdateModuleData, SpectreGunshipDeploymentUpdateModuleData, SpectreGunshipUpdateModuleData, StatusDamageHelperModuleData, SubdualDamageHelperModuleData, TempWeaponBonusHelperModuleData, W3DLaserDrawModuleData, W3DModelDrawModuleData, W3DProjectileStreamDrawModuleData, W3DPropDrawModuleData, and W3DTreeDrawModuleData.

Public Member Functions

 ModuleData ()
 
virtual ~ModuleData ()
 
void setModuleTagNameKey (NameKeyType key)
 
NameKeyType getModuleTagNameKey () const
 
virtual Bool isAiModuleData () const
 
virtual const W3DModelDrawModuleDatagetAsW3DModelDrawModuleData () const
 
virtual const W3DTreeDrawModuleDatagetAsW3DTreeDrawModuleData () const
 
virtual StaticGameLODLevel getMinimumRequiredGameLOD () const
 
virtual void crc (Xfer *xfer)
 run the "light" crc check on this data structure
 
virtual void xfer (Xfer *xfer)
 
virtual void loadPostProcess (void)
 
- Public Member Functions inherited from Snapshot
 Snapshot (void)
 
 ~Snapshot (void)
 

Static Public Member Functions

static void buildFieldParse (MultiIniFieldParse &p)
 

Detailed Description

Base class for data-read-from-INI for modules.

Todo
srj – make ModuleData be MemoryPool based

Definition at line 103 of file Module.h.

Constructor & Destructor Documentation

◆ ModuleData()

ModuleData::ModuleData ( )
inline

Definition at line 106 of file Module.h.

◆ ~ModuleData()

virtual ModuleData::~ModuleData ( )
inlinevirtual

Definition at line 107 of file Module.h.

Member Function Documentation

◆ buildFieldParse()

static void ModuleData::buildFieldParse ( MultiIniFieldParse & p)
inlinestatic

Definition at line 120 of file Module.h.

◆ crc()

virtual void ModuleData::crc ( Xfer * xfer)
inlinevirtual

run the "light" crc check on this data structure

Implements Snapshot.

Reimplemented in W3DModelDrawModuleData.

Definition at line 126 of file Module.h.

◆ getAsW3DModelDrawModuleData()

virtual const W3DModelDrawModuleData * ModuleData::getAsW3DModelDrawModuleData ( ) const
inlinevirtual

Reimplemented in W3DModelDrawModuleData.

Definition at line 115 of file Module.h.

◆ getAsW3DTreeDrawModuleData()

virtual const W3DTreeDrawModuleData * ModuleData::getAsW3DTreeDrawModuleData ( ) const
inlinevirtual

Reimplemented in W3DTreeDrawModuleData.

Definition at line 117 of file Module.h.

◆ getMinimumRequiredGameLOD()

virtual StaticGameLODLevel ModuleData::getMinimumRequiredGameLOD ( ) const
inlinevirtual

Reimplemented in W3DModelDrawModuleData.

Definition at line 118 of file Module.h.

◆ getModuleTagNameKey()

NameKeyType ModuleData::getModuleTagNameKey ( ) const
inline

Definition at line 110 of file Module.h.

◆ isAiModuleData()

virtual Bool ModuleData::isAiModuleData ( ) const
inlinevirtual

Reimplemented in AIUpdateModuleData.

Definition at line 112 of file Module.h.

◆ loadPostProcess()

virtual void ModuleData::loadPostProcess ( void )
inlinevirtual

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.

Reimplemented in W3DModelDrawModuleData.

Definition at line 128 of file Module.h.

◆ setModuleTagNameKey()

void ModuleData::setModuleTagNameKey ( NameKeyType key)
inline

Definition at line 109 of file Module.h.

◆ xfer()

virtual void ModuleData::xfer ( Xfer * xfer)
inlinevirtual

run save, load, or deep CRC check on this data structure, the type depends on the setup of the Xfer pointer

Implements Snapshot.

Reimplemented in W3DModelDrawModuleData.

Definition at line 127 of file Module.h.


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