AIFollowPathState Class Reference

#include <AIStateMachine.h>

Inherits AIInternalMoveToState.

Inherited by JetTakeoffOrLandingState.

Public Member Functions
	AIFollowPathState (StateMachine *machine, AsciiString name="AIFollowPathState")
virtual StateReturnType	onEnter ()
virtual void	onExit (StateExitType status)
virtual StateReturnType	update ()
Public Member Functions inherited from AIInternalMoveToState
	AIInternalMoveToState (StateMachine *machine, AsciiString name)
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
Int	getCurPathIndex () const
void	setAdjustFinalDestination (Bool b)
void	setAdjustFinalDestinationEvenIfNotDoingGroundMovement (Bool b)
virtual void	crc (Xfer *xfer)
virtual void	xfer (Xfer *xfer)
virtual void	loadPostProcess ()
Protected Member Functions inherited from AIInternalMoveToState
void	setAdjustsDestination (Bool b)
Bool	getAdjustsDestination () const
void	setGoalPos (const Coord3D *pos)
const Coord3D *	getGoalPos () const
virtual Bool	computePath ()
	compute the path
void	forceRepath ()
Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()
void *	operator new (size_t s)
void	operator delete (void *p)
virtual MemoryPool *	getObjectMemoryPool ()=0

Additional Inherited Members
Protected Attributes inherited from AIInternalMoveToState
Coord3D	m_goalPosition
	the goal position to move to
PathfindLayerEnum	m_goalLayer
	The layer we are moving towards.
Coord3D	m_pathGoalPosition
	the position our current path leads to
Bool	m_waitingForPath
	If we are waiting for a path.
Bool	m_tryOneMoreRepath
	If true, after we complete movement do another compute path.

Detailed Description

Follow simple list of points.

Definition at line 810 of file AIStateMachine.h.

Constructor & Destructor Documentation

AIFollowPathState()

AIFollowPathState::AIFollowPathState ( StateMachine * machine, AsciiString name = "AIFollowPathState" )

inline

Definition at line 814 of file AIStateMachine.h.

Member Function Documentation

crc()

void AIFollowPathState::crc ( Xfer * xfer )

protectedvirtual

CRC

Reimplemented from AIInternalMoveToState.

Definition at line 3222 of file AIStates.cpp.

getCurPathIndex()

Int AIFollowPathState::getCurPathIndex ( ) const

inlineprotected

Definition at line 826 of file AIStateMachine.h.

loadPostProcess()

void AIFollowPathState::loadPostProcess ( void )

protectedvirtual

Load post process

Reimplemented from AIInternalMoveToState.

Definition at line 3247 of file AIStates.cpp.

onEnter()

StateReturnType AIFollowPathState::onEnter ( void )

virtual

We are initiating a moveTo action. Pathfind from m_goalPosition to goal.

Reimplemented from AIInternalMoveToState.

Reimplemented in JetTakeoffOrLandingState.

Definition at line 3253 of file AIStates.cpp.

onExit()

void AIFollowPathState::onExit ( StateExitType status )

virtual

We are leaving the moveTo state.

Reimplemented from AIInternalMoveToState.

Reimplemented in JetTakeoffOrLandingState.

Definition at line 3315 of file AIStates.cpp.

setAdjustFinalDestination()

void AIFollowPathState::setAdjustFinalDestination ( Bool b )

inlineprotected

Definition at line 827 of file AIStateMachine.h.

setAdjustFinalDestinationEvenIfNotDoingGroundMovement()

void AIFollowPathState::setAdjustFinalDestinationEvenIfNotDoingGroundMovement ( Bool b )

inlineprotected

Definition at line 828 of file AIStateMachine.h.

update()

StateReturnType AIFollowPathState::update ( void )

virtual

Execute the moveTo behavior towards GoalPosition.

Todo

srj – find a way to sleep for a number of frames here, if possible

Reimplemented from AIInternalMoveToState.

Reimplemented in JetTakeoffOrLandingState.

Definition at line 3332 of file AIStates.cpp.

xfer()

void AIFollowPathState::xfer ( Xfer * xfer )

protectedvirtual

Xfer Method

Reimplemented from AIInternalMoveToState.

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