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

#include <DynamicShroudClearingRangeUpdate.h>

Inherits UpdateModule.

Public Member Functions

 DynamicShroudClearingRangeUpdate (Thing *thing, const ModuleData *moduleData)
 
virtual UpdateSleepTime update ()
 
void createGridDecals (const RadiusDecalTemplate &tmpl, Real radius, const Coord3D &pos)
 
void killGridDecals (void)
 
void animateGridDecals (void)
 
- Public Member Functions inherited from UpdateModule
 UpdateModule (Thing *thing, const ModuleData *moduleData)
 
virtual UpdateModuleInterfacegetUpdate ()
 
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 Objectfriend_getObject () const
 
- Public Member Functions inherited from BehaviorModule
 BehaviorModule (Thing *thing, const ModuleData *moduleData)
 
virtual BodyModuleInterfacegetBody ()
 
virtual CollideModuleInterfacegetCollide ()
 
virtual ContainModuleInterfacegetContain ()
 
virtual CreateModuleInterfacegetCreate ()
 
virtual DamageModuleInterfacegetDamage ()
 
virtual DestroyModuleInterfacegetDestroy ()
 
virtual DieModuleInterfacegetDie ()
 
virtual SpecialPowerModuleInterfacegetSpecialPower ()
 
virtual UpgradeModuleInterfacegetUpgrade ()
 
virtual StealthUpdategetStealth ()
 
virtual SpyVisionUpdategetSpyVisionUpdate ()
 
virtual ParkingPlaceBehaviorInterfacegetParkingPlaceBehaviorInterface ()
 
virtual RebuildHoleBehaviorInterfacegetRebuildHoleBehaviorInterface ()
 
virtual BridgeBehaviorInterfacegetBridgeBehaviorInterface ()
 
virtual BridgeTowerBehaviorInterfacegetBridgeTowerBehaviorInterface ()
 
virtual BridgeScaffoldBehaviorInterfacegetBridgeScaffoldBehaviorInterface ()
 
virtual OverchargeBehaviorInterfacegetOverchargeBehaviorInterface ()
 
virtual TransportPassengerInterfacegetTransportPassengerInterface ()
 
virtual CaveInterfacegetCaveInterface ()
 
virtual LandMineInterfacegetLandMineInterface ()
 
virtual DieModuleInterfacegetEjectPilotDieInterface ()
 
virtual ProjectileUpdateInterfacegetProjectileUpdateInterface ()
 
virtual AIUpdateInterfacegetAIUpdateInterface ()
 
virtual ExitInterfacegetUpdateExitInterface ()
 
virtual DockUpdateInterfacegetDockUpdateInterface ()
 
virtual RailedTransportDockUpdateInterfacegetRailedTransportDockUpdateInterface (void)
 
virtual SlowDeathBehaviorInterfacegetSlowDeathBehaviorInterface ()
 
virtual SpecialPowerUpdateInterfacegetSpecialPowerUpdateInterface ()
 
virtual SlavedUpdateInterfacegetSlavedUpdateInterface ()
 
virtual ProductionUpdateInterfacegetProductionUpdateInterface ()
 
virtual HordeUpdateInterfacegetHordeUpdateInterface ()
 
virtual PowerPlantUpdateInterfacegetPowerPlantUpdateInterface ()
 
virtual SpawnBehaviorInterfacegetSpawnBehaviorInterface ()
 
virtual CountermeasuresBehaviorInterfacegetCountermeasuresBehaviorInterface ()
 
virtual const CountermeasuresBehaviorInterfacegetCountermeasuresBehaviorInterface () 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)
 

Protected Types

enum  DSCRU_STATE {
  DSCRU_NOT_STARTED_YET , DSCRU_GROWING , DSCRU_SUSTAINING , DSCRU_SHRINKING ,
  DSCRU_DONE_FOREVER , DSCRU_SLEEPING
}
 

Protected Attributes

DSCRU_STATE m_state
 
Int m_stateCountDown
 
Int m_totalFrames
 
UnsignedInt m_growStartDeadline
 
UnsignedInt m_sustainDeadline
 
UnsignedInt m_shrinkStartDeadline
 
UnsignedInt m_doneForeverFrame
 This supercedes and makes us quit.
 
UnsignedInt m_changeIntervalCountdown
 How long till I change my vision range again.
 
Bool m_decalsCreated
 Have I created the fx decals yet?
 
Real m_visionChangePerInterval
 How much I change each time.
 
Real m_nativeClearingRange
 What is my objects native vision range?
 
Real m_currentClearingRange
 ToKeepTrackOfWhere We are at.
 
RadiusDecal m_gridDecal [GRID_FX_DECAL_COUNT]
 For the pseudo-wireframe decal effect.
 

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 ModuleDatafriend_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
ObjectgetObject ()
 
