AIIdleState Class Reference

#include <AIStateMachine.h>

Inherits State.

Public Types
enum	AIIdleTargetingType { LOOK_FOR_TARGETS , DO_NOT_LOOK_FOR_TARGETS }

Public Member Functions
virtual Bool	isIdle (void) const
	AIIdleState (StateMachine *machine, AIIdleTargetingType shouldLookForTargets)
virtual StateReturnType	onEnter ()
virtual StateReturnType	update ()
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	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)
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 217 of file AIStateMachine.h.

Member Enumeration Documentation

AIIdleTargetingType

enum AIIdleState::AIIdleTargetingType

Enumerator
LOOK_FOR_TARGETS
DO_NOT_LOOK_FOR_TARGETS

Definition at line 229 of file AIStateMachine.h.

Constructor & Destructor Documentation

AIIdleState()

AIIdleState::AIIdleState	(	StateMachine *	machine,
		AIIdleState::AIIdleTargetingType	shouldLookForTargets )

Definition at line 1273 of file AIStates.cpp.

Member Function Documentation

crc()

void AIIdleState::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements State.

Definition at line 1284 of file AIStates.cpp.

isIdle()

virtual Bool AIIdleState::isIdle ( void ) const

inlinevirtual

Reimplemented from State.

Definition at line 234 of file AIStateMachine.h.

loadPostProcess()

void AIIdleState::loadPostProcess ( void )

protectedvirtual

Load post process

Implements State.

Definition at line 1306 of file AIStates.cpp.

onEnter()

StateReturnType AIIdleState::onEnter ( void )

virtual

Stake out our space.

Reimplemented from State.

Definition at line 1314 of file AIStates.cpp.

update()

StateReturnType AIIdleState::update ( void )

virtual

Just sit there.

Implements State.

Definition at line 1393 of file AIStates.cpp.

xfer()

void AIIdleState::xfer ( Xfer * xfer )

protectedvirtual

Xfer Method

Implements State.

Definition at line 1291 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