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

#include <SupplyCenterProductionExitUpdate.h>

Inherits UpdateModule, and ExitInterface.

Public Member Functions

virtual ExitInterface * getUpdateExitInterface ()
 
 SupplyCenterProductionExitUpdate (Thing *thing, const ModuleData *moduleData)
 
virtual Bool isExitBusy () const
 Contain style exiters are getting the ability to space out exits, so ask this before reserveDoor as a kind of no-commitment check.
 
virtual ExitDoorType reserveDoorForExit (const ThingTemplate *objType, Object *specificObject)
 All types can answer if they are free to exit or not, and you can ask about a specific guy or just exit anything in general.
 
virtual void exitObjectViaDoor (Object *newObj, ExitDoorType exitDoor)
 Here is the object for you to exit to the world in your own special way.
 
virtual void unreserveDoorForExit (ExitDoorType exitDoor)
 if you get permission to exit, but then don't/can't call exitObjectViaDoor, you should call this to "give up" your permission
 
virtual void exitObjectByBudding (Object *newObj, Object *budHost)
 puts new spawn on top of an existing one
 
virtual void setRallyPoint (const Coord3D *pos)
 define a "rally point" for units to move towards
 
virtual const Coord3D * getRallyPoint (void) const
 define a "rally point" for units to move towards
 
virtual Bool getExitPosition (Coord3D &exitPosition) const
 access to the "Door" position of the production object
 
virtual Bool getNaturalRallyPoint (Coord3D &rallyPoint, Bool offset=TRUE) const
 get the natural "rally point" for units to move towards
 
virtual UpdateSleepTime update ()
 
- 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 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 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)
 
- Public Member Functions inherited from ExitInterface
virtual void exitObjectInAHurry (Object *newObj)
 
virtual Bool useSpawnRallyPoint (void) const
 

Protected Attributes

Coord3D m_rallyPoint
 Where units should move to after they have reached the "natural" rally point.
 
Bool m_rallyPointExists
 Only move to the rally point if this is true.
 

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 69 of file SupplyCenterProductionExitUpdate.h.

Constructor & Destructor Documentation

◆ SupplyCenterProductionExitUpdate()

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

Definition at line 52 of file SupplyCenterProductionExitUpdate.cpp.

Member Function Documentation

◆ exitObjectByBudding()

virtual void SupplyCenterProductionExitUpdate::exitObjectByBudding ( Object * newObj,
Object * budHost )
inlinevirtual

puts new spawn on top of an existing one

Implements ExitInterface.

Definition at line 87 of file SupplyCenterProductionExitUpdate.h.

◆ exitObjectViaDoor()

void SupplyCenterProductionExitUpdate::exitObjectViaDoor ( Object * newObj,
ExitDoorType exitDoor )
virtual

Here is the object for you to exit to the world in your own special way.

Todo
This really should be automatically wrapped up in an actication sequence for objects in general

Implements ExitInterface.

Definition at line 65 of file SupplyCenterProductionExitUpdate.cpp.

◆ getExitPosition()

Bool SupplyCenterProductionExitUpdate::getExitPosition ( Coord3D & exitPosition) const
virtual

access to the "Door" position of the production object

Reimplemented from ExitInterface.

Definition at line 157 of file SupplyCenterProductionExitUpdate.cpp.

◆ getNaturalRallyPoint()

Bool SupplyCenterProductionExitUpdate::getNaturalRallyPoint ( Coord3D & rallyPoint,
Bool offset = TRUE ) const
virtual

get the natural "rally point" for units to move towards

Reimplemented from ExitInterface.

Definition at line 181 of file SupplyCenterProductionExitUpdate.cpp.

◆ getRallyPoint()

const Coord3D * SupplyCenterProductionExitUpdate::getRallyPoint ( void ) const
inlinevirtual

define a "rally point" for units to move towards

Implements ExitInterface.

Definition at line 110 of file SupplyCenterProductionExitUpdate.h.

◆ getUpdateExitInterface()

virtual ExitInterface * SupplyCenterProductionExitUpdate::getUpdateExitInterface ( )
inlinevirtual

Reimplemented from BehaviorModule.

Definition at line 77 of file SupplyCenterProductionExitUpdate.h.

◆ isExitBusy()

virtual Bool SupplyCenterProductionExitUpdate::isExitBusy ( ) const
inlinevirtual

Contain style exiters are getting the ability to space out exits, so ask this before reserveDoor as a kind of no-commitment check.

Implements ExitInterface.

Definition at line 83 of file SupplyCenterProductionExitUpdate.h.

◆ reserveDoorForExit()

virtual ExitDoorType SupplyCenterProductionExitUpdate::reserveDoorForExit ( const ThingTemplate * objType,
Object * specificObject )
inlinevirtual

All types can answer if they are free to exit or not, and you can ask about a specific guy or just exit anything in general.

Implements ExitInterface.

Definition at line 84 of file SupplyCenterProductionExitUpdate.h.

◆ setRallyPoint()

void SupplyCenterProductionExitUpdate::setRallyPoint ( const Coord3D * pos)
inlinevirtual

define a "rally point" for units to move towards

Implements ExitInterface.

Definition at line 104 of file SupplyCenterProductionExitUpdate.h.

◆ unreserveDoorForExit()

virtual void SupplyCenterProductionExitUpdate::unreserveDoorForExit ( ExitDoorType exitDoor)
inlinevirtual

if you get permission to exit, but then don't/can't call exitObjectViaDoor, you should call this to "give up" your permission

Implements ExitInterface.

Definition at line 86 of file SupplyCenterProductionExitUpdate.h.

◆ update()

virtual UpdateSleepTime SupplyCenterProductionExitUpdate::update ( void )
inlinevirtual

Implements UpdateModule.

Definition at line 94 of file SupplyCenterProductionExitUpdate.h.

Member Data Documentation

◆ m_rallyPoint

Coord3D SupplyCenterProductionExitUpdate::m_rallyPoint
protected

Where units should move to after they have reached the "natural" rally point.

Definition at line 98 of file SupplyCenterProductionExitUpdate.h.

◆ m_rallyPointExists

Bool SupplyCenterProductionExitUpdate::m_rallyPointExists
protected

Only move to the rally point if this is true.

Definition at line 99 of file SupplyCenterProductionExitUpdate.h.

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