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

#include <SpectreGunshipDeploymentUpdate.h>

Inherits SpecialPowerUpdateModule.

Public Member Functions

 SpectreGunshipDeploymentUpdate (Thing *thing, const ModuleData *moduleData)
 
virtual Bool initiateIntentToDoSpecialPower (const SpecialPowerTemplate *specialPowerTemplate, const Object *targetObj, const Coord3D *targetPos, const Waypoint *way, UnsignedInt commandOptions)
 
virtual Bool isSpecialAbility () const
 
virtual Bool isSpecialPower () const
 
virtual Bool isActive () const
 
virtual SpecialPowerUpdateInterfacegetSpecialPowerUpdateInterface ()
 
virtual CommandOption getCommandOption () const
 
virtual Bool isPowerCurrentlyInUse (const CommandButton *command=NULL) const
 
virtual ScienceType getExtraRequiredScience () const
 
virtual void onObjectCreated ()
 
virtual UpdateSleepTime update ()
 
void cleanUp ()
 
virtual Bool doesSpecialPowerHaveOverridableDestinationActive () const
 
virtual Bool doesSpecialPowerHaveOverridableDestination () const
 
virtual void setSpecialPowerOverridableDestination (const Coord3D *loc)
 
virtual DisabledMaskType getDisabledTypesToProcess () const
 
- Public Member Functions inherited from SpecialPowerUpdateModule
 SpecialPowerUpdateModule (Thing *thing, const ModuleData *moduleData)
 
virtual Bool doesSpecialPowerUpdatePassScienceTest () const
 
- 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 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 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

SpecialPowerModuleInterfacem_specialPowerModule
 
Coord3D m_initialTargetPosition
 
ObjectID m_gunshipID
 

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

The default update module

Definition at line 103 of file SpectreGunshipDeploymentUpdate.h.

Constructor & Destructor Documentation

◆ SpectreGunshipDeploymentUpdate()

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

Definition at line 116 of file SpectreGunshipDeploymentUpdate.cpp.

Member Function Documentation

◆ cleanUp()

void SpectreGunshipDeploymentUpdate::cleanUp ( )

◆ doesSpecialPowerHaveOverridableDestination()

virtual Bool SpectreGunshipDeploymentUpdate::doesSpecialPowerHaveOverridableDestination ( ) const
inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 132 of file SpectreGunshipDeploymentUpdate.h.

◆ doesSpecialPowerHaveOverridableDestinationActive()

virtual Bool SpectreGunshipDeploymentUpdate::doesSpecialPowerHaveOverridableDestinationActive ( ) const
inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 131 of file SpectreGunshipDeploymentUpdate.h.

◆ getCommandOption()

virtual CommandOption SpectreGunshipDeploymentUpdate::getCommandOption ( ) const
inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 120 of file SpectreGunshipDeploymentUpdate.h.

◆ getDisabledTypesToProcess()

virtual DisabledMaskType SpectreGunshipDeploymentUpdate::getDisabledTypesToProcess ( ) const
inlinevirtual

Implements UpdateModuleInterface.

Definition at line 136 of file SpectreGunshipDeploymentUpdate.h.

◆ getExtraRequiredScience()

virtual ScienceType SpectreGunshipDeploymentUpdate::getExtraRequiredScience ( ) const
inlinevirtual

Reimplemented from SpecialPowerUpdateModule.

Definition at line 122 of file SpectreGunshipDeploymentUpdate.h.

◆ getSpecialPowerUpdateInterface()

virtual SpecialPowerUpdateInterface * SpectreGunshipDeploymentUpdate::getSpecialPowerUpdateInterface ( )
inlinevirtual

Reimplemented from BehaviorModule.

Definition at line 119 of file SpectreGunshipDeploymentUpdate.h.

◆ initiateIntentToDoSpecialPower()

Bool SpectreGunshipDeploymentUpdate::initiateIntentToDoSpecialPower ( const SpecialPowerTemplate * specialPowerTemplate,
const Object * targetObj,
const Coord3D * targetPos,
const Waypoint * way,
UnsignedInt commandOptions )
virtual

Implements SpecialPowerUpdateModule.

Definition at line 145 of file SpectreGunshipDeploymentUpdate.cpp.

◆ isActive()

virtual Bool SpectreGunshipDeploymentUpdate::isActive ( ) const
inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 118 of file SpectreGunshipDeploymentUpdate.h.

◆ isPowerCurrentlyInUse()

virtual Bool SpectreGunshipDeploymentUpdate::isPowerCurrentlyInUse ( const CommandButton * command = NULL) const
inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 121 of file SpectreGunshipDeploymentUpdate.h.

◆ isSpecialAbility()

virtual Bool SpectreGunshipDeploymentUpdate::isSpecialAbility ( ) const
inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 116 of file SpectreGunshipDeploymentUpdate.h.

◆ isSpecialPower()

virtual Bool SpectreGunshipDeploymentUpdate::isSpecialPower ( ) const
inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 117 of file SpectreGunshipDeploymentUpdate.h.

◆ onObjectCreated()

void SpectreGunshipDeploymentUpdate::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 130 of file SpectreGunshipDeploymentUpdate.cpp.

◆ setSpecialPowerOverridableDestination()

virtual void SpectreGunshipDeploymentUpdate::setSpecialPowerOverridableDestination ( const Coord3D * loc)
inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 133 of file SpectreGunshipDeploymentUpdate.h.

◆ update()

UpdateSleepTime SpectreGunshipDeploymentUpdate::update ( void )
virtual

The update callback.

Implements UpdateModule.

Definition at line 267 of file SpectreGunshipDeploymentUpdate.cpp.

Member Data Documentation

◆ m_gunshipID

ObjectID SpectreGunshipDeploymentUpdate::m_gunshipID
protected

Definition at line 144 of file SpectreGunshipDeploymentUpdate.h.

◆ m_initialTargetPosition

Coord3D SpectreGunshipDeploymentUpdate::m_initialTargetPosition
protected

Definition at line 143 of file SpectreGunshipDeploymentUpdate.h.

◆ m_specialPowerModule

SpecialPowerModuleInterface* SpectreGunshipDeploymentUpdate::m_specialPowerModule
protected

Definition at line 142 of file SpectreGunshipDeploymentUpdate.h.


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