OCLSpecialPower Class Reference

#include <OCLSpecialPower.h>

Inherits SpecialPowerModule.

Public Member Functions
	OCLSpecialPower (Thing *thing, const ModuleData *moduleData)
virtual void	doSpecialPower (UnsignedInt commandOptions)
virtual void	doSpecialPowerAtObject (Object *obj, UnsignedInt commandOptions)
virtual void	doSpecialPowerAtLocation (const Coord3D *loc, Real angle, UnsignedInt commandOptions)
virtual const ThingTemplate *	getReferenceThingTemplate () const
Public Member Functions inherited from SpecialPowerModule
	SpecialPowerModule (Thing *thing, const ModuleData *moduleData)
virtual SpecialPowerModuleInterface *	getSpecialPower ()
Bool	isModuleForPower (const SpecialPowerTemplate *specialPowerTemplate) const
	is this module for the specified special power
Bool	isReady (void) const
	is this special power available now
Real	getPercentReady (void) const
	get the percent ready (1.0 = ready now, 0.5 = half charged up etc.)
UnsignedInt	getReadyFrame (void) const
	get the frame at which we are ready
AsciiString	getPowerName (void) const
void	syncReadyFrameToStatusQuo (void)
const SpecialPowerTemplate *	getSpecialPowerTemplate (void) const
ScienceType	getRequiredScience (void) const
void	onSpecialPowerCreation (void)
void	setReadyFrame (UnsignedInt frame)
UnsignedInt	getReadyFrame (void)
void	pauseCountdown (Bool pause)
virtual void	doSpecialPowerUsingWaypoints (const Waypoint *way, UnsignedInt commandOptions)
virtual void	markSpecialPowerTriggered (const Coord3D *location)
virtual void	startPowerRecharge ()
virtual const AudioEventRTS &	getInitiateSound () const
virtual Bool	isScriptOnly () 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 UpdateModuleInterface *	getUpdate ()
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)

Protected Member Functions
const ObjectCreationList *	findOCL () const
Protected Member Functions inherited from SpecialPowerModule
Bool	initiateIntentToDoSpecialPower (const Object *targetObj, const Coord3D *targetPos, const Waypoint *way, UnsignedInt commandOptions)
void	triggerSpecialPower (const Coord3D *location)
void	createViewObject (const Coord3D *location)
void	resolveSpecialPower (void)
void	aboutToDoSpecialPower (const Coord3D *location)
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 SpecialPowerModule
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 Attributes inherited from SpecialPowerModule
UnsignedInt	m_availableOnFrame
	on this frame, this special power is available
Int	m_pausedCount
	Reference count of sources pausing me.
UnsignedInt	m_pausedOnFrame
Real	m_pausedPercent

Detailed Description

Definition at line 85 of file OCLSpecialPower.h.

Constructor & Destructor Documentation

OCLSpecialPower()

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

Definition at line 118 of file OCLSpecialPower.cpp.

Member Function Documentation

doSpecialPower()

void OCLSpecialPower::doSpecialPower ( UnsignedInt commandOptions )

virtual

Reimplemented from SpecialPowerModule.

Definition at line 234 of file OCLSpecialPower.cpp.

doSpecialPowerAtLocation()

void OCLSpecialPower::doSpecialPowerAtLocation ( const Coord3D * loc, Real angle, UnsignedInt commandOptions )

virtual

Execute the power

Reimplemented from SpecialPowerModule.

Definition at line 153 of file OCLSpecialPower.cpp.

doSpecialPowerAtObject()

void OCLSpecialPower::doSpecialPowerAtObject ( Object * obj, UnsignedInt commandOptions )

virtual

Reimplemented from SpecialPowerModule.

Definition at line 222 of file OCLSpecialPower.cpp.

findOCL()

const ObjectCreationList * OCLSpecialPower::findOCL ( ) const

protected

Definition at line 126 of file OCLSpecialPower.cpp.

getReferenceThingTemplate()

const ThingTemplate * OCLSpecialPower::getReferenceThingTemplate ( ) const

virtual

Reimplemented from SpecialPowerModule.

Definition at line 250 of file OCLSpecialPower.cpp.

---

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

• Code/GameEngine/Include/GameLogic/Module/OCLSpecialPower.h
• Code/GameEngine/Source/GameLogic/Object/SpecialPower/OCLSpecialPower.cpp