TurretAIHoldTurretState Class Reference

#include <TurretAI.h>

Inherits TurretState.

Public Member Functions
	TurretAIHoldTurretState (TurretStateMachine *machine)
virtual StateReturnType	onEnter ()
	executed once when entering state
virtual void	onExit (StateExitType status)
	executed once when leaving state
virtual StateReturnType	update ()
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 TurretState
	TurretState (TurretStateMachine *machine, AsciiString name)
TurretAI *	getTurretAI ()
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

Hold turret position for a bit before recenter

Definition at line 194 of file TurretAI.h.

Constructor & Destructor Documentation

TurretAIHoldTurretState()

TurretAIHoldTurretState::TurretAIHoldTurretState ( TurretStateMachine * machine )

inline

Definition at line 200 of file TurretAI.h.

Member Function Documentation

crc()

void TurretAIHoldTurretState::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements State.

Definition at line 1412 of file TurretAI.cpp.

loadPostProcess()

void TurretAIHoldTurretState::loadPostProcess ( void )

protectedvirtual

Load post process

Implements State.

Definition at line 1432 of file TurretAI.cpp.

onEnter()

StateReturnType TurretAIHoldTurretState::onEnter ( void )

virtual

executed once when entering state

Reimplemented from State.

Definition at line 1437 of file TurretAI.cpp.

onExit()

void TurretAIHoldTurretState::onExit ( StateExitType status )

virtual

executed once when leaving state

Reimplemented from State.

Definition at line 1446 of file TurretAI.cpp.

update()

StateReturnType TurretAIHoldTurretState::update ( void )

virtual

Hold the turret's position for a short time before returning to center.

Implements State.

Definition at line 1455 of file TurretAI.cpp.

xfer()

void TurretAIHoldTurretState::xfer ( Xfer * xfer )

protectedvirtual

Xfer Method

Implements State.

Definition at line 1419 of file TurretAI.cpp.

---

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

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