ChinookHeadOffMapState Class Reference

Inherits State.

Public Member Functions
	ChinookHeadOffMapState (StateMachine *machine)
StateReturnType	onEnter ()
	executed once when entering state
StateReturnType	update ()
	implements this state's behavior, decides when to change state
void	onExit ()
Public Member Functions inherited from State
	State (StateMachine *machine, AsciiString name)
	< this abstract class needs memory pool hooks
virtual void	onExit (StateExitType status)
	executed once when leaving state
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

Detailed Description

Definition at line 146 of file ChinookAIUpdate.cpp.

Constructor & Destructor Documentation

ChinookHeadOffMapState()

ChinookHeadOffMapState::ChinookHeadOffMapState ( StateMachine * machine )

inline

Definition at line 156 of file ChinookAIUpdate.cpp.

Member Function Documentation

crc()

virtual void ChinookHeadOffMapState::crc ( Xfer * xfer )

inlineprotectedvirtual

run the "light" crc check on this data structure

Implements State.

Definition at line 152 of file ChinookAIUpdate.cpp.

loadPostProcess()

virtual void ChinookHeadOffMapState::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 154 of file ChinookAIUpdate.cpp.

onEnter()

StateReturnType ChinookHeadOffMapState::onEnter ( void )

inlinevirtual

executed once when entering state

Reimplemented from State.

Definition at line 158 of file ChinookAIUpdate.cpp.

onExit()

void ChinookHeadOffMapState::onExit ( )

inline

Definition at line 185 of file ChinookAIUpdate.cpp.

update()

StateReturnType ChinookHeadOffMapState::update ( )

inlinevirtual

implements this state's behavior, decides when to change state

Implements State.

Definition at line 170 of file ChinookAIUpdate.cpp.

xfer()

virtual void ChinookHeadOffMapState::xfer ( Xfer * xfer )

inlineprotectedvirtual

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 153 of file ChinookAIUpdate.cpp.

---

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

• Code/GameEngine/Source/GameLogic/Object/Update/AIUpdate/ChinookAIUpdate.cpp