#include <SupplyWarehouseDockUpdate.h>

Inherits DockUpdate.

Public Member Functions
virtual DockUpdateInterface *	getDockUpdateInterface ()

	SupplyWarehouseDockUpdate (Thing thing, const ModuleData moduleData)

virtual void	setDockCrippled (Bool setting)
	Game Logic can set me as inoperative. I get to decide what that means.

virtual Bool	action (Object docker, Object drone=NULL)
	For me, this means identifying who is docking and either taking Boxes away or giving them.

Int	getBoxesStored () const

void	setCashValue (Int cashValue)

virtual void	onObjectCreated ()

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

virtual Bool	isClearToApproach (Object const *docker) const

virtual Bool	reserveApproachPosition (Object docker, Coord3D position, Int *index)

virtual Bool	advanceApproachPosition (Object docker, Coord3D position, Int *index)

virtual Bool	isClearToEnter (Object const *docker) const

virtual Bool	isClearToAdvance (Object const *docker, Int dockerIndex) const

virtual void	getEnterPosition (Object docker, Coord3D position)

virtual void	getDockPosition (Object docker, Coord3D position)

virtual void	getExitPosition (Object docker, Coord3D position)

virtual void	onApproachReached (Object *docker)
	I have reached the Approach Point.

virtual void	onEnterReached (Object *docker)
	I have reached the Enter Point.

virtual void	onDockReached (Object *docker)
	I have reached the Dock point.

virtual void	onExitReached (Object *docker)
	I have reached the exit. You are no longer busy.

virtual void	cancelDock (Object *docker)
	Clear me from any reserved points, and if I was the reason you were Busy, you aren't anymore.

virtual Bool	isDockOpen (void)
	Is the dock open to accepting dockers.

virtual void	setDockOpen (Bool open)
	Open/Close the dock.

virtual Bool	isAllowPassthroughType ()
	Not all docks allow you to path through them in your AIDock machine.

virtual Bool	isRallyPointAfterDockType ()
	A minority of docks want to give you a final command to their rally point.

virtual UpdateSleepTime	update ()
	In charge of lifting dock restriction for one registered as Approached if all is ready.

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 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	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 Attributes
Int	m_boxesStored

Protected Attributes inherited from DockUpdate
Coord3D	m_enterPosition

Coord3D	m_dockPosition

Coord3D	m_exitPosition

Int	m_numberApproachPositions

Int	m_numberApproachPositionBones

Bool	m_positionsLoaded
	FALSE until we have loaded all the docking positions.

VecCoord3D	m_approachPositions

ObjectIDVector	m_approachPositionOwners
	Who is in or at least reserved each spot.

BoolVector	m_approachPositionReached
	Which positions have actually been reached.

ObjectID	m_activeDocker
	we could expand this to multiple dock paths since we always get docker in our methods

Bool	m_dockerInside
	This is true while our active docker is between Enter and Exit. This is shorter than activeDocker's lifetime as it doesn't include approach to enter.

Bool	m_dockCrippled
	Has game logic set me as crippled?

Bool	m_dockOpen
	Is the dock open for dockers.

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)

Protected Member Functions inherited from DockUpdate
void	loadDockPositions ()
	load all the dock positions

Coord3D	computeApproachPosition (Int positionIndex, Object *forWhom)
	Do a smart lookup of this bone position.

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

Detailed Description

Definition at line 55 of file SupplyWarehouseDockUpdate.h.

Constructor & Destructor Documentation

◆ SupplyWarehouseDockUpdate()

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

Definition at line 75 of file SupplyWarehouseDockUpdate.cpp.

Member Function Documentation

◆ action()

Bool SupplyWarehouseDockUpdate::action	(	Object *	docker,
		Object *	drone = NULL )

virtual

For me, this means identifying who is docking and either taking Boxes away or giving them.

Implements DockUpdateInterface.

Definition at line 93 of file SupplyWarehouseDockUpdate.cpp.

◆ getBoxesStored()

Int SupplyWarehouseDockUpdate::getBoxesStored ( ) const

inline

Definition at line 70 of file SupplyWarehouseDockUpdate.h.

◆ getDockUpdateInterface()

virtual DockUpdateInterface * SupplyWarehouseDockUpdate::getDockUpdateInterface ( )

inlinevirtual

Reimplemented from BehaviorModule.

Definition at line 63 of file SupplyWarehouseDockUpdate.h.

◆ onObjectCreated()

void SupplyWarehouseDockUpdate::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 84 of file SupplyWarehouseDockUpdate.cpp.

◆ setCashValue()

void SupplyWarehouseDockUpdate::setCashValue ( Int cashValue )

Definition at line 175 of file SupplyWarehouseDockUpdate.cpp.

◆ setDockCrippled()

void SupplyWarehouseDockUpdate::setDockCrippled ( Bool setting )

virtual

Game Logic can set me as inoperative. I get to decide what that means.

Reimplemented from DockUpdate.

Definition at line 142 of file SupplyWarehouseDockUpdate.cpp.

Member Data Documentation

◆ m_boxesStored

Int SupplyWarehouseDockUpdate::m_boxesStored

protected

Definition at line 78 of file SupplyWarehouseDockUpdate.h.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SupplyWarehouseDockUpdate()

Member Function Documentation

◆ action()

◆ getBoxesStored()

◆ getDockUpdateInterface()

◆ onObjectCreated()

◆ setCashValue()

◆ setDockCrippled()

Member Data Documentation

◆ m_boxesStored