AIDockProcessDockState Class Reference

#include <AIDock.h>

Inherits State.

Public Member Functions
	AIDockProcessDockState (StateMachine *machine)
virtual StateReturnType	onEnter (void)
	executed once when entering state
virtual void	onExit (StateExitType status)
	executed once when leaving state
virtual StateReturnType	update (void)
void	setNextDockActionFrame ()
Object *	findMyDrone ()
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)

Public Attributes
UnsignedInt	m_nextDockActionFrame

Protected Member Functions
virtual void	crc (Xfer *xfer)
	run the "light" crc check on this data structure
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 167 of file AIDock.h.

Constructor & Destructor Documentation

AIDockProcessDockState()

AIDockProcessDockState::AIDockProcessDockState

(

StateMachine *

machine

)

Definition at line 568 of file AIDock.cpp.

Member Function Documentation

crc()

virtual void AIDockProcessDockState::crc ( Xfer * xfer )

inlineprotectedvirtual

run the "light" crc check on this data structure

Implements State.

Definition at line 183 of file AIDock.h.

findMyDrone()

Object * AIDockProcessDockState::findMyDrone

(

)

Definition at line 662 of file AIDock.cpp.

loadPostProcess()

virtual void AIDockProcessDockState::loadPostProcess ( )

inlineprotectedvirtual

post process phase for loading save games. All save systems have their xfer run using XferLoad mode, and then all systems each have their post process run

Implements State.

Definition at line 185 of file AIDock.h.

onEnter()

StateReturnType AIDockProcessDockState::onEnter ( void )

virtual

executed once when entering state

Reimplemented from State.

Definition at line 591 of file AIDock.cpp.

onExit()

void AIDockProcessDockState::onExit ( StateExitType status )

virtual

executed once when leaving state

Reimplemented from State.

Definition at line 694 of file AIDock.cpp.

setNextDockActionFrame()

void AIDockProcessDockState::setNextDockActionFrame

(

)

Definition at line 575 of file AIDock.cpp.

update()

StateReturnType AIDockProcessDockState::update ( void )

virtual

We are now docked. Invoke the dock's action() method until it returns false.

Implements State.

Definition at line 613 of file AIDock.cpp.

xfer()

virtual void AIDockProcessDockState::xfer ( Xfer * xfer )

inlineprotectedvirtual

run save, load, or deep CRC check on this data structure, the type depends on the setup of the Xfer pointer

Implements State.

Definition at line 184 of file AIDock.h.

Member Data Documentation

m_nextDockActionFrame

UnsignedInt AIDockProcessDockState::m_nextDockActionFrame

Definition at line 177 of file AIDock.h.

---

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

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