#include <BattlePlanUpdate.h>

Inherits SpecialPowerUpdateModule.

Public Member Functions
	BattlePlanUpdate (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 SpecialPowerUpdateInterface *	getSpecialPowerUpdateInterface ()

virtual Bool	doesSpecialPowerHaveOverridableDestinationActive () const

virtual Bool	doesSpecialPowerHaveOverridableDestination () const

virtual void	setSpecialPowerOverridableDestination (const Coord3D *loc)

virtual Bool	isPowerCurrentlyInUse (const CommandButton *command=NULL) const

BattlePlanStatus	getActiveBattlePlan () const

virtual void	onObjectCreated ()

virtual void	onDelete ()

virtual UpdateSleepTime	update ()

virtual CommandOption	getCommandOption () const

Public Member Functions inherited from SpecialPowerUpdateModule
	SpecialPowerUpdateModule (Thing thing, const ModuleData moduleData)

virtual Bool	doesSpecialPowerUpdatePassScienceTest () const

virtual ScienceType	getExtraRequiredScience () const

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 ExitInterface *	getUpdateExitInterface ()

virtual DockUpdateInterface *	getDockUpdateInterface ()

virtual RailedTransportDockUpdateInterface *	getRailedTransportDockUpdateInterface (void)

virtual SlowDeathBehaviorInterface *	getSlowDeathBehaviorInterface ()

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	onDrawableBoundToObject ()

virtual void	preloadAssets (TimeOfDay timeOfDay)
	preload any assets we might have for this time of day

Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()

Public Member Functions inherited from Snapshot
	Snapshot (void)

	~Snapshot (void)

Protected Member Functions
void	setStatus (TransitionStatus status)

void	enableTurret (Bool enable)

void	recenterTurret ()

Bool	isTurretInNaturalPosition ()

void	setBattlePlan (BattlePlanStatus plan)

void	createVisionObject ()

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

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)

Detailed Description

The default update module

Definition at line 128 of file BattlePlanUpdate.h.

Constructor & Destructor Documentation

◆ BattlePlanUpdate()

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

Definition at line 137 of file BattlePlanUpdate.cpp.

Member Function Documentation

◆ createVisionObject()

void BattlePlanUpdate::createVisionObject ( )

protected

Create vision objects for all players revealing this building to all

Definition at line 408 of file BattlePlanUpdate.cpp.

◆ doesSpecialPowerHaveOverridableDestination()

virtual Bool BattlePlanUpdate::doesSpecialPowerHaveOverridableDestination ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 146 of file BattlePlanUpdate.h.

◆ doesSpecialPowerHaveOverridableDestinationActive()

virtual Bool BattlePlanUpdate::doesSpecialPowerHaveOverridableDestinationActive ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 145 of file BattlePlanUpdate.h.

◆ enableTurret()

void BattlePlanUpdate::enableTurret ( Bool enable )

protected

Definition at line 677 of file BattlePlanUpdate.cpp.

◆ getActiveBattlePlan()

BattlePlanStatus BattlePlanUpdate::getActiveBattlePlan ( ) const

Definition at line 863 of file BattlePlanUpdate.cpp.

◆ getCommandOption()

CommandOption BattlePlanUpdate::getCommandOption ( ) const

virtual

Implements SpecialPowerUpdateModule.

Definition at line 305 of file BattlePlanUpdate.cpp.

◆ getSpecialPowerUpdateInterface()

virtual SpecialPowerUpdateInterface * BattlePlanUpdate::getSpecialPowerUpdateInterface ( )

inlinevirtual

Reimplemented from BehaviorModule.

Definition at line 144 of file BattlePlanUpdate.h.

◆ initiateIntentToDoSpecialPower()

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

virtual

Implements SpecialPowerUpdateModule.

Definition at line 267 of file BattlePlanUpdate.cpp.

◆ isActive()

virtual Bool BattlePlanUpdate::isActive ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 143 of file BattlePlanUpdate.h.

◆ isPowerCurrentlyInUse()

Bool BattlePlanUpdate::isPowerCurrentlyInUse ( const CommandButton * command = NULL ) const

