AIGuardOuterState Class Reference

#include <AIGuard.h>

Inherits State.

Public Member Functions
	AIGuardOuterState (StateMachine *machine)
virtual Bool	isAttack () const
virtual StateReturnType	onEnter (void)
	executed once when entering state
virtual StateReturnType	update (void)
	implements this state's behavior, decides when to change state
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	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 191 of file AIGuard.h.

Constructor & Destructor Documentation

AIGuardOuterState()

AIGuardOuterState::AIGuardOuterState ( StateMachine * machine )

inline

Definition at line 195 of file AIGuard.h.

Member Function Documentation

crc()

void AIGuardOuterState::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements State.

Definition at line 485 of file AIGuard.cpp.

isAttack()

virtual Bool AIGuardOuterState::isAttack ( ) const

inlinevirtual

Reimplemented from State.

Definition at line 199 of file AIGuard.h.

loadPostProcess()

void AIGuardOuterState::loadPostProcess ( void )

protectedvirtual

Load post process

Implements State.

Definition at line 504 of file AIGuard.cpp.

onEnter()

StateReturnType AIGuardOuterState::onEnter ( void )

virtual

executed once when entering state

Reimplemented from State.

Definition at line 510 of file AIGuard.cpp.

onExit()

void AIGuardOuterState::onExit ( StateExitType status )

virtual

executed once when leaving state

Reimplemented from State.

Definition at line 588 of file AIGuard.cpp.

update()

StateReturnType AIGuardOuterState::update ( void )

virtual

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

Implements State.

Definition at line 558 of file AIGuard.cpp.

xfer()

void AIGuardOuterState::xfer ( Xfer * xfer )

protectedvirtual

Xfer Method

Implements State.

Definition at line 492 of file AIGuard.cpp.

---

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

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