AIAttackSquadState Class Reference

#include <AIStateMachine.h>

Inherits State.

Public Member Functions
	AIAttackSquadState (StateMachine *machine, AttackExitConditionsInterface *attackParameters=NULL)
virtual Bool	isAttack () const
virtual StateReturnType	onEnter (void)
virtual void	onExit (StateExitType status)
	executed once when leaving state
virtual StateReturnType	update (void)
Object *	chooseVictim (void)
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 1028 of file AIStateMachine.h.

Constructor & Destructor Documentation

AIAttackSquadState()

AIAttackSquadState::AIAttackSquadState ( StateMachine * machine, AttackExitConditionsInterface * attackParameters = NULL )

inline

Definition at line 1032 of file AIStateMachine.h.

Member Function Documentation

chooseVictim()

Object * AIAttackSquadState::chooseVictim

(

void

)

Definition at line 5928 of file AIStates.cpp.

crc()

void AIAttackSquadState::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements State.

Definition at line 5804 of file AIStates.cpp.

isAttack()

virtual Bool AIAttackSquadState::isAttack ( ) const

inlinevirtual

Reimplemented from State.

Definition at line 1036 of file AIStateMachine.h.

loadPostProcess()

void AIAttackSquadState::loadPostProcess ( void )

protectedvirtual

Load post process

Implements State.

Definition at line 5835 of file AIStates.cpp.

onEnter()

StateReturnType AIAttackSquadState::onEnter ( void )

virtual

Begin an attack on the machine's goal team. To do this, we use a sub attack machine.

Reimplemented from State.

Definition at line 5856 of file AIStates.cpp.

onExit()

void AIAttackSquadState::onExit ( StateExitType status )

virtual

executed once when leaving state

Reimplemented from State.

Definition at line 5917 of file AIStates.cpp.

update()

StateReturnType AIAttackSquadState::update ( void )

virtual

Execute one frame of "attack enemy" behavior.

Implements State.

Definition at line 5874 of file AIStates.cpp.

xfer()

void AIAttackSquadState::xfer ( Xfer * xfer )

protectedvirtual

Xfer Method

Implements State.

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