#include <SpecialAbilityUpdate.h>

Inherits SpecialPowerUpdateModule.

Public Member Functions
	SpecialAbilityUpdate (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 Bool	doesSpecialPowerHaveOverridableDestinationActive () const

virtual Bool	doesSpecialPowerHaveOverridableDestination () const

virtual void	setSpecialPowerOverridableDestination (const Coord3D *loc)

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

virtual SpecialPowerUpdateInterface *	getSpecialPowerUpdateInterface ()

virtual CommandOption	getCommandOption () const

virtual UpdateSleepTime	update ()

UnsignedInt	getSpecialObjectCount () const

UnsignedInt	getSpecialObjectMax () const

Object *	findSpecialObjectWithProducerID (const Object *target)

SpecialPowerType	getSpecialPowerType (void) 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	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 Member Functions
void	onExit (Bool cleanup)

const SpecialPowerTemplate *	getTemplate () const

SpecialPowerModuleInterface *	getMySPM ()

Bool	isWithinStartAbilityRange () const

Bool	isWithinAbilityAbortRange () const

Bool	initLaser (Object specialObject, Object target)

Bool	approachTarget ()

void	startPreparation ()

Bool	continuePreparation ()

void	triggerAbilityEffect ()

void	finishAbility ()

void	validateSpecialObjects ()

Object *	createSpecialObject ()

void	killSpecialObjects ()

Bool	handlePackingProcessing ()

void	startPacking (Bool success)

void	startUnpacking ()

Bool	needToPack () const

Bool	needToUnpack () const

Bool	isPreparationComplete () const

void	endPreparation ()

Bool	isPersistentAbility () const

void	resetPreparation ()

Bool	isFacing ()

Bool	needToFace () const

void	startFacing ()

Bool	getDoesPersistenceRequireRecharge () const

UpdateSleepTime	calcSleepTime ()

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

Definition at line 172 of file SpecialAbilityUpdate.h.

Constructor & Destructor Documentation

◆ SpecialAbilityUpdate()

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

Definition at line 75 of file SpecialAbilityUpdate.cpp.

Member Function Documentation

◆ approachTarget()

Bool SpecialAbilityUpdate::approachTarget ( )

protected

Definition at line 957 of file SpecialAbilityUpdate.cpp.

◆ calcSleepTime()

UpdateSleepTime SpecialAbilityUpdate::calcSleepTime ( )

inlineprotected

Definition at line 255 of file SpecialAbilityUpdate.h.

◆ continuePreparation()

Bool SpecialAbilityUpdate::continuePreparation ( )

protected

Definition at line 1150 of file SpecialAbilityUpdate.cpp.

◆ createSpecialObject()

Object * SpecialAbilityUpdate::createSpecialObject ( )

protected

Definition at line 1624 of file SpecialAbilityUpdate.cpp.

◆ doesSpecialPowerHaveOverridableDestination()

virtual Bool SpecialAbilityUpdate::doesSpecialPowerHaveOverridableDestination ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 189 of file SpecialAbilityUpdate.h.

◆ doesSpecialPowerHaveOverridableDestinationActive()

virtual Bool SpecialAbilityUpdate::doesSpecialPowerHaveOverridableDestinationActive ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 188 of file SpecialAbilityUpdate.h.

◆ endPreparation()

void SpecialAbilityUpdate::endPreparation ( )

protected

Definition at line 1958 of file SpecialAbilityUpdate.cpp.

◆ findSpecialObjectWithProducerID()

Object * SpecialAbilityUpdate::findSpecialObjectWithProducerID ( const Object * target )

Definition at line 1939 of file SpecialAbilityUpdate.cpp.

◆ finishAbility()

void SpecialAbilityUpdate::finishAbility ( )

protected

Definition at line 1757 of file SpecialAbilityUpdate.cpp.

◆ getCommandOption()

virtual CommandOption SpecialAbilityUpdate::getCommandOption ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 197 of file SpecialAbilityUpdate.h.

◆ getDoesPersistenceRequireRecharge()

Bool SpecialAbilityUpdate::getDoesPersistenceRequireRecharge ( ) const

inlineprotected

Definition at line 249 of file SpecialAbilityUpdate.h.

◆ getMySPM()

SpecialPowerModuleInterface * SpecialAbilityUpdate::getMySPM ( )

protected

Definition at line 1105 of file SpecialAbilityUpdate.cpp.

◆ getSpecialObjectCount()

UnsignedInt SpecialAbilityUpdate::getSpecialObjectCount ( ) const

Definition at line 1723 of file SpecialAbilityUpdate.cpp.

◆ getSpecialObjectMax()

UnsignedInt SpecialAbilityUpdate::getSpecialObjectMax ( ) const

Definition at line 1729 of file SpecialAbilityUpdate.cpp.

◆ getSpecialPowerType()

SpecialPowerType SpecialAbilityUpdate::getSpecialPowerType ( void ) const

Definition at line 1931 of file SpecialAbilityUpdate.cpp.

◆ getSpecialPowerUpdateInterface()

virtual SpecialPowerUpdateInterface * SpecialAbilityUpdate::getSpecialPowerUpdateInterface ( )

inlinevirtual

Reimplemented from BehaviorModule.

Definition at line 196 of file SpecialAbilityUpdate.h.

◆ getTemplate()

const SpecialPowerTemplate * SpecialAbilityUpdate::getTemplate ( ) const

protected

Definition at line 1924 of file SpecialAbilityUpdate.cpp.

◆ handlePackingProcessing()

Bool SpecialAbilityUpdate::handlePackingProcessing ( )

protected

Definition at line 642 of file SpecialAbilityUpdate.cpp.

◆ initiateIntentToDoSpecialPower()

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

virtual

Implements SpecialPowerUpdateModule.

Definition at line 479 of file SpecialAbilityUpdate.cpp.

◆ initLaser()

Bool SpecialAbilityUpdate::initLaser	(	Object *	specialObject,
		Object *	target )

protected

Definition at line 1112 of file SpecialAbilityUpdate.cpp.

◆ isActive()

virtual Bool SpecialAbilityUpdate::isActive ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 187 of file SpecialAbilityUpdate.h.

◆ isFacing()

Bool SpecialAbilityUpdate::isFacing ( )

protected

Definition at line 1846 of file SpecialAbilityUpdate.cpp.

◆ isPersistentAbility()

Bool SpecialAbilityUpdate::isPersistentAbility ( ) const

inlineprotected

Definition at line 240 of file SpecialAbilityUpdate.h.

◆ isPowerCurrentlyInUse()

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

virtual

Implements SpecialPowerUpdateModule.

Definition at line 570 of file SpecialAbilityUpdate.cpp.

◆ isPreparationComplete()

Bool SpecialAbilityUpdate::isPreparationComplete ( ) const

inlineprotected

Definition at line 238 of file SpecialAbilityUpdate.h.

◆ isSpecialAbility()

virtual Bool SpecialAbilityUpdate::isSpecialAbility ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 185 of file SpecialAbilityUpdate.h.

◆ isSpecialPower()

virtual Bool SpecialAbilityUpdate::isSpecialPower ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 186 of file SpecialAbilityUpdate.h.

◆ isWithinAbilityAbortRange()

Bool SpecialAbilityUpdate::isWithinAbilityAbortRange ( ) const

protected

Definition at line 901 of file SpecialAbilityUpdate.cpp.

◆ isWithinStartAbilityRange()

Bool SpecialAbilityUpdate::isWithinStartAbilityRange ( ) const

protected

Definition at line 821 of file SpecialAbilityUpdate.cpp.

◆ killSpecialObjects()

void SpecialAbilityUpdate::killSpecialObjects ( )

protected

Definition at line 1685 of file SpecialAbilityUpdate.cpp.

◆ needToFace()

Bool SpecialAbilityUpdate::needToFace ( ) const

protected

Definition at line 1874 of file SpecialAbilityUpdate.cpp.

◆ needToPack()

Bool SpecialAbilityUpdate::needToPack ( ) const

protected

Definition at line 705 of file SpecialAbilityUpdate.cpp.

◆ needToUnpack()

Bool SpecialAbilityUpdate::needToUnpack ( ) const

protected

Definition at line 723 of file SpecialAbilityUpdate.cpp.

◆ onExit()

void SpecialAbilityUpdate::onExit ( Bool cleanup )

protected

Definition at line 603 of file SpecialAbilityUpdate.cpp.

◆ resetPreparation()

void SpecialAbilityUpdate::resetPreparation ( )

inlineprotected

Definition at line 241 of file SpecialAbilityUpdate.h.

◆ setSpecialPowerOverridableDestination()

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

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 190 of file SpecialAbilityUpdate.h.

◆ startFacing()

void SpecialAbilityUpdate::startFacing ( )

protected

Definition at line 1893 of file SpecialAbilityUpdate.cpp.

◆ startPacking()

void SpecialAbilityUpdate::startPacking ( Bool success )

protected

Definition at line 741 of file SpecialAbilityUpdate.cpp.

◆ startPreparation()

void SpecialAbilityUpdate::startPreparation ( )

protected

Definition at line 987 of file SpecialAbilityUpdate.cpp.

◆ startUnpacking()

void SpecialAbilityUpdate::startUnpacking ( )

protected

Definition at line 794 of file SpecialAbilityUpdate.cpp.

◆ triggerAbilityEffect()

void SpecialAbilityUpdate::triggerAbilityEffect ( )

protected

Definition at line 1264 of file SpecialAbilityUpdate.cpp.

◆ update()

UpdateSleepTime SpecialAbilityUpdate::update ( void )

virtual

Todo: srj – this could probably sleep more between stages. maybe someday.

Implements UpdateModule.

Definition at line 192 of file SpecialAbilityUpdate.cpp.

◆ validateSpecialObjects()

void SpecialAbilityUpdate::validateSpecialObjects ( )

protected

Definition at line 1736 of file SpecialAbilityUpdate.cpp.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpecialAbilityUpdate()

Member Function Documentation

◆ approachTarget()

◆ calcSleepTime()

◆ continuePreparation()

◆ createSpecialObject()

◆ doesSpecialPowerHaveOverridableDestination()

◆ doesSpecialPowerHaveOverridableDestinationActive()

◆ endPreparation()

◆ findSpecialObjectWithProducerID()

◆ finishAbility()

◆ getCommandOption()

◆ getDoesPersistenceRequireRecharge()

◆ getMySPM()

◆ getSpecialObjectCount()

◆ getSpecialObjectMax()

◆ getSpecialPowerType()

◆ getSpecialPowerUpdateInterface()

◆ getTemplate()

◆ handlePackingProcessing()

◆ initiateIntentToDoSpecialPower()

◆ initLaser()

◆ isActive()

◆ isFacing()

◆ isPersistentAbility()

◆ isPowerCurrentlyInUse()

◆ isPreparationComplete()

◆ isSpecialAbility()

◆ isSpecialPower()

◆ isWithinAbilityAbortRange()

◆ isWithinStartAbilityRange()

◆ killSpecialObjects()

◆ needToFace()

◆ needToPack()

◆ needToUnpack()

◆ onExit()

◆ resetPreparation()

◆ setSpecialPowerOverridableDestination()

◆ startFacing()

◆ startPacking()

◆ startPreparation()

◆ startUnpacking()

◆ triggerAbilityEffect()

◆ update()

◆ validateSpecialObjects()