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

#include <CleanupHazardUpdate.h>

Inherits UpdateModule.

Public Member Functions

 CleanupHazardUpdate (Thing *thing, const ModuleData *moduleData)
 
virtual void onObjectCreated ()
 
virtual UpdateSleepTime update ()
 
Object * scanClosestTarget ()
 
void fireWhenReady ()
 
void setCleanupAreaParameters (const Coord3D *pos, Real range)
 
- Public Member Functions inherited from UpdateModule
 UpdateModule (Thing *thing, const ModuleData *moduleData)
 
virtual UpdateModuleInterface * getUpdate ()
 
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 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)
 

Protected Attributes

ObjectID m_bestTargetID
 
Bool m_inRange
 
Int m_nextScanFrames
 
Int m_nextShotAvailableInFrames
 
const WeaponTemplate * m_weaponTemplate
 
Coord3D m_pos
 
Real m_moveRange
 

Additional Inherited Members

- Static Public Member Functions inherited from UpdateModule
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 inherited from UpdateModule
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

The default update module

Definition at line 63 of file CleanupHazardUpdate.h.

Constructor & Destructor Documentation

◆ CleanupHazardUpdate()

CleanupHazardUpdate::CleanupHazardUpdate ( Thing * thing,
const ModuleData * moduleData )

Definition at line 80 of file CleanupHazardUpdate.cpp.

Member Function Documentation

◆ fireWhenReady()

void CleanupHazardUpdate::fireWhenReady ( )

Definition at line 197 of file CleanupHazardUpdate.cpp.

◆ onObjectCreated()

void CleanupHazardUpdate::onObjectCreated ( void )
virtual

this is called after all the Modules for a given Thing are created; it allows Modules to resolve any inter-Module dependencies.

Reimplemented from Module.

Definition at line 101 of file CleanupHazardUpdate.cpp.

◆ scanClosestTarget()

Object * CleanupHazardUpdate::scanClosestTarget ( )

Definition at line 265 of file CleanupHazardUpdate.cpp.

◆ setCleanupAreaParameters()

void CleanupHazardUpdate::setCleanupAreaParameters ( const Coord3D * pos,
Real range )

Definition at line 298 of file CleanupHazardUpdate.cpp.

◆ update()

UpdateSleepTime CleanupHazardUpdate::update ( void )
virtual

The update callback.

Todo
srj use SLEEPY_UPDATE here

Implements UpdateModule.

Definition at line 131 of file CleanupHazardUpdate.cpp.

Member Data Documentation

◆ m_bestTargetID

ObjectID CleanupHazardUpdate::m_bestTargetID
protected

Definition at line 84 of file CleanupHazardUpdate.h.

◆ m_inRange

Bool CleanupHazardUpdate::m_inRange
protected

Definition at line 85 of file CleanupHazardUpdate.h.

◆ m_moveRange

Real CleanupHazardUpdate::m_moveRange
protected

Definition at line 92 of file CleanupHazardUpdate.h.

◆ m_nextScanFrames

Int CleanupHazardUpdate::m_nextScanFrames
protected

Definition at line 86 of file CleanupHazardUpdate.h.

◆ m_nextShotAvailableInFrames

Int CleanupHazardUpdate::m_nextShotAvailableInFrames
protected

Definition at line 87 of file CleanupHazardUpdate.h.

◆ m_pos

Coord3D CleanupHazardUpdate::m_pos
protected

Definition at line 91 of file CleanupHazardUpdate.h.

◆ m_weaponTemplate

const WeaponTemplate* CleanupHazardUpdate::m_weaponTemplate
protected

Definition at line 88 of file CleanupHazardUpdate.h.

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