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 | Protected Attributes | List of all members
FlammableUpdate Class Reference

#include <FlammableUpdate.h>

Inherits UpdateModule, and DamageModuleInterface.

Public Member Functions

 FlammableUpdate (Thing *thing, const ModuleData *moduleData)
 
virtual DamageModuleInterface * getDamage ()
 
void tryToIgnite ()
 FlammabeDamage uses this. It is up to me to decide if I am burnable.
 
Bool wouldIgnite ()
 Since we need to cheat sometimes and light something directly, ask if this would light.
 
virtual UpdateSleepTime update ()
 
virtual void onDamage (DamageInfo *damageInfo)
 
virtual void onHealing (DamageInfo *damageInfo)
 healing callback
 
virtual void onBodyDamageStateChange (const DamageInfo *damageInfo, BodyDamageType oldState, BodyDamageType newState)
 state change callback
 
- 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 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 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

UpdateSleepTime calcSleepTime ()
 
void doAflameDamage ()
 
void startBurningSound ()
 
void stopBurningSound ()
 
- 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

FlammabilityStatusType m_status
 
UnsignedInt m_aflameEndFrame
 
UnsignedInt m_burnedEndFrame
 
UnsignedInt m_damageEndFrame
 
AudioHandle m_audioHandle
 
Real m_flameDamageLimit
 
UnsignedInt m_lastFlameDamageDealt
 

Detailed Description

Definition at line 76 of file FlammableUpdate.h.

Constructor & Destructor Documentation

◆ FlammableUpdate()

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

Definition at line 79 of file FlammableUpdate.cpp.

Member Function Documentation

◆ calcSleepTime()

UpdateSleepTime FlammableUpdate::calcSleepTime ( )
protected

Definition at line 174 of file FlammableUpdate.cpp.

◆ doAflameDamage()

void FlammableUpdate::doAflameDamage ( )
protected

Definition at line 226 of file FlammableUpdate.cpp.

◆ getDamage()

virtual DamageModuleInterface * FlammableUpdate::getDamage ( void )
inlinevirtual

Reimplemented from BehaviorModule.

Definition at line 88 of file FlammableUpdate.h.

◆ getInterfaceMask()

static Int FlammableUpdate::getInterfaceMask ( void )
inlinestatic

Definition at line 87 of file FlammableUpdate.h.

◆ onBodyDamageStateChange()

virtual void FlammableUpdate::onBodyDamageStateChange ( const DamageInfo * damageInfo,
BodyDamageType oldState,
BodyDamageType newState )
inlinevirtual

state change callback

Implements DamageModuleInterface.

Definition at line 99 of file FlammableUpdate.h.

◆ onDamage()

void FlammableUpdate::onDamage ( DamageInfo * damageInfo)
virtual

Damage has been dealt, this is an opportunity to reach to that damage

Implements DamageModuleInterface.

Definition at line 102 of file FlammableUpdate.cpp.

◆ onHealing()

virtual void FlammableUpdate::onHealing ( DamageInfo * damageInfo)
inlinevirtual

healing callback

Implements DamageModuleInterface.

Definition at line 98 of file FlammableUpdate.h.

◆ startBurningSound()

void FlammableUpdate::startBurningSound ( )
protected

Definition at line 241 of file FlammableUpdate.cpp.

◆ stopBurningSound()

void FlammableUpdate::stopBurningSound ( )
protected

Definition at line 251 of file FlammableUpdate.cpp.

◆ tryToIgnite()

void FlammableUpdate::tryToIgnite ( )

FlammabeDamage uses this. It is up to me to decide if I am burnable.

Definition at line 194 of file FlammableUpdate.cpp.

◆ update()

UpdateSleepTime FlammableUpdate::update ( void )
virtual

Implements UpdateModule.

Definition at line 129 of file FlammableUpdate.cpp.

◆ wouldIgnite()

Bool FlammableUpdate::wouldIgnite ( )

Since we need to cheat sometimes and light something directly, ask if this would light.

Definition at line 262 of file FlammableUpdate.cpp.

Member Data Documentation

◆ m_aflameEndFrame

UnsignedInt FlammableUpdate::m_aflameEndFrame
protected

Definition at line 111 of file FlammableUpdate.h.

◆ m_audioHandle

AudioHandle FlammableUpdate::m_audioHandle
protected

Definition at line 114 of file FlammableUpdate.h.

◆ m_burnedEndFrame

UnsignedInt FlammableUpdate::m_burnedEndFrame
protected

Definition at line 112 of file FlammableUpdate.h.

◆ m_damageEndFrame

UnsignedInt FlammableUpdate::m_damageEndFrame
protected

Definition at line 113 of file FlammableUpdate.h.

◆ m_flameDamageLimit

Real FlammableUpdate::m_flameDamageLimit
protected

Definition at line 115 of file FlammableUpdate.h.

◆ m_lastFlameDamageDealt

UnsignedInt FlammableUpdate::m_lastFlameDamageDealt
protected

Definition at line 116 of file FlammableUpdate.h.

◆ m_status

FlammabilityStatusType FlammableUpdate::m_status
protected

Definition at line 110 of file FlammableUpdate.h.

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