AI_State Class Reference
[InExIn]
#include <AI_State.h>
Detailed Description
One generic state of state machine.This is an abstract class for a state. Derive this class to create your own proprietary states. Implement pure virtual method state. If state is final then override also isInterrupt() method.
- Version:
- 1.0 Initial release.
Public Member Functions | |
| AI_State (void) | |
| Constructor. | |
| AI_State (const int i_state_out) | |
| Constructor for states with only output state. | |
| AI_State (const int i_state_true, const int i_state_false) | |
| Constructor for states with condition and two output states. | |
| virtual | ~AI_State (void) |
| Destructor. | |
| virtual ai_index | step (AI_StateMachine::Session *ptr_session)=0 |
| virtual bool | isInterrupt (void) const |
| Return false (state is non-final by default). | |
Protected Attributes | |
| ai_index | m_i_true_state |
| State index in the state machine. | |
| ai_index | m_i_false_state |
| State index in the state machine (returned when tested condition is false). | |
Constructor & Destructor Documentation
| AI_State::AI_State | ( | void | ) | [inline] |
Constructor.
| AI_State::AI_State | ( | const int | i_state_out | ) | [inline] |
Constructor for states with only output state.
| AI_State::AI_State | ( | const int | i_state_true, | |
| const int | i_state_false | |||
| ) | [inline] |
Constructor for states with condition and two output states.
| AI_State::~AI_State | ( | void | ) | [inline, virtual] |
Destructor.
Member Function Documentation
| virtual ai_index AI_State::step | ( | AI_StateMachine::Session * | ptr_session | ) | [pure virtual] |
Implemented in AI_Actor::StateAct, AI_Actor::StateStop, AI_Actor::StateChase, AI_Actor::StateAttack, AI_Actor::StateWander, AI_Actor::StateIsSee, AI_Actor::StateIsHear, AI_Actor::StateIsAccessible, AI_Actor::StateIsTouch, AI_Actor::StateIsInOptimum, AI_Actor::StateIsFeedback, AI_Actor::StateIsInRange, AI_Actor::StateIsAct, AI_Actor::StateTimePlan, and AI_Actor::StateIsTimePlan.
| bool AI_State::isInterrupt | ( | void | ) | const [inline, virtual] |
Return false (state is non-final by default).
Reimplemented in AI_Actor::StateAct, AI_Actor::StateStop, AI_Actor::StateChase, AI_Actor::StateAttack, AI_Actor::StateWander, AI_Actor::StateIsSee, AI_Actor::StateIsHear, AI_Actor::StateIsAccessible, AI_Actor::StateIsTouch, AI_Actor::StateIsInOptimum, AI_Actor::StateIsFeedback, AI_Actor::StateIsInRange, AI_Actor::StateIsAct, AI_Actor::StateTimePlan, and AI_Actor::StateIsTimePlan.
Member Data Documentation
ai_index AI_State::m_i_true_state [protected] |
State index in the state machine.
ai_index AI_State::m_i_false_state [protected] |
State index in the state machine (returned when tested condition is false).
The documentation for this class was generated from the following file: