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 | Static Public Member Functions | Protected Member Functions | List of all members
UpdateModule Class Referenceabstract

#include <UpdateModule.h>

Inherits BehaviorModule, and UpdateModuleInterface.

Inherited by AIUpdateInterface, AnimationSteeringUpdate, AssistedTargetingUpdate, AutoDepositUpdate, AutoFindHealingUpdate, AutoHealBehavior, BaseRegenerateUpdate, BoneFXUpdate, BridgeBehavior, BridgeScaffoldBehavior, BunkerBusterBehavior, CheckpointUpdate, CleanupHazardUpdate, CommandButtonHuntUpdate, CountermeasuresBehavior, DefaultProductionExitUpdate, DeletionUpdate, DemoTrapUpdate, DockUpdate, DumbProjectileBehavior, DynamicGeometryInfoUpdate, DynamicShroudClearingRangeUpdate, EMPUpdate, EnemyNearUpdate, FireOCLAfterWeaponCooldownUpdate, FireSpreadUpdate, FireWeaponUpdate, FireWeaponWhenDamagedBehavior, FiringTracker, FlammableUpdate, FloatUpdate, GenerateMinefieldBehavior, GrantStealthBehavior, HeightDieUpdate, HijackerUpdate, HordeUpdate, LeafletDropBehavior, LifetimeUpdate, MinefieldBehavior, MobMemberSlavedUpdate, NeutronBlastBehavior, NeutronMissileUpdate, OCLUpdate, ObjectHelper, OpenContain, OverchargeBehavior, ParkingPlaceBehavior, PhysicsBehavior, PilotFindVehicleUpdate, PointDefenseLaserUpdate, PoisonedBehavior, PowerPlantUpdate, ProductionUpdate, ProjectileStreamUpdate, ProneUpdate, PropagandaTowerBehavior, QueueProductionExitUpdate, RadarUpdate, RadiusDecalUpdate, RebuildHoleBehavior, SlavedUpdate, SlowDeathBehavior, SmartBombTargetHomingUpdate, SpawnBehavior, SpawnPointProductionExitUpdate, SpecialPowerUpdateModule, SpyVisionUpdate, StealthDetectorUpdate, StealthUpdate, StickyBombUpdate, StructureCollapseUpdate, StructureToppleUpdate, SupplyCenterProductionExitUpdate, SupplyWarehouseCripplingBehavior, TechBuildingBehavior, TensileFormationUpdate, ToppleUpdate, WaveGuideUpdate, and WeaponBonusUpdate.

Public Member Functions

 UpdateModule (Thing *thing, const ModuleData *moduleData)
 
virtual UpdateModuleInterface * getUpdate ()
 
virtual UpdateSleepTime update ()=0
 
DisabledMaskType getDisabledTypesToProcess () const
 
UPDATEMODULE_FRIEND_DECLARATOR UnsignedInt friend_getPriority () const
 
UPDATEMODULE_FRIEND_DECLARATOR UnsignedInt friend_getNextCallFrame () const
 
UPDATEMODULE_FRIEND_DECLARATOR SleepyUpdatePhase friend_getNextCallPhase () const
 
UPDATEMODULE_FRIEND_DECLARATOR void friend_setNextCallFrame (UnsignedInt frame)
 
UPDATEMODULE_FRIEND_DECLARATOR Int friend_getIndexInLogic () const
 
UPDATEMODULE_FRIEND_DECLARATOR void friend_setIndexInLogic (Int i)
 
UPDATEMODULE_FRIEND_DECLARATOR const Object * friend_getObject () const
 
- Public Member Functions inherited from BehaviorModule
 BehaviorModule (Thing *thing, const ModuleData *moduleData)
 
virtual BodyModuleInterface * getBody ()
 
virtual CollideModuleInterface * getCollide ()
 
virtual ContainModuleInterface * getContain ()
 
virtual CreateModuleInterface * getCreate ()
 
virtual DamageModuleInterface * getDamage ()
 
virtual DestroyModuleInterface * getDestroy ()
 
virtual DieModuleInterface * getDie ()
 
virtual SpecialPowerModuleInterface * getSpecialPower ()
 
virtual UpgradeModuleInterface * getUpgrade ()
 
virtual StealthUpdate * getStealth ()
 
virtual SpyVisionUpdate * getSpyVisionUpdate ()
 
virtual ParkingPlaceBehaviorInterface * getParkingPlaceBehaviorInterface ()
 
virtual RebuildHoleBehaviorInterface * getRebuildHoleBehaviorInterface ()
 
virtual BridgeBehaviorInterface * getBridgeBehaviorInterface ()
 
virtual BridgeTowerBehaviorInterface * getBridgeTowerBehaviorInterface ()
 
virtual BridgeScaffoldBehaviorInterface * getBridgeScaffoldBehaviorInterface ()
 
virtual OverchargeBehaviorInterface * getOverchargeBehaviorInterface ()
 
virtual TransportPassengerInterface * getTransportPassengerInterface ()
 
virtual CaveInterface * getCaveInterface ()
 
virtual LandMineInterface * getLandMineInterface ()
 
virtual DieModuleInterface * getEjectPilotDieInterface ()
 
virtual ProjectileUpdateInterface * getProjectileUpdateInterface ()
 
virtual AIUpdateInterface * getAIUpdateInterface ()
 
virtual ExitInterface * getUpdateExitInterface ()
 
virtual DockUpdateInterface * getDockUpdateInterface ()
 
virtual RailedTransportDockUpdateInterface * getRailedTransportDockUpdateInterface (void)
 
virtual SlowDeathBehaviorInterface * getSlowDeathBehaviorInterface ()
 
virtual SpecialPowerUpdateInterface * getSpecialPowerUpdateInterface ()
 
virtual SlavedUpdateInterface * getSlavedUpdateInterface ()
 
virtual ProductionUpdateInterface * getProductionUpdateInterface ()
 
virtual HordeUpdateInterface * getHordeUpdateInterface ()
 
virtual PowerPlantUpdateInterface * getPowerPlantUpdateInterface ()
 
virtual SpawnBehaviorInterface * getSpawnBehaviorInterface ()
 
virtual CountermeasuresBehaviorInterface * getCountermeasuresBehaviorInterface ()
 
virtual const CountermeasuresBehaviorInterface * getCountermeasuresBehaviorInterface () const
 
- Public Member Functions inherited from ObjectModule
 ObjectModule (Thing *thing, const ModuleData *moduleData)
 < this abstract class needs memory pool hooks
 
virtual void onCapture (Player *oldOwner, Player *newOwner)
 
virtual void onDisabledEdge (Bool nowDisabled)
 
- Public Member Functions inherited from Module
 Module (const ModuleData *moduleData)
 < this abstract class needs memory pool hooks
 
virtual NameKeyType getModuleNameKey () const =0
 
NameKeyType getModuleTagNameKey () const
 
virtual void onObjectCreated ()
 
virtual void onDrawableBoundToObject ()
 
virtual void preloadAssets (TimeOfDay timeOfDay)
 preload any assets we might have for this time of day
 
virtual void onDelete (void)
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 
- Public Member Functions inherited from Snapshot
 Snapshot (void)
 
 ~Snapshot (void)
 

Static Public Member Functions

static Int getInterfaceMask ()
 
- Static Public Member Functions inherited from BehaviorModule
static Int getInterfaceMask ()
 
static ModuleType getModuleType ()
 
- Static Public Member Functions inherited from Module
static ModuleData * friend_newModuleData (INI *ini)
 

Protected Member Functions

void setWakeFrame (Object *obj, UpdateSleepTime wakeDelay)
 
UpdateSleepTime getWakeFrame () const
 
virtual SleepyUpdatePhase getUpdatePhase () const
 
