AIDockWaitForClearanceState Class Reference

#include <AIDock.h>

Inherits State.

Public Member Functions
	AIDockWaitForClearanceState (StateMachine *machine)
virtual StateReturnType	onEnter (void)
virtual StateReturnType	update (void)
virtual void	onExit (StateExitType status)
	executed once when leaving state
Public Member Functions inherited from State
	State (StateMachine *machine, AsciiString name)
	< this abstract class needs memory pool hooks
virtual Bool	isIdle () const
virtual Bool	isAttack () const
virtual Bool	isGuardIdle () const
virtual Bool	isBusy () const
StateMachine *	getMachine ()
	return the machine this state is part of
StateID	getID () const
	get this state's id
Object *	getMachineOwner ()
const Object *	getMachineOwner () const
Object *	getMachineGoalObject ()
	return the machine this state is part of
const Object *	getMachineGoalObject () const
	return the machine this state is part of
const Coord3D *	getMachineGoalPosition () const
	return the machine this state is part of
void	friend_setID (StateID id)
	define this state's id (for use only by StateMachine class)
void	friend_onSuccess (StateID toStateID)
	define which state to move to after successful completion
void	friend_onFailure (StateID toStateID)
	define which state to move to after failure
void	friend_onCondition (StateTransFuncPtr test, StateID toStateID, void *userData, const char *description=NULL)
	define when to change state
StateReturnType	friend_checkForTransitions (StateReturnType status)
	given a return code, handle state transitions
StateReturnType	friend_checkForSleepTransitions (StateReturnType status)
	given a return code, handle state transitions
Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()
Public Member Functions inherited from Snapshot
	Snapshot (void)
	~Snapshot (void)

Protected Member Functions
virtual void	crc (Xfer *xfer)
	run the "light" crc check on this data structure
virtual void	xfer (Xfer *xfer)
virtual void	loadPostProcess ()
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_enterFrame

Detailed Description

Definition at line 100 of file AIDock.h.

Constructor & Destructor Documentation

AIDockWaitForClearanceState()

AIDockWaitForClearanceState::AIDockWaitForClearanceState ( StateMachine * machine )

inline

Definition at line 104 of file AIDock.h.

Member Function Documentation

crc()

virtual void AIDockWaitForClearanceState::crc ( Xfer * xfer )

inlineprotectedvirtual

run the "light" crc check on this data structure

Implements State.

Definition at line 112 of file AIDock.h.

loadPostProcess()

virtual void AIDockWaitForClearanceState::loadPostProcess ( )

inlineprotectedvirtual

post process phase for loading save games. All save systems have their xfer run using XferLoad mode, and then all systems each have their post process run

Implements State.

Definition at line 114 of file AIDock.h.

onEnter()

StateReturnType AIDockWaitForClearanceState::onEnter ( void )

virtual

We have approached, now wait at our queue position until the dock says we can enter.

Reimplemented from State.

Definition at line 248 of file AIDock.cpp.

onExit()

void AIDockWaitForClearanceState::onExit ( StateExitType status )

virtual

executed once when leaving state

Reimplemented from State.

Definition at line 290 of file AIDock.cpp.

update()

StateReturnType AIDockWaitForClearanceState::update ( void )

virtual

We have approached, now wait at our queue position until the dock says we can enter.

Todo

What if we are pushed off of our queue spot? We need to move back on... (MSB)

Implements State.

Definition at line 258 of file AIDock.cpp.

xfer()

void AIDockWaitForClearanceState::xfer ( Xfer * xfer )

protectedvirtual

run save, load, or deep CRC check on this data structure, the type depends on the setup of the Xfer pointer

Implements State.

Definition at line 304 of file AIDock.cpp.

Member Data Documentation

m_enterFrame

UnsignedInt AIDockWaitForClearanceState::m_enterFrame

protected

Definition at line 109 of file AIDock.h.

---

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

• Code/GameEngine/Include/GameLogic/AIDock.h
• Code/GameEngine/Source/GameLogic/AI/AIDock.cpp