AIRappelState Class Reference

#include <AIStateMachine.h>

Inherits State.

Public Member Functions
	AIRappelState (StateMachine *machine)
virtual StateReturnType	onEnter ()
	executed once when entering state
virtual void	onExit (StateExitType status)
	executed once when leaving state
virtual StateReturnType	update ()
	implements this state's behavior, decides when to change 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	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

Protected Attributes
Real	m_rappelRate
Real	m_destZ
Bool	m_targetIsBldg

Detailed Description

Move to the GoalPosition, or GoalObject.

Definition at line 318 of file AIStateMachine.h.

Constructor & Destructor Documentation

AIRappelState()

AIRappelState::AIRappelState

(

StateMachine *

machine

)

Definition at line 471 of file AIStates.cpp.

Member Function Documentation

crc()

void AIRappelState::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements State.

Definition at line 479 of file AIStates.cpp.

loadPostProcess()

void AIRappelState::loadPostProcess ( void )

protectedvirtual

Load post process

Implements State.

Definition at line 501 of file AIStates.cpp.

onEnter()

StateReturnType AIRappelState::onEnter ( void )

virtual

executed once when entering state

Reimplemented from State.

Definition at line 505 of file AIStates.cpp.

onExit()

void AIRappelState::onExit ( StateExitType status )

virtual

executed once when leaving state

Reimplemented from State.

Definition at line 650 of file AIStates.cpp.

update()

StateReturnType AIRappelState::update ( )

virtual

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

Implements State.

Definition at line 543 of file AIStates.cpp.

xfer()

void AIRappelState::xfer ( Xfer * xfer )

protectedvirtual

Xfer Method

Implements State.

Definition at line 486 of file AIStates.cpp.

Member Data Documentation

m_destZ

Real AIRappelState::m_destZ

protected

Definition at line 323 of file AIStateMachine.h.

m_rappelRate

Real AIRappelState::m_rappelRate

protected

Definition at line 322 of file AIStateMachine.h.

m_targetIsBldg

Bool AIRappelState::m_targetIsBldg

protected

Definition at line 324 of file AIStateMachine.h.

---

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

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