const ObjectgetObject () const
 
- Protected Member Functions inherited from Module
const ModuleDatagetModuleData () const
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPoolgetObjectMemoryPool ()=0
 

Detailed Description

Definition at line 68 of file DynamicShroudClearingRangeUpdate.h.

Member Enumeration Documentation

◆ DSCRU_STATE

Enumerator
DSCRU_NOT_STARTED_YET 
DSCRU_GROWING 
DSCRU_SUSTAINING 
DSCRU_SHRINKING 
DSCRU_DONE_FOREVER 
DSCRU_SLEEPING 

Definition at line 90 of file DynamicShroudClearingRangeUpdate.h.

Constructor & Destructor Documentation

◆ DynamicShroudClearingRangeUpdate()

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

Definition at line 89 of file DynamicShroudClearingRangeUpdate.cpp.

Member Function Documentation

◆ animateGridDecals()

void DynamicShroudClearingRangeUpdate::animateGridDecals ( void )

Definition at line 160 of file DynamicShroudClearingRangeUpdate.cpp.

◆ createGridDecals()

void DynamicShroudClearingRangeUpdate::createGridDecals ( const RadiusDecalTemplate & tmpl,
Real radius,
const Coord3D & pos )

Definition at line 146 of file DynamicShroudClearingRangeUpdate.cpp.

◆ killGridDecals()

void DynamicShroudClearingRangeUpdate::killGridDecals ( void )

Definition at line 192 of file DynamicShroudClearingRangeUpdate.cpp.

◆ update()

UpdateSleepTime DynamicShroudClearingRangeUpdate::update ( void )
virtual

Implements UpdateModule.

Definition at line 205 of file DynamicShroudClearingRangeUpdate.cpp.

Member Data Documentation

◆ m_changeIntervalCountdown

UnsignedInt DynamicShroudClearingRangeUpdate::m_changeIntervalCountdown
protected

How long till I change my vision range again.

Definition at line 120 of file DynamicShroudClearingRangeUpdate.h.

◆ m_currentClearingRange

Real DynamicShroudClearingRangeUpdate::m_currentClearingRange
protected

ToKeepTrackOfWhere We are at.

Definition at line 127 of file DynamicShroudClearingRangeUpdate.h.

◆ m_decalsCreated

Bool DynamicShroudClearingRangeUpdate::m_decalsCreated
protected

Have I created the fx decals yet?

Definition at line 124 of file DynamicShroudClearingRangeUpdate.h.

◆ m_doneForeverFrame

UnsignedInt DynamicShroudClearingRangeUpdate::m_doneForeverFrame
protected

This supercedes and makes us quit.

Just in case interval and state timing goes awry

Definition at line 116 of file DynamicShroudClearingRangeUpdate.h.

◆ m_gridDecal

RadiusDecal DynamicShroudClearingRangeUpdate::m_gridDecal[GRID_FX_DECAL_COUNT]
protected

For the pseudo-wireframe decal effect.

Definition at line 129 of file DynamicShroudClearingRangeUpdate.h.

◆ m_growStartDeadline

UnsignedInt DynamicShroudClearingRangeUpdate::m_growStartDeadline
protected

Definition at line 113 of file DynamicShroudClearingRangeUpdate.h.

◆ m_nativeClearingRange

Real DynamicShroudClearingRangeUpdate::m_nativeClearingRange
protected

What is my objects native vision range?

Definition at line 126 of file DynamicShroudClearingRangeUpdate.h.

◆ m_shrinkStartDeadline

UnsignedInt DynamicShroudClearingRangeUpdate::m_shrinkStartDeadline
protected

Definition at line 115 of file DynamicShroudClearingRangeUpdate.h.

◆ m_state

DSCRU_STATE DynamicShroudClearingRangeUpdate::m_state
protected

Definition at line 100 of file DynamicShroudClearingRangeUpdate.h.

◆ m_stateCountDown

Int DynamicShroudClearingRangeUpdate::m_stateCountDown
protected

Definition at line 111 of file DynamicShroudClearingRangeUpdate.h.

◆ m_sustainDeadline

UnsignedInt DynamicShroudClearingRangeUpdate::m_sustainDeadline
protected

Definition at line 114 of file DynamicShroudClearingRangeUpdate.h.

◆ m_totalFrames

Int DynamicShroudClearingRangeUpdate::m_totalFrames
protected

Definition at line 112 of file DynamicShroudClearingRangeUpdate.h.

◆ m_visionChangePerInterval

Real DynamicShroudClearingRangeUpdate::m_visionChangePerInterval
protected

How much I change each time.

Definition at line 125 of file DynamicShroudClearingRangeUpdate.h.


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