AIDockState Class Reference

#include <AIStateMachine.h>

Inherits State.

Public Member Functions
	AIDockState (StateMachine *machine)
virtual Bool	isAttack () const
virtual StateReturnType	onEnter ()
virtual void	onExit (StateExitType status)
virtual StateReturnType	update ()
Public Member Functions inherited from State
	State (StateMachine *machine, AsciiString name)
	< this abstract class needs memory pool hooks
virtual Bool	isIdle () 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)
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 1074 of file AIStateMachine.h.

Constructor & Destructor Documentation

AIDockState()

AIDockState::AIDockState ( StateMachine * machine )

inline

Definition at line 1078 of file AIStateMachine.h.

Member Function Documentation

crc()

void AIDockState::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements State.

Definition at line 6041 of file AIStates.cpp.

isAttack()

virtual Bool AIDockState::isAttack ( ) const

inlinevirtual

Reimplemented from State.

Definition at line 1080 of file AIStateMachine.h.

loadPostProcess()

void AIDockState::loadPostProcess ( void )

protectedvirtual

Load post process

Implements State.

Definition at line 6072 of file AIStates.cpp.

onEnter()

StateReturnType AIDockState::onEnter ( void )

virtual

Dock with the GoalObject. When we enter the AI_DOCK state, create a docking state machine that implements the details of the docking behavior.

Reimplemented from State.

Definition at line 6094 of file AIStates.cpp.

onExit()

void AIDockState::onExit ( StateExitType status )

virtual

For whatever reason, we are leaving the AI_DOCK state. Destroy the docking sub-machine.

Reimplemented from State.

Definition at line 6133 of file AIStates.cpp.

update()

StateReturnType AIDockState::update ( void )

virtual

We are in the AI_DOCK state, execute the docking behavior.

Run the docking state sub-machine. If the dock state machine returns anything other than CONTINUE, it has finished. propagating the return code will cause the containing state machine to do the right thing.

Implements State.

Definition at line 6158 of file AIStates.cpp.

xfer()

void AIDockState::xfer ( Xfer * xfer )

protectedvirtual

Xfer Method

Implements State.

Definition at line 6048 of file AIStates.cpp.

---

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

• Code/GameEngine/Include/GameLogic/AIStateMachine.h
• Code/GameEngine/Source/GameLogic/AI/AIStates.cpp