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

#include <AITNGuard.h>

Inherits StateMachine.

Public Member Functions

 AITNGuardMachine (Object *owner)
 
const Coord3DgetPositionToGuard (void) const
 
void setTargetPositionToGuard (const Coord3D *pos)
 
void setNemesisID (ObjectID id)
 
ObjectID getNemesisID () const
 
GuardMode getGuardMode () const
 
void setGuardMode (GuardMode guardMode)
 
Bool lookForInnerTarget (void)
 
- 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
 
ObjectgetOwner ()
 
const ObjectgetOwner () const
 
void setGoalObject (const Object *obj)
 
ObjectgetGoalObject ()
 
const ObjectgetGoalObject () const
 
void setGoalPosition (const Coord3D *pos)
 
const Coord3DgetGoalPosition () const
 
Bool isGoalObjectDestroyed () const
 Returns true if we had a goal object, but it has been destroyed.
 
virtual void halt (void)
 Stops the state machine & disables it in preparation for deleting it.
 
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 Real getStdGuardRange (const Object *obj)
 

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)
 
StateinternalGetState (StateID id)
 
- 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 82 of file AITNGuard.h.

Constructor & Destructor Documentation

◆ AITNGuardMachine()

AITNGuardMachine::AITNGuardMachine ( Object * owner)

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

Definition at line 150 of file AITNGuard.cpp.

Member Function Documentation

◆ crc()

void AITNGuardMachine::crc ( Xfer * xfer)
protectedvirtual

CRC

Reimplemented from StateMachine.

Definition at line 269 of file AITNGuard.cpp.

◆ getGuardMode()

GuardMode AITNGuardMachine::getGuardMode ( ) const
inline

Definition at line 110 of file AITNGuard.h.

◆ getNemesisID()

ObjectID AITNGuardMachine::getNemesisID ( ) const
inline

Definition at line 108 of file AITNGuard.h.

◆ getPositionToGuard()

const Coord3D * AITNGuardMachine::getPositionToGuard ( void ) const
inline

Definition at line 104 of file AITNGuard.h.

◆ getStdGuardRange()

Real AITNGuardMachine::getStdGuardRange ( const Object * obj)
static

Definition at line 183 of file AITNGuard.cpp.

◆ loadPostProcess()

void AITNGuardMachine::loadPostProcess ( void )
protectedvirtual

Load post process

Reimplemented from StateMachine.

Definition at line 295 of file AITNGuard.cpp.

◆ lookForInnerTarget()

Bool AITNGuardMachine::lookForInnerTarget ( void )

Definition at line 192 of file AITNGuard.cpp.

◆ setGuardMode()

void AITNGuardMachine::setGuardMode ( GuardMode guardMode)
inline

Definition at line 111 of file AITNGuard.h.

◆ setNemesisID()

void AITNGuardMachine::setNemesisID ( ObjectID id)
inline

Definition at line 107 of file AITNGuard.h.

◆ setTargetPositionToGuard()

void AITNGuardMachine::setTargetPositionToGuard ( const Coord3D * pos)
inline

Definition at line 105 of file AITNGuard.h.

◆ xfer()

void AITNGuardMachine::xfer ( Xfer * xfer)
protectedvirtual

Xfer Method

Reimplemented from StateMachine.

Definition at line 276 of file AITNGuard.cpp.


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