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

#include <AIGuard.h>

Inherits State.

Public Member Functions

 AIGuardInnerState (StateMachine *machine)
 
virtual Bool isAttack () const
 
virtual StateReturnType onEnter (void)
 executed once when entering state
 
virtual StateReturnType update (void)
 implements this state's behavior, decides when to change 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 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
 

Detailed Description

Definition at line 139 of file AIGuard.h.

Constructor & Destructor Documentation

◆ AIGuardInnerState()

AIGuardInnerState::AIGuardInnerState ( StateMachine * machine)
inline

Definition at line 143 of file AIGuard.h.

Member Function Documentation

◆ crc()

void AIGuardInnerState::crc ( Xfer * xfer)
protectedvirtual

CRC

Implements State.

Definition at line 361 of file AIGuard.cpp.

◆ isAttack()

virtual Bool AIGuardInnerState::isAttack ( ) const
inlinevirtual

Reimplemented from State.

Definition at line 148 of file AIGuard.h.

◆ loadPostProcess()

void AIGuardInnerState::loadPostProcess ( void )
protectedvirtual

Load post process

Implements State.

Definition at line 380 of file AIGuard.cpp.

◆ onEnter()

StateReturnType AIGuardInnerState::onEnter ( void )
virtual

executed once when entering state

Reimplemented from State.

Definition at line 386 of file AIGuard.cpp.

◆ onExit()

void AIGuardInnerState::onExit ( StateExitType status)
virtual

executed once when leaving state

Reimplemented from State.

Definition at line 459 of file AIGuard.cpp.

◆ update()

StateReturnType AIGuardInnerState::update ( void )
virtual

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

Implements State.

Definition at line 437 of file AIGuard.cpp.

◆ xfer()

void AIGuardInnerState::xfer ( Xfer * xfer)
protectedvirtual

Xfer Method

Implements State.

Definition at line 368 of file AIGuard.cpp.


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