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 Types | Protected Member Functions | Protected Attributes | List of all members
StructureToppleUpdate Class Reference

#include <StructureToppleUpdate.h>

Inherits UpdateModule, and DieModuleInterface.

Public Member Functions

 StructureToppleUpdate (Thing *thing, const ModuleData *moduleData)
 
virtual DieModuleInterface * getDie ()
 
virtual UpdateSleepTime update ()
 
virtual void onDie (const DamageInfo *damageInfo)
 
- 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 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 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 Types

enum  StructureToppleStateType {
  TOPPLESTATE_STANDING , TOPPLESTATE_WAITINGFORTOPPLESTART , TOPPLESTATE_TOPPLING , TOPPLESTATE_WAITINGFORDONE ,
  TOPPLESTATE_DONE
}
 

Protected Member Functions

void beginStructureTopple (const DamageInfo *damageInfo)
 
void applyCrushingDamage (Real theta)
 
void doDamageLine (Object *building, const WeaponTemplate *wt, Real jcos, Real jsin, Real facingWidth, Real toppleAngle)
 
void doToppleStartFX (Object *building, const DamageInfo *damageInfo)
 
void doToppleDelayBurstFX ()
 
void doToppleDoneStuff ()
 
void doAngleFX (Real curAngle, Real newAngle)
 
void doPhaseStuff (StructureTopplePhaseType stphase, const Coord3D *target)
 
- 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
 

Protected Attributes

UnsignedInt m_toppleFrame
 
Coord2D m_toppleDirection
 
StructureToppleStateType m_toppleState
 
Real m_toppleVelocity
 
Real m_accumulatedAngle
 
Real m_structuralIntegrity
 
Real m_lastCrushedLocation
 
Int m_nextBurstFrame
 
Coord3D m_delayBurstLocation
 
Real m_buildingHeight
 

Detailed Description

Definition at line 142 of file StructureToppleUpdate.h.

Member Enumeration Documentation

◆ StructureToppleStateType

enum StructureToppleUpdate::StructureToppleStateType
protected
Enumerator
TOPPLESTATE_STANDING 
TOPPLESTATE_WAITINGFORTOPPLESTART 
TOPPLESTATE_TOPPLING 
TOPPLESTATE_WAITINGFORDONE 
TOPPLESTATE_DONE 

Definition at line 179 of file StructureToppleUpdate.h.

Constructor & Destructor Documentation

◆ StructureToppleUpdate()

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

Definition at line 61 of file StructureToppleUpdate.cpp.

Member Function Documentation

◆ applyCrushingDamage()

void StructureToppleUpdate::applyCrushingDamage ( Real theta)
protected

Definition at line 359 of file StructureToppleUpdate.cpp.

◆ beginStructureTopple()

void StructureToppleUpdate::beginStructureTopple ( const DamageInfo * damageInfo)
protected

Definition at line 143 of file StructureToppleUpdate.cpp.

◆ doAngleFX()

void StructureToppleUpdate::doAngleFX ( Real curAngle,
Real newAngle )
protected

Definition at line 340 of file StructureToppleUpdate.cpp.

◆ doDamageLine()

void StructureToppleUpdate::doDamageLine ( Object * building,
const WeaponTemplate * wt,
Real jcos,
Real jsin,
Real facingWidth,
Real toppleAngle )
protected

Definition at line 422 of file StructureToppleUpdate.cpp.

◆ doPhaseStuff()

void StructureToppleUpdate::doPhaseStuff ( StructureTopplePhaseType stphase,
const Coord3D * target )
protected

Definition at line 547 of file StructureToppleUpdate.cpp.

◆ doToppleDelayBurstFX()

void StructureToppleUpdate::doToppleDelayBurstFX ( )
protected

Definition at line 480 of file StructureToppleUpdate.cpp.

◆ doToppleDoneStuff()

void StructureToppleUpdate::doToppleDoneStuff ( )
protected

Definition at line 318 of file StructureToppleUpdate.cpp.

◆ doToppleStartFX()

void StructureToppleUpdate::doToppleStartFX ( Object * building,
const DamageInfo * damageInfo )
protected

Definition at line 467 of file StructureToppleUpdate.cpp.

◆ getDie()

virtual DieModuleInterface * StructureToppleUpdate::getDie ( void )
inlinevirtual

Reimplemented from BehaviorModule.

Definition at line 157 of file StructureToppleUpdate.h.

◆ getInterfaceMask()

static Int StructureToppleUpdate::getInterfaceMask ( void )
inlinestatic

Definition at line 154 of file StructureToppleUpdate.h.

◆ onDie()

void StructureToppleUpdate::onDie ( const DamageInfo * damageInfo)
virtual

Implements DieModuleInterface.

Definition at line 192 of file StructureToppleUpdate.cpp.

◆ update()

UpdateSleepTime StructureToppleUpdate::update ( void )
virtual

Implements UpdateModule.

Definition at line 210 of file StructureToppleUpdate.cpp.

Member Data Documentation

◆ m_accumulatedAngle

Real StructureToppleUpdate::m_accumulatedAngle
protected

Definition at line 191 of file StructureToppleUpdate.h.

◆ m_buildingHeight

Real StructureToppleUpdate::m_buildingHeight
protected

Definition at line 196 of file StructureToppleUpdate.h.

◆ m_delayBurstLocation

Coord3D StructureToppleUpdate::m_delayBurstLocation
protected

Definition at line 195 of file StructureToppleUpdate.h.

◆ m_lastCrushedLocation

Real StructureToppleUpdate::m_lastCrushedLocation
protected

Definition at line 193 of file StructureToppleUpdate.h.

◆ m_nextBurstFrame

Int StructureToppleUpdate::m_nextBurstFrame
protected

Definition at line 194 of file StructureToppleUpdate.h.

◆ m_structuralIntegrity

Real StructureToppleUpdate::m_structuralIntegrity
protected

Definition at line 192 of file StructureToppleUpdate.h.

◆ m_toppleDirection

Coord2D StructureToppleUpdate::m_toppleDirection
protected

Definition at line 188 of file StructureToppleUpdate.h.

◆ m_toppleFrame

UnsignedInt StructureToppleUpdate::m_toppleFrame
protected

Definition at line 187 of file StructureToppleUpdate.h.

◆ m_toppleState

StructureToppleStateType StructureToppleUpdate::m_toppleState
protected

Definition at line 189 of file StructureToppleUpdate.h.

◆ m_toppleVelocity

Real StructureToppleUpdate::m_toppleVelocity
protected

Definition at line 190 of file StructureToppleUpdate.h.

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