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
SuccessState Class Reference

#include <StateMachine.h>

Inherits State.

Public Member Functions

 SuccessState (StateMachine *machine)
 
virtual StateReturnType onEnter ()
 executed once when entering state
 
virtual StateReturnType update ()
 implements this state's behavior, decides when to change state
 
- Public Member Functions inherited from State
 State (StateMachine *machine, AsciiString name)
 < this abstract class needs memory pool hooks
 
virtual void onExit (StateExitType status)
 executed once when leaving state
 
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)
 run the "light" crc check on this data structure
 
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 MemoryPool * getObjectMemoryPool ()=0
 

Detailed Description

A utility state that immediately succeeds.

Definition at line 402 of file StateMachine.h.

Constructor & Destructor Documentation

◆ SuccessState()

SuccessState::SuccessState ( StateMachine * machine)
inline

Definition at line 406 of file StateMachine.h.

Member Function Documentation

◆ crc()

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

run the "light" crc check on this data structure

Implements State.

Definition at line 411 of file StateMachine.h.

◆ loadPostProcess()

virtual void SuccessState::loadPostProcess ( )
inlineprotectedvirtual

post process phase for loading save games. All save systems have their xfer run using XferLoad mode, and then all systems each have their post process run

Implements State.

Definition at line 413 of file StateMachine.h.

◆ onEnter()

virtual StateReturnType SuccessState::onEnter ( void )
inlinevirtual

executed once when entering state

Reimplemented from State.

Definition at line 407 of file StateMachine.h.

◆ update()

virtual StateReturnType SuccessState::update ( )
inlinevirtual

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

Implements State.

Definition at line 408 of file StateMachine.h.

◆ xfer()

virtual void SuccessState::xfer ( Xfer * xfer)
inlineprotectedvirtual

run save, load, or deep CRC check on this data structure, the type depends on the setup of the Xfer pointer

Implements State.

Definition at line 412 of file StateMachine.h.

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