Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
DozerActionState Class Reference

Inherits State.

Public Member Functions

 DozerActionState (StateMachine *machine, DozerTask task)
 
virtual StateReturnType update (void)
 implements this state's behavior, decides when to change state
 
virtual StateReturnType onEnter (void)
 executed once when entering state
 
virtual void onExit (StateExitType status)
 executed once when leaving 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
 
StateMachinegetMachine ()
 return the machine this state is part of
 
StateID getID () const
 get this state's id
 
ObjectgetMachineOwner ()
 
const ObjectgetMachineOwner () const
 
ObjectgetMachineGoalObject ()
 return the machine this state is part of
 
const ObjectgetMachineGoalObject () const
 return the machine this state is part of
 
const Coord3DgetMachineGoalPosition () 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 MemoryPoolgetObjectMemoryPool ()=0
 

Protected Attributes

DozerTask m_task
 
StateMachinem_actionMachine
 

Detailed Description

Dozer action state

Definition at line 1153 of file DozerAIUpdate.cpp.

Constructor & Destructor Documentation

◆ DozerActionState()

DozerActionState::DozerActionState ( StateMachine * machine,
DozerTask task )
inline

Definition at line 1159 of file DozerAIUpdate.cpp.

Member Function Documentation

◆ crc()

void DozerActionState::crc ( Xfer * xfer)
protectedvirtual

CRC

Implements State.

Definition at line 1191 of file DozerAIUpdate.cpp.

◆ loadPostProcess()

void DozerActionState::loadPostProcess ( void )
protectedvirtual

Load post process

Implements State.

Definition at line 1212 of file DozerAIUpdate.cpp.

◆ onEnter()

StateReturnType DozerActionState::onEnter ( void )
virtual

executed once when entering state

Reimplemented from State.

Definition at line 1219 of file DozerAIUpdate.cpp.

◆ onExit()

void DozerActionState::onExit ( StateExitType status)
virtual

executed once when leaving state

Reimplemented from State.

Definition at line 1245 of file DozerAIUpdate.cpp.

◆ update()

virtual StateReturnType DozerActionState::update ( void )
inlinevirtual

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

Implements State.

Definition at line 1169 of file DozerAIUpdate.cpp.

◆ xfer()

void DozerActionState::xfer ( Xfer * xfer)
protectedvirtual

Xfer Method

Implements State.

Definition at line 1198 of file DozerAIUpdate.cpp.

Member Data Documentation

◆ m_actionMachine

StateMachine* DozerActionState::m_actionMachine
protected

Definition at line 1183 of file DozerAIUpdate.cpp.

◆ m_task

DozerTask DozerActionState::m_task
protected

Definition at line 1182 of file DozerAIUpdate.cpp.


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