UpdateSleepTime frameToSleepTime (UnsignedInt frame1, UnsignedInt frame2=FOREVER, UnsignedInt frame3=FOREVER, UnsignedInt frame4=FOREVER)
 
- Protected Member Functions inherited from BehaviorModule
virtual void crc (Xfer *xfer)
 
virtual void xfer (Xfer *xfer)
 
virtual void loadPostProcess (void)
 
- Protected Member Functions inherited from ObjectModule
Object * getObject ()
 
const Object * getObject () const
 
- Protected Member Functions inherited from Module
const ModuleData * getModuleData () const
 
- 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 133 of file UpdateModule.h.

Constructor & Destructor Documentation

◆ UpdateModule()

UpdateModule::UpdateModule ( Thing * thing,
const ModuleData * moduleData )
inline

Definition at line 230 of file UpdateModule.h.

Member Function Documentation

◆ frameToSleepTime()

UpdateSleepTime UpdateModule::frameToSleepTime ( UnsignedInt frame1,
UnsignedInt frame2 = FOREVER,
UnsignedInt frame3 = FOREVER,
UnsignedInt frame4 = FOREVER )
protected

Definition at line 44 of file UpdateModule.cpp.

◆ friend_getIndexInLogic()

UPDATEMODULE_FRIEND_DECLARATOR Int UpdateModule::friend_getIndexInLogic ( ) const
inline

Definition at line 214 of file UpdateModule.h.

◆ friend_getNextCallFrame()

UPDATEMODULE_FRIEND_DECLARATOR UnsignedInt UpdateModule::friend_getNextCallFrame ( ) const
inline

Definition at line 195 of file UpdateModule.h.

◆ friend_getNextCallPhase()

UPDATEMODULE_FRIEND_DECLARATOR SleepyUpdatePhase UpdateModule::friend_getNextCallPhase ( ) const
inline

Definition at line 200 of file UpdateModule.h.

◆ friend_getObject()

UPDATEMODULE_FRIEND_DECLARATOR const Object * UpdateModule::friend_getObject ( ) const
inline

Definition at line 224 of file UpdateModule.h.

◆ friend_getPriority()

UPDATEMODULE_FRIEND_DECLARATOR UnsignedInt UpdateModule::friend_getPriority ( ) const
inline

Definition at line 190 of file UpdateModule.h.

◆ friend_setIndexInLogic()

UPDATEMODULE_FRIEND_DECLARATOR void UpdateModule::friend_setIndexInLogic ( Int i)
inline

Definition at line 219 of file UpdateModule.h.

◆ friend_setNextCallFrame()

UPDATEMODULE_FRIEND_DECLARATOR void UpdateModule::friend_setNextCallFrame ( UnsignedInt frame)
inline

Definition at line 205 of file UpdateModule.h.

◆ getDisabledTypesToProcess()

DisabledMaskType UpdateModule::getDisabledTypesToProcess ( ) const
inlinevirtual

Implements UpdateModuleInterface.

Definition at line 178 of file UpdateModule.h.

◆ getInterfaceMask()

static Int UpdateModule::getInterfaceMask ( void )
inlinestatic

Definition at line 170 of file UpdateModule.h.

◆ getUpdate()

virtual UpdateModuleInterface * UpdateModule::getUpdate ( void )
inlinevirtual

Reimplemented from BehaviorModule.

Reimplemented in BridgeBehavior, and SpawnBehavior.

Definition at line 173 of file UpdateModule.h.

◆ getUpdatePhase()

virtual SleepyUpdatePhase UpdateModule::getUpdatePhase ( ) const
inlineprotectedvirtual

Reimplemented in AIUpdateInterface, FiringTracker, ObjectWeaponStatusHelper, and PhysicsBehavior.

Definition at line 158 of file UpdateModule.h.

◆ getWakeFrame()

UpdateSleepTime UpdateModule::getWakeFrame ( ) const
protected

