NSMBW-Decomp
A decompilation of New Super Mario Bros. Wii
Loading...
Searching...
No Matches
Public Member Functions
sStateMethodUsr_FI_c Class Reference
By Library » Game-specific » sLib » sState

#include <dol/sLib/s_StateMethodUsr_FI.hpp>

Inheritance diagram for sStateMethodUsr_FI_c:
[legend]

Description

An extension to sStateMethod_c that implements the remaining abstract methods.

[Name might mean "Functionality implementation"].

Definition at line 7 of file s_StateMethodUsr_FI.hpp.

Public Member Functions

 sStateMethodUsr_FI_c (sStateIDChkIf_c &checker, sStateFctIf_c &factory, const sStateIDIf_c &initialState)
 
virtual int initializeStateLocalMethod ()
 Performs the actual state initialization.
 
virtual void executeStateLocalMethod ()
 Performs the actual state execution.
 
virtual void finalizeStateLocalMethod ()
 Performs the actual state termination.
 
virtual void changeStateLocalMethod (const sStateIDIf_c &newStateID)
 Performs the actual state transition.
 
- Public Member Functions inherited from sStateMethod_c
 sStateMethod_c (sStateIDChkIf_c &checker, sStateFctIf_c &factory, const sStateIDIf_c &initialState)
 Constructs a new sStateMethod_c instance.
 
virtual ~sStateMethod_c ()
 Destroys the sStateMethod_c instance.
 
virtual void initializeStateMethod ()
 Initializes the current state.
 
virtual void executeStateMethod ()
 Executes the current state.
 
virtual void finalizeStateMethod ()
 Prepares the current state for termination.
 
virtual void changeStateMethod (const sStateIDIf_c &newStateID)
 Transitions to a new state ID.
 
virtual void refreshStateMethod ()
 Marks the current state to be executed again.
 
virtual sStateIf_c * getState () const
 Gets the state holder.
 
virtual const sStateIDIf_c * getNewStateID () const
 Gets the next state ID.
 
virtual const sStateIDIf_c * getStateID () const
 Gets the current state ID.
 
virtual const sStateIDIf_c * getOldStateID () const
 Gets the previous state ID.
 
virtual int initializeStateLocalMethod ()=0
 Performs the actual state initialization.
 
virtual void executeStateLocalMethod ()=0
 Performs the actual state execution.
 
virtual void finalizeStateLocalMethod ()=0
 Performs the actual state termination.
 
virtual void changeStateLocalMethod (const sStateIDIf_c &newStateID)=0
 Performs the actual state transition.
 

Additional Inherited Members

- Protected Attributes inherited from sStateMethod_c
sStateIDChkIf_c & mpStateChk
 [Unused]. The state checker to use.
 
sStateFctIf_c & mpStateFct
 The state factory which produces the state holder.
 
bool mInitFinalizeLock
 A lock to ensure initializeStateMethod and finalizeStateMethod are not called recursively.
 
bool mExecutionLock
 A lock to ensure executeStateMethod is not called recursively.
 
bool mIsValid
 If the state holder contains a valid state ID.
 
bool mStateChanged
 If the current state has changed during execution.
 
bool mRefreshStateMethod
 True, if after a state transition, the state should be executed again.
 
const sStateIDIf_c * mpNewStateID
 The next state ID.
 
const sStateIDIf_c * mpOldStateID
 The previous state ID.
 
const sStateIDIf_c * mpStateID
 The current state ID.
 
sStateIf_c * mpState
 The current state holder.
 

Constructor & Destructor Documentation

◆ sStateMethodUsr_FI_c()

sStateMethodUsr_FI_c::sStateMethodUsr_FI_c ( sStateIDChkIf_c &  checker,
sStateFctIf_c &  factory,
const sStateIDIf_c &  initialState 
)

Definition at line 4 of file s_StateMethodUsr_FI.cpp.

◆ ~sStateMethodUsr_FI_c()

virtual sStateMethodUsr_FI_c::~sStateMethodUsr_FI_c ( )
inlinevirtual

Definition at line 10 of file s_StateMethodUsr_FI.hpp.

Member Function Documentation

◆ initializeStateLocalMethod()

int sStateMethodUsr_FI_c::initializeStateLocalMethod ( )
virtual

Performs the actual state initialization.

Implements sStateMethod_c.

Definition at line 8 of file s_StateMethodUsr_FI.cpp.

◆ executeStateLocalMethod()

void sStateMethodUsr_FI_c::executeStateLocalMethod ( )
virtual

Performs the actual state execution.

Implements sStateMethod_c.

Definition at line 14 of file s_StateMethodUsr_FI.cpp.

◆ finalizeStateLocalMethod()

void sStateMethodUsr_FI_c::finalizeStateLocalMethod ( )
virtual

Performs the actual state termination.

Implements sStateMethod_c.

Definition at line 19 of file s_StateMethodUsr_FI.cpp.

◆ changeStateLocalMethod()

void sStateMethodUsr_FI_c::changeStateLocalMethod ( const sStateIDIf_c &  newStateID)
virtual

Performs the actual state transition.

Implements sStateMethod_c.

Definition at line 24 of file s_StateMethodUsr_FI.cpp.