OCLUpdate Class Reference

#include <OCLUpdate.h>

Inherits UpdateModule.

Public Member Functions
	OCLUpdate (Thing *thing, const ModuleData *moduleData)
virtual UpdateSleepTime	update ()
Real	getCountdownPercent () const
	goes from 0% to 100%
UnsignedInt	getRemainingFrames () const
	For feedback display.
void	resetTimer ()
	added for sabotage purposes.
virtual DisabledMaskType	getDisabledTypesToProcess () 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 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
Bool	shouldCreate ()
void	setNextCreationFrame ()
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

Protected Attributes
UnsignedInt	m_nextCreationFrame
UnsignedInt	m_timerStartedFrame
Bool	m_isFactionNeutral
Color	m_currentPlayerColor

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 70 of file OCLUpdate.h.

Constructor & Destructor Documentation

OCLUpdate()

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

Definition at line 108 of file OCLUpdate.cpp.

Member Function Documentation

getCountdownPercent()

Real OCLUpdate::getCountdownPercent

(

)

const

goes from 0% to 100%

Definition at line 254 of file OCLUpdate.cpp.

getDisabledTypesToProcess()

virtual DisabledMaskType OCLUpdate::getDisabledTypesToProcess ( ) const

inlinevirtual

Implements UpdateModuleInterface.

Definition at line 86 of file OCLUpdate.h.

getRemainingFrames()

UnsignedInt OCLUpdate::getRemainingFrames

(

)

const

For feedback display.

Definition at line 263 of file OCLUpdate.cpp.

resetTimer()

void OCLUpdate::resetTimer

(

)

added for sabotage purposes.

Definition at line 223 of file OCLUpdate.cpp.

setNextCreationFrame()

void OCLUpdate::setNextCreationFrame ( )

protected

Definition at line 243 of file OCLUpdate.cpp.

shouldCreate()

Bool OCLUpdate::shouldCreate ( )

protected

Definition at line 230 of file OCLUpdate.cpp.

update()

UpdateSleepTime OCLUpdate::update ( void )

virtual

Todo

srj use SLEEPY_UPDATE here

Implements UpdateModule.

Definition at line 124 of file OCLUpdate.cpp.

Member Data Documentation

m_currentPlayerColor

Color OCLUpdate::m_currentPlayerColor

protected

Definition at line 93 of file OCLUpdate.h.

m_isFactionNeutral

Bool OCLUpdate::m_isFactionNeutral

protected

Definition at line 92 of file OCLUpdate.h.

m_nextCreationFrame

UnsignedInt OCLUpdate::m_nextCreationFrame

protected

Definition at line 90 of file OCLUpdate.h.

m_timerStartedFrame

UnsignedInt OCLUpdate::m_timerStartedFrame

protected

Definition at line 91 of file OCLUpdate.h.

---

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

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