#include <SpectreGunshipUpdate.h>

Inherits SpecialPowerUpdateModule.

Public Member Functions
	SpectreGunshipUpdate (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 CommandOption	getCommandOption () const

virtual Bool	isPowerCurrentlyInUse (const CommandButton *command=NULL) 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

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

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	setLogicalStatus (GunshipStatus newStatus)

void	disengageAndDepartAO (Object *gunship)

Bool	isPointOffMap (const Coord3D &testPos) const

Bool	isFairDistanceFromShip (Object *target)

void	friend_enableAfterburners (Bool v)

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 94 of file SpectreGunshipUpdate.h.

Constructor & Destructor Documentation

◆ SpectreGunshipUpdate()

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

Definition at line 135 of file SpectreGunshipUpdate.cpp.

Member Function Documentation

◆ cleanUp()

void SpectreGunshipUpdate::cleanUp ( )

Definition at line 766 of file SpectreGunshipUpdate.cpp.

◆ disengageAndDepartAO()

void SpectreGunshipUpdate::disengageAndDepartAO ( Object * gunship )

protected

Definition at line 786 of file SpectreGunshipUpdate.cpp.

◆ doesSpecialPowerHaveOverridableDestination()

virtual Bool SpectreGunshipUpdate::doesSpecialPowerHaveOverridableDestination ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 121 of file SpectreGunshipUpdate.h.

◆ doesSpecialPowerHaveOverridableDestinationActive()

Bool SpectreGunshipUpdate::doesSpecialPowerHaveOverridableDestinationActive ( ) const

virtual

Implements SpecialPowerUpdateModule.

Definition at line 838 of file SpectreGunshipUpdate.cpp.

◆ friend_enableAfterburners()

void SpectreGunshipUpdate::friend_enableAfterburners ( Bool v )

protected

Definition at line 713 of file SpectreGunshipUpdate.cpp.

◆ getCommandOption()

virtual CommandOption SpectreGunshipUpdate::getCommandOption ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 110 of file SpectreGunshipUpdate.h.

◆ getDisabledTypesToProcess()

virtual DisabledMaskType SpectreGunshipUpdate::getDisabledTypesToProcess ( ) const

inlinevirtual

Implements UpdateModuleInterface.

Definition at line 125 of file SpectreGunshipUpdate.h.

◆ getSpecialPowerUpdateInterface()

virtual SpecialPowerUpdateInterface * SpectreGunshipUpdate::getSpecialPowerUpdateInterface ( )

inlinevirtual

Reimplemented from BehaviorModule.

Definition at line 109 of file SpectreGunshipUpdate.h.

◆ initiateIntentToDoSpecialPower()

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

virtual

Implements SpecialPowerUpdateModule.

Definition at line 189 of file SpectreGunshipUpdate.cpp.

◆ isActive()

virtual Bool SpectreGunshipUpdate::isActive ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 108 of file SpectreGunshipUpdate.h.

◆ isFairDistanceFromShip()

Bool SpectreGunshipUpdate::isFairDistanceFromShip ( Object * target )

protected

Definition at line 737 of file SpectreGunshipUpdate.cpp.

◆ isPointOffMap()

Bool SpectreGunshipUpdate::isPointOffMap ( const Coord3D & testPos ) const

protected

Definition at line 309 of file SpectreGunshipUpdate.cpp.

◆ isPowerCurrentlyInUse()

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

virtual

Implements SpecialPowerUpdateModule.

Definition at line 286 of file SpectreGunshipUpdate.cpp.

◆ isSpecialAbility()

virtual Bool SpectreGunshipUpdate::isSpecialAbility ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 106 of file SpectreGunshipUpdate.h.

◆ isSpecialPower()

virtual Bool SpectreGunshipUpdate::isSpecialPower ( ) const

inlinevirtual

Implements SpecialPowerUpdateModule.

Definition at line 107 of file SpectreGunshipUpdate.h.

◆ onObjectCreated()

void SpectreGunshipUpdate::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 173 of file SpectreGunshipUpdate.cpp.

◆ setLogicalStatus()

void SpectreGunshipUpdate::setLogicalStatus ( GunshipStatus newStatus )

inlineprotected

Definition at line 129 of file SpectreGunshipUpdate.h.

◆ setSpecialPowerOverridableDestination()

void SpectreGunshipUpdate::setSpecialPowerOverridableDestination ( const Coord3D * loc )

virtual

Implements SpecialPowerUpdateModule.

Definition at line 292 of file SpectreGunshipUpdate.cpp.

◆ update()

UpdateSleepTime SpectreGunshipUpdate::update ( void )

virtual

The update callback.

Implements UpdateModule.

Definition at line 360 of file SpectreGunshipUpdate.cpp.

Member Data Documentation

◆ m_afterburnerSound

AudioEventRTS SpectreGunshipUpdate::m_afterburnerSound

protected

Definition at line 169 of file SpectreGunshipUpdate.h.

◆ m_attackAreaDecal

RadiusDecal SpectreGunshipUpdate::m_attackAreaDecal

protected

Definition at line 159 of file SpectreGunshipUpdate.h.

◆ m_gattlingID

ObjectID SpectreGunshipUpdate::m_gattlingID

protected

Definition at line 156 of file SpectreGunshipUpdate.h.

◆ m_gattlingTargetPosition

Coord3D SpectreGunshipUpdate::m_gattlingTargetPosition

protected

Definition at line 145 of file SpectreGunshipUpdate.h.

◆ m_howitzerFireSound

AudioEventRTS SpectreGunshipUpdate::m_howitzerFireSound

protected

Definition at line 170 of file SpectreGunshipUpdate.h.

◆ m_initialTargetPosition

Coord3D SpectreGunshipUpdate::m_initialTargetPosition

protected

Definition at line 142 of file SpectreGunshipUpdate.h.

◆ m_okToFireHowitzerCounter

UnsignedInt SpectreGunshipUpdate::m_okToFireHowitzerCounter

protected

Definition at line 151 of file SpectreGunshipUpdate.h.

◆ m_orbitEscapeFrame

UnsignedInt SpectreGunshipUpdate::m_orbitEscapeFrame

protected

Definition at line 152 of file SpectreGunshipUpdate.h.

◆ m_overrideTargetDestination

Coord3D SpectreGunshipUpdate::m_overrideTargetDestination

protected

Definition at line 143 of file SpectreGunshipUpdate.h.

◆ m_positionToShootAt

Coord3D SpectreGunshipUpdate::m_positionToShootAt

protected

Definition at line 146 of file SpectreGunshipUpdate.h.

◆ m_satellitePosition

Coord3D SpectreGunshipUpdate::m_satellitePosition

protected

Definition at line 144 of file SpectreGunshipUpdate.h.

◆ m_specialPowerModule

SpecialPowerModuleInterface* SpectreGunshipUpdate::m_specialPowerModule

protected

Definition at line 135 of file SpectreGunshipUpdate.h.

◆ m_status

GunshipStatus SpectreGunshipUpdate::m_status

protected

Definition at line 149 of file SpectreGunshipUpdate.h.

◆ m_targetingReticleDecal

RadiusDecal SpectreGunshipUpdate::m_targetingReticleDecal

protected

Definition at line 160 of file SpectreGunshipUpdate.h.

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

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

Protected Attributes
SpecialPowerModuleInterface *	m_specialPowerModule

Coord3D	m_initialTargetPosition

Coord3D	m_overrideTargetDestination

Coord3D	m_satellitePosition

Coord3D	m_gattlingTargetPosition

Coord3D	m_positionToShootAt

GunshipStatus	m_status

UnsignedInt	m_okToFireHowitzerCounter

UnsignedInt	m_orbitEscapeFrame

ObjectID	m_gattlingID

RadiusDecal	m_attackAreaDecal

RadiusDecal	m_targetingReticleDecal

AudioEventRTS	m_afterburnerSound

AudioEventRTS	m_howitzerFireSound

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpectreGunshipUpdate()

Member Function Documentation

◆ cleanUp()

◆ disengageAndDepartAO()

◆ doesSpecialPowerHaveOverridableDestination()

◆ doesSpecialPowerHaveOverridableDestinationActive()

◆ friend_enableAfterburners()

◆ getCommandOption()

◆ getDisabledTypesToProcess()

◆ getSpecialPowerUpdateInterface()

◆ initiateIntentToDoSpecialPower()

◆ isActive()

◆ isFairDistanceFromShip()

◆ isPointOffMap()

◆ isPowerCurrentlyInUse()

◆ isSpecialAbility()

◆ isSpecialPower()

◆ onObjectCreated()

◆ setLogicalStatus()

◆ setSpecialPowerOverridableDestination()

◆ update()

Member Data Documentation

◆ m_afterburnerSound

◆ m_attackAreaDecal

◆ m_gattlingID

◆ m_gattlingTargetPosition

◆ m_howitzerFireSound

◆ m_initialTargetPosition

◆ m_okToFireHowitzerCounter

◆ m_orbitEscapeFrame

◆ m_overrideTargetDestination

◆ m_positionToShootAt

◆ m_satellitePosition

◆ m_specialPowerModule

◆ m_status

◆ m_targetingReticleDecal