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

#include <AIStateMachine.h>

Inherits AIInternalMoveToState.

Inherited by AIGuardPickUpCrateState, AIGuardRetaliatePickUpCrateState, and AITNGuardPickUpCrateState.

Public Member Functions

 AIPickUpCrateState (StateMachine *machine)
 
virtual StateReturnType onEnter ()
 
virtual void onExit (StateExitType status)
 
virtual StateReturnType update ()
 
- 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
 
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 Bool computePath ()
 compute the path
 
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 Coord3DgetGoalPos () const
 
void forceRepath ()
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPoolgetObjectMemoryPool ()=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

Pick up an upgrade crate after a kill.

Definition at line 546 of file AIStateMachine.h.

Constructor & Destructor Documentation

◆ AIPickUpCrateState()

AIPickUpCrateState::AIPickUpCrateState ( StateMachine * machine)
inline

Definition at line 550 of file AIStateMachine.h.

Member Function Documentation

◆ computePath()

Bool AIPickUpCrateState::computePath ( )
protectedvirtual

compute the path

Reimplemented from AIInternalMoveToState.

Definition at line 3136 of file AIStates.cpp.

◆ crc()

void AIPickUpCrateState::crc ( Xfer * xfer)
protectedvirtual

CRC

Reimplemented from AIInternalMoveToState.

Definition at line 3144 of file AIStates.cpp.

◆ loadPostProcess()

void AIPickUpCrateState::loadPostProcess ( void )
protectedvirtual

Load post process

Reimplemented from AIInternalMoveToState.

Definition at line 3170 of file AIStates.cpp.

◆ onEnter()

StateReturnType AIPickUpCrateState::onEnter ( void )
virtual

We are initiating a moveTo action. Pathfind from m_goalPosition to goal.

Reimplemented from AIInternalMoveToState.

Reimplemented in AIGuardPickUpCrateState, AIGuardRetaliatePickUpCrateState, and AITNGuardPickUpCrateState.

Definition at line 3177 of file AIStates.cpp.

◆ onExit()

void AIPickUpCrateState::onExit ( StateExitType status)
virtual

We are leaving the moveTo state.

Reimplemented from AIInternalMoveToState.

Reimplemented in AIGuardPickUpCrateState, AIGuardRetaliatePickUpCrateState, and AITNGuardPickUpCrateState.

Definition at line 3191 of file AIStates.cpp.

◆ update()

StateReturnType AIPickUpCrateState::update ( void )
virtual

Execute the moveTo behavior towards GoalPosition.

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

Reimplemented from AIInternalMoveToState.

Reimplemented in AIGuardPickUpCrateState, AIGuardRetaliatePickUpCrateState, and AITNGuardPickUpCrateState.

Definition at line 3198 of file AIStates.cpp.

◆ xfer()

void AIPickUpCrateState::xfer ( Xfer * xfer)
protectedvirtual

Xfer Method

Reimplemented from AIInternalMoveToState.

Definition at line 3152 of file AIStates.cpp.


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