virtual

Implements SpecialPowerUpdateModule.

Definition at line 298 of file BattlePlanUpdate.cpp.

◆ isSpecialAbility()

virtual Bool BattlePlanUpdate::isSpecialAbility ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 141 of file BattlePlanUpdate.h.

◆ isSpecialPower()

virtual Bool BattlePlanUpdate::isSpecialPower ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 142 of file BattlePlanUpdate.h.

◆ isTurretInNaturalPosition()

Bool BattlePlanUpdate::isTurretInNaturalPosition ( )

protected

Definition at line 705 of file BattlePlanUpdate.cpp.

◆ onDelete()

void BattlePlanUpdate::onDelete ( void )

virtual

On delete

Reimplemented from Module.

Definition at line 188 of file BattlePlanUpdate.cpp.

◆ onObjectCreated()

void BattlePlanUpdate::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 220 of file BattlePlanUpdate.cpp.

◆ recenterTurret()

void BattlePlanUpdate::recenterTurret ( )

protected

Definition at line 691 of file BattlePlanUpdate.cpp.

◆ setBattlePlan()

void BattlePlanUpdate::setBattlePlan ( BattlePlanStatus plan )

protected

Definition at line 733 of file BattlePlanUpdate.cpp.

◆ setSpecialPowerOverridableDestination()

virtual void BattlePlanUpdate::setSpecialPowerOverridableDestination ( const Coord3D * loc )

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 147 of file BattlePlanUpdate.h.

◆ setStatus()

void BattlePlanUpdate::setStatus ( TransitionStatus status )

protected

Definition at line 450 of file BattlePlanUpdate.cpp.

◆ update()

UpdateSleepTime BattlePlanUpdate::update ( void )

virtual

The update callback.

return UPDATE_SLEEP_FOREVER;

Implements UpdateModule.

Definition at line 322 of file BattlePlanUpdate.cpp.

Member Data Documentation

◆ m_bombardmentAnnouncement

AudioEventRTS BattlePlanUpdate::m_bombardmentAnnouncement

protected

Definition at line 180 of file BattlePlanUpdate.h.

◆ m_bombardmentPack

AudioEventRTS BattlePlanUpdate::m_bombardmentPack

protected

Definition at line 179 of file BattlePlanUpdate.h.

◆ m_bombardmentUnpack

AudioEventRTS BattlePlanUpdate::m_bombardmentUnpack

protected

Definition at line 178 of file BattlePlanUpdate.h.

◆ m_bonuses

BattlePlanBonuses* BattlePlanUpdate::m_bonuses

protected

Definition at line 176 of file BattlePlanUpdate.h.

◆ m_centeringTurret

Bool BattlePlanUpdate::m_centeringTurret

protected

Definition at line 175 of file BattlePlanUpdate.h.

◆ m_currentPlan

BattlePlanStatus BattlePlanUpdate::m_currentPlan

protected

Definition at line 167 of file BattlePlanUpdate.h.

◆ m_desiredPlan

BattlePlanStatus BattlePlanUpdate::m_desiredPlan

protected

Definition at line 168 of file BattlePlanUpdate.h.

◆ m_holdTheLineAnnouncement

AudioEventRTS BattlePlanUpdate::m_holdTheLineAnnouncement

protected

Definition at line 187 of file BattlePlanUpdate.h.

◆ m_holdTheLinePack

AudioEventRTS BattlePlanUpdate::m_holdTheLinePack

protected

Definition at line 186 of file BattlePlanUpdate.h.

◆ m_holdTheLineUnpack

AudioEventRTS BattlePlanUpdate::m_holdTheLineUnpack

protected

Definition at line 185 of file BattlePlanUpdate.h.

◆ m_invalidSettings

Bool BattlePlanUpdate::m_invalidSettings

protected

Definition at line 174 of file BattlePlanUpdate.h.

◆ m_nextReadyFrame

UnsignedInt BattlePlanUpdate::m_nextReadyFrame

protected

Definition at line 172 of file BattlePlanUpdate.h.

◆ m_planAffectingArmy

BattlePlanStatus BattlePlanUpdate::m_planAffectingArmy

