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 | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
AIDockMachine Class Reference

#include <AIDock.h>

Inherits StateMachine.

Public Member Functions

 AIDockMachine (Object *owner)
 
virtual void halt (void)
 Stops the state machine & disables it in preparation for deleting it.
 
- Public Member Functions inherited from StateMachine
 StateMachine (Object *owner, AsciiString name)
 
virtual StateReturnType updateStateMachine ()
 run one step of the machine
 
virtual void clear ()
 clear the machine's internals to a known, initialized state
 
virtual StateReturnType resetToDefaultState ()
 clear the machine's internals and set to the default state
 
virtual StateReturnType initDefaultState ()
 
virtual StateReturnType setState (StateID newStateID)
 change the current state of the machine (which may cause further state changes, due to onEnter)
 
StateID getCurrentStateID () const
 return the id of the current state of the machine
 
Bool isInIdleState () const
 
Bool isInAttackState () const
 
Bool isInForceAttackState () const
 
Bool isInGuardIdleState () const
 
Bool isInBusyState () const
 
void lock (const char *msg)
 
void unlock ()
 
Bool isLocked () const
 
Object * getOwner ()
 
const Object * getOwner () const
 
void setGoalObject (const Object *obj)
 
Object * getGoalObject ()
 
const Object * getGoalObject () const
 
void setGoalPosition (const Coord3D *pos)
 
const Coord3D * getGoalPosition () const
 
Bool isGoalObjectDestroyed () const
 Returns true if we had a goal object, but it has been destroyed.
 
StateReturnType internalSetState (StateID newStateID)
 for internal use only - change the current state of the machine
 
Bool getWantsDebugOutput () const
 
AsciiString getCurrentStateName () const
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 
- Public Member Functions inherited from Snapshot
 Snapshot (void)
 
 ~Snapshot (void)
 

Static Public Member Functions

static Bool ableToAdvance (State *thisState, void *userData)
 

Public Attributes

Int m_approachPosition
 The Approach Position I am holding, to make scoot forward checks quicker.
 

Protected Member Functions

virtual void crc (Xfer *xfer)
 
virtual void xfer (Xfer *xfer)
 
virtual void loadPostProcess ()
 
- Protected Member Functions inherited from StateMachine
void defineState (StateID id, State *state, StateID successID, StateID failureID, const StateConditionInfo *conditions=NULL)
 
State * internalGetState (StateID id)
 
- 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

The docking state machine.

Definition at line 56 of file AIDock.h.

Constructor & Destructor Documentation

◆ AIDockMachine()

AIDockMachine::AIDockMachine ( Object * obj)

The implementation of this constructor defines the states used by this machine.

Create an AI state machine. Define all of the states the machine can possibly be in, and set the initial (default) state.

Definition at line 44 of file AIDock.cpp.

Member Function Documentation

◆ ableToAdvance()

Bool AIDockMachine::ableToAdvance ( State * thisState,
void * userData )
static

Definition at line 120 of file AIDock.cpp.

◆ crc()

void AIDockMachine::crc ( Xfer * xfer)
protectedvirtual

CRC

Reimplemented from StateMachine.

Definition at line 92 of file AIDock.cpp.

◆ halt()

void AIDockMachine::halt ( void )
virtual

Stops the state machine & disables it in preparation for deleting it.

Reimplemented from StateMachine.

Definition at line 70 of file AIDock.cpp.

◆ loadPostProcess()

void AIDockMachine::loadPostProcess ( void )
protectedvirtual

Load post process

Reimplemented from StateMachine.

Definition at line 113 of file AIDock.cpp.

◆ xfer()

void AIDockMachine::xfer ( Xfer * xfer)
protectedvirtual

Xfer Method

Reimplemented from StateMachine.

Definition at line 100 of file AIDock.cpp.

Member Data Documentation

◆ m_approachPosition

Int AIDockMachine::m_approachPosition

The Approach Position I am holding, to make scoot forward checks quicker.

Definition at line 70 of file AIDock.h.

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