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

#include <SpecialPowerUpdateModule.h>

Inherits UpdateModule, and SpecialPowerUpdateInterface.

Inherited by BattlePlanUpdate, MissileLauncherBuildingUpdate, ParticleUplinkCannonUpdate, SpecialAbilityUpdate, SpectreGunshipDeploymentUpdate, and SpectreGunshipUpdate.

Public Member Functions

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

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

Definition at line 57 of file SpecialPowerUpdateModule.h.

Constructor & Destructor Documentation

◆ SpecialPowerUpdateModule()

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

Definition at line 51 of file SpecialPowerUpdateModule.cpp.

Member Function Documentation

◆ doesSpecialPowerHaveOverridableDestination()

virtual Bool SpecialPowerUpdateModule::doesSpecialPowerHaveOverridableDestination ( ) const
pure virtual

◆ doesSpecialPowerHaveOverridableDestinationActive()

virtual Bool SpecialPowerUpdateModule::doesSpecialPowerHaveOverridableDestinationActive ( ) const
pure virtual

◆ doesSpecialPowerUpdatePassScienceTest()

Bool SpecialPowerUpdateModule::doesSpecialPowerUpdatePassScienceTest ( ) const
virtual

Implements SpecialPowerUpdateInterface.

Definition at line 61 of file SpecialPowerUpdateModule.cpp.

◆ getCommandOption()

◆ getExtraRequiredScience()

virtual ScienceType SpecialPowerUpdateModule::getExtraRequiredScience ( ) const
inlinevirtual

◆ initiateIntentToDoSpecialPower()

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

◆ isActive()

◆ isPowerCurrentlyInUse()

virtual Bool SpecialPowerUpdateModule::isPowerCurrentlyInUse ( const CommandButton * command = NULL) const
pure virtual

◆ isSpecialAbility()

virtual Bool SpecialPowerUpdateModule::isSpecialAbility ( ) const
pure virtual

◆ isSpecialPower()

virtual Bool SpecialPowerUpdateModule::isSpecialPower ( ) const
pure virtual

◆ setSpecialPowerOverridableDestination()

virtual void SpecialPowerUpdateModule::setSpecialPowerOverridableDestination ( const Coord3D * loc)
pure virtual

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