Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AIFaceState Class Reference

#include <AIStateMachine.h>

Inherits State.

Inherited by JetPauseBeforeTakeoffState.

Public Member Functions

 AIFaceState (StateMachine *machine, Bool obj)
 
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

const Bool m_obj
 
Bool m_canTurnInPlace
 

Detailed Description

Definition at line 1314 of file AIStateMachine.h.

Constructor & Destructor Documentation

◆ AIFaceState()

AIFaceState::AIFaceState ( StateMachine * machine,
Bool obj )
inline

Definition at line 1318 of file AIStateMachine.h.

Member Function Documentation

◆ crc()

void AIFaceState::crc ( Xfer * xfer)
protectedvirtual

CRC

Implements State.

Reimplemented in JetPauseBeforeTakeoffState.

Definition at line 7396 of file AIStates.cpp.

◆ loadPostProcess()

void AIFaceState::loadPostProcess ( void )
protectedvirtual

Load post process

Implements State.

Reimplemented in JetPauseBeforeTakeoffState.

Definition at line 7416 of file AIStates.cpp.

◆ onEnter()

StateReturnType AIFaceState::onEnter ( void )
virtual

executed once when entering state

Reimplemented from State.

Reimplemented in JetPauseBeforeTakeoffState.

Definition at line 7422 of file AIStates.cpp.

◆ onExit()

void AIFaceState::onExit ( StateExitType status)
virtual

executed once when leaving state

Reimplemented from State.

Reimplemented in JetPauseBeforeTakeoffState.

Definition at line 7441 of file AIStates.cpp.

◆ update()

StateReturnType AIFaceState::update ( )
virtual

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

Implements State.

Reimplemented in JetPauseBeforeTakeoffState.

Definition at line 7446 of file AIStates.cpp.

◆ xfer()

void AIFaceState::xfer ( Xfer * xfer)
protectedvirtual

Xfer Method

Implements State.

Reimplemented in JetPauseBeforeTakeoffState.

Definition at line 7403 of file AIStates.cpp.

Member Data Documentation

◆ m_canTurnInPlace

Bool AIFaceState::m_canTurnInPlace
protected

Definition at line 1330 of file AIStateMachine.h.

◆ m_obj

const Bool AIFaceState::m_obj
protected

Definition at line 1329 of file AIStateMachine.h.

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