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 | List of all members
AIDockApproachState Class Reference

#include <AIDock.h>

Inherits AIInternalMoveToState.

Public Member Functions

 AIDockApproachState (StateMachine *machine)
 
virtual StateReturnType onEnter (void)
 
virtual void onExit (StateExitType status)
 
virtual StateReturnType update (void)
 
- Public Member Functions inherited from AIInternalMoveToState
 AIInternalMoveToState (StateMachine *machine, AsciiString name)
 
- 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 AIInternalMoveToState
void setAdjustsDestination (Bool b)
 
Bool getAdjustsDestination () const
 
void setGoalPos (const Coord3D *pos)
 
const Coord3D * getGoalPos () const
 
virtual Bool computePath ()
 compute the path
 
void forceRepath ()
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPool * getObjectMemoryPool ()=0
 

Additional Inherited Members

- Protected Attributes inherited from AIInternalMoveToState
Coord3D m_goalPosition
 the goal position to move to
 
PathfindLayerEnum m_goalLayer
 The layer we are moving towards.
 
Coord3D m_pathGoalPosition
 the position our current path leads to
 
Bool m_waitingForPath
 If we are waiting for a path.
 
Bool m_tryOneMoreRepath
 If true, after we complete movement do another compute path.
 

Detailed Description

Definition at line 83 of file AIDock.h.

Constructor & Destructor Documentation

◆ AIDockApproachState()

AIDockApproachState::AIDockApproachState ( StateMachine * machine)
inline

Definition at line 87 of file AIDock.h.

Member Function Documentation

◆ crc()

virtual void AIDockApproachState::crc ( Xfer * xfer)
inlineprotectedvirtual

CRC

Reimplemented from AIInternalMoveToState.

Definition at line 93 of file AIDock.h.

◆ loadPostProcess()

virtual void AIDockApproachState::loadPostProcess ( void )
inlineprotectedvirtual

Load post process

Reimplemented from AIInternalMoveToState.

Definition at line 95 of file AIDock.h.

◆ onEnter()

StateReturnType AIDockApproachState::onEnter ( void )
virtual

Approach our waiting spot next to the dock.

Reimplemented from AIInternalMoveToState.

Definition at line 167 of file AIDock.cpp.

◆ onExit()

void AIDockApproachState::onExit ( StateExitType status)
virtual

We are leaving the moveTo state.

Reimplemented from AIInternalMoveToState.

Definition at line 219 of file AIDock.cpp.

◆ update()

StateReturnType AIDockApproachState::update ( void )
virtual

Execute the moveTo behavior towards GoalPosition.

Todo
srj – find a way to sleep for a number of frames here, if possible

Reimplemented from AIInternalMoveToState.

Definition at line 206 of file AIDock.cpp.

◆ xfer()

void AIDockApproachState::xfer ( Xfer * xfer)
protectedvirtual

Xfer Method

Reimplemented from AIInternalMoveToState.

Definition at line 150 of file AIDock.cpp.

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