Definition at line 73 of file UpdateModule.cpp.

◆ setWakeFrame()

void UpdateModule::setWakeFrame ( Object * obj,
UpdateSleepTime wakeDelay )
protected

Definition at line 85 of file UpdateModule.cpp.

◆ update()

virtual UpdateSleepTime UpdateModule::update ( )
pure virtual

Implements UpdateModuleInterface.

Implemented in AIUpdateInterface, AnimationSteeringUpdate, AssaultTransportAIUpdate, AssistedTargetingUpdate, AutoDepositUpdate, AutoFindHealingUpdate, AutoHealBehavior, BaseRegenerateUpdate, BattleBusSlowDeathBehavior, BattlePlanUpdate, BoneFXUpdate, BridgeBehavior, BridgeScaffoldBehavior, BunkerBusterBehavior, CheckpointUpdate, ChinookAIUpdate, CleanupHazardUpdate, CommandButtonHuntUpdate, CountermeasuresBehavior, DefaultProductionExitUpdate, DeletionUpdate, DeliverPayloadAIUpdate, DemoTrapUpdate, DeployStyleAIUpdate, DockUpdate, DozerAIUpdate, DumbProjectileBehavior, DynamicGeometryInfoUpdate, DynamicShroudClearingRangeUpdate, EMPUpdate, EnemyNearUpdate, FireOCLAfterWeaponCooldownUpdate, FireSpreadUpdate, FirestormDynamicGeometryInfoUpdate, FireWeaponUpdate, FireWeaponWhenDamagedBehavior, FiringTracker, FlammableUpdate, FlightDeckBehavior, FloatUpdate, GarrisonContain, GenerateMinefieldBehavior, GrantStealthBehavior, HackInternetAIUpdate, HealContain, HeightDieUpdate, HelicopterSlowDeathBehavior, HelixContain, HijackerUpdate, HordeUpdate, JetSlowDeathBehavior, LeafletDropBehavior, LifetimeUpdate, MinefieldBehavior, MissileAIUpdate, MissileLauncherBuildingUpdate, MobMemberSlavedUpdate, MobNexusContain, NeutronBlastBehavior, NeutronMissileSlowDeathBehavior, NeutronMissileUpdate, ObjectDefectionHelper, ObjectHelper, ObjectRepulsorHelper, ObjectSMCHelper, ObjectWeaponStatusHelper, OCLUpdate, OpenContain, OverchargeBehavior, ParachuteContain, ParkingPlaceBehavior, ParticleUplinkCannonUpdate, PhysicsBehavior, PilotFindVehicleUpdate, PointDefenseLaserUpdate, PoisonedBehavior, PowerPlantUpdate, ProductionUpdate, ProjectileStreamUpdate, ProneUpdate, PropagandaTowerBehavior, QueueProductionExitUpdate, RadarUpdate, RadiusDecalUpdate, RailedTransportAIUpdate, RailedTransportDockUpdate, RailroadBehavior, RebuildHoleBehavior, RiderChangeContain, SlavedUpdate, SlowDeathBehavior, SmartBombTargetHomingUpdate, SpawnBehavior, SpawnPointProductionExitUpdate, SpecialAbilityUpdate, SpectreGunshipDeploymentUpdate, SpectreGunshipUpdate, SpyVisionUpdate, StatusDamageHelper, StealthDetectorUpdate, StealthUpdate, StickyBombUpdate, StructureCollapseUpdate, StructureToppleUpdate, SubdualDamageHelper, SupplyCenterDockUpdate, SupplyCenterProductionExitUpdate, SupplyTruckAIUpdate, SupplyWarehouseCripplingBehavior, TechBuildingBehavior, TempWeaponBonusHelper, TensileFormationUpdate, ToppleUpdate, TransportContain, TunnelContain, WaveGuideUpdate, WeaponBonusUpdate, and WorkerAIUpdate.

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