protected

Definition at line 169 of file BattlePlanUpdate.h.

◆ m_searchAndDestroyAnnouncement

AudioEventRTS BattlePlanUpdate::m_searchAndDestroyAnnouncement

protected

Definition at line 184 of file BattlePlanUpdate.h.

◆ m_searchAndDestroyIdle

AudioEventRTS BattlePlanUpdate::m_searchAndDestroyIdle

protected

Definition at line 182 of file BattlePlanUpdate.h.

◆ m_searchAndDestroyPack

AudioEventRTS BattlePlanUpdate::m_searchAndDestroyPack

protected

Definition at line 183 of file BattlePlanUpdate.h.

◆ m_searchAndDestroyUnpack

AudioEventRTS BattlePlanUpdate::m_searchAndDestroyUnpack

protected

Definition at line 181 of file BattlePlanUpdate.h.

◆ m_specialPowerModule

SpecialPowerModuleInterface* BattlePlanUpdate::m_specialPowerModule

protected

Definition at line 173 of file BattlePlanUpdate.h.

◆ m_status

TransitionStatus BattlePlanUpdate::m_status

protected

Definition at line 170 of file BattlePlanUpdate.h.

◆ m_visionObjectID

ObjectID BattlePlanUpdate::m_visionObjectID

protected

Definition at line 190 of file BattlePlanUpdate.h.

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

Code/GameEngine/Include/GameLogic/Module/BattlePlanUpdate.h
Code/GameEngine/Source/GameLogic/Object/Update/BattlePlanUpdate.cpp

Protected Attributes
BattlePlanStatus	m_currentPlan

BattlePlanStatus	m_desiredPlan

BattlePlanStatus	m_planAffectingArmy

TransitionStatus	m_status

UnsignedInt	m_nextReadyFrame

SpecialPowerModuleInterface *	m_specialPowerModule

Bool	m_invalidSettings

Bool	m_centeringTurret

BattlePlanBonuses *	m_bonuses

AudioEventRTS	m_bombardmentUnpack

AudioEventRTS	m_bombardmentPack

AudioEventRTS	m_bombardmentAnnouncement

AudioEventRTS	m_searchAndDestroyUnpack

AudioEventRTS	m_searchAndDestroyIdle

AudioEventRTS	m_searchAndDestroyPack

AudioEventRTS	m_searchAndDestroyAnnouncement

AudioEventRTS	m_holdTheLineUnpack

AudioEventRTS	m_holdTheLinePack

AudioEventRTS	m_holdTheLineAnnouncement

ObjectID	m_visionObjectID

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BattlePlanUpdate()

Member Function Documentation

◆ createVisionObject()

◆ doesSpecialPowerHaveOverridableDestination()

◆ doesSpecialPowerHaveOverridableDestinationActive()

◆ enableTurret()

◆ getActiveBattlePlan()

◆ getCommandOption()

◆ getSpecialPowerUpdateInterface()

◆ initiateIntentToDoSpecialPower()

◆ isActive()

◆ isPowerCurrentlyInUse()

◆ isSpecialAbility()

◆ isSpecialPower()

◆ isTurretInNaturalPosition()

◆ onDelete()

◆ onObjectCreated()

◆ recenterTurret()

◆ setBattlePlan()

◆ setSpecialPowerOverridableDestination()

◆ setStatus()

◆ update()

Member Data Documentation

◆ m_bombardmentAnnouncement

◆ m_bombardmentPack

◆ m_bombardmentUnpack

◆ m_bonuses

◆ m_centeringTurret

◆ m_currentPlan

◆ m_desiredPlan

◆ m_holdTheLineAnnouncement

◆ m_holdTheLinePack

◆ m_holdTheLineUnpack

◆ m_invalidSettings

◆ m_nextReadyFrame

◆ m_planAffectingArmy

◆ m_searchAndDestroyAnnouncement

◆ m_searchAndDestroyIdle

◆ m_searchAndDestroyPack

◆ m_searchAndDestroyUnpack

◆ m_specialPowerModule

◆ m_status

◆ m_visionObjectID