Proyecto-Titulo/alai
2
0
Fork 0
Code Issues Pull Requests Releases 2 Wiki Activity

add documentation

Browse Source
This commit is contained in:
Chris Cromer
2022-04-13 00:59:23 -04:00
parent 219b277e5c
commit 1c24ba0cd1
12 changed files with 529 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/state_machine/State.cpp
View File

@@ -1,4 +1,4 @@
#include "State.h"
#include "state_machine/State.h"
using namespace godot;

60
src/state_machine/State.h
View File

@@ -8,37 +8,95 @@
namespace godot
{
/**
* @brief This class provides a virtual template state that real states should extend from and override.
*
*/
class State : public StateMachine
{
GODOT_CLASS(State, Node)
private:
/**
* @brief The state's parent, this is the node 1 level above the state machine.
*
*/
Node *parent;
/**
* @brief The state machine itself, used to handle all state related work.
*
*/
StateMachine *state_machine;
public:
Node *parent;
/**
* @brief This method registers classes with Godot.
*
* @details This method registers methods, properties, and signals with the Godot engine.
*/
static void _register_methods();
/**
* @brief Construct a new State object.
*
*/
State();
/**
* @brief Destroy the State object.
*
*/
~State();
/**
* @brief Initialize the class from Godot.
*
* @details This method is called just once when the Godot engine connects to the instance of the class.
*/
virtual void _init();
/**
* @brief This is called when a state is entered.
*
* @param[in] state This will contain the previous state.
* @param[in] args The arguments passed to the state.
*/
virtual void _state_enter(const String state, const Array args = Array());
/**
* @brief This is called when a state is exited.
*
* @param[in] state The state we are going to.
* @param[in] args The arguments passed to the state.
*/
virtual void _state_exit(const String state, const Array args = Array());
/**
* @brief Set the parent object.
*
* @param[in] parent The parent of the state.
*/
virtual void set_parent(Node *parent) final;
/**
* @brief Get the parent object.
*
* @return Node* The parent of the state.
*/
virtual Node *get_parent() final;
/**
* @brief Set the state machine object.
*
* @param[in] state_machine The state machine.
*/
virtual void set_state_machine(StateMachine *state_machine) final;
/**
* @brief Get the state machine object.
*
* @return StateMachine* The state machine.
*/
virtual StateMachine *get_state_machine() final;
};
}

4
src/state_machine/StateMachine.cpp
View File

@@ -1,5 +1,5 @@
#include "StateMachine.h"
#include "State.h"
#include "state_machine/StateMachine.h"
#include "state_machine/State.h"
using namespace godot;

203
src/state_machine/StateMachine.h
View File

@@ -6,89 +6,250 @@
namespace godot
{
/**
* @brief This class provides a finite state machine that can be used with any scene and node.
*
*/
class StateMachine : public Node
{
GODOT_CLASS(StateMachine, Node)
private:
/**
* @brief The parent node which is one level above the state machine.
*
*/
Node *parent;
/**
* @brief The default state for the state machine to run.
*
* @details If this is not set, the state machine will try to run the first state node.
* If no state nodes are present, an error will be printed and the state machine will not work.
*/
String default_state;
/**
* @brief If set to true the state machine will print a message showing when it enters or exits a state.
*
*/
bool debug;
/**
* @brief The current state the machine is in.
*
*/
String current_state;
/**
* @brief A list of the states in the state machine.
*
*/
Dictionary states;
/**
* @brief This adds a state to the list of states in the state machine.
*
* @param[in] state The new state.
* @param[in] child The godot node which represents the state.
*/
void add_state(const String state, Node *child);
public:
/**
* @brief This method registers classes with Godot.
*
* @details This method registers methods, properties, and signals with the Godot engine.
*/
static void _register_methods();
/**
* @brief Construct a new State Machine object.
*/
StateMachine();
/**
* @brief Destroy the State Machine object.
*/
~StateMachine();
/**
* @brief Initialize the class from Godot.
*
* @details This method is called just once when the Godot engine connects to the instance of the class.
*/
void _init();
/**
* @brief Code to be run when ready.
*
* @details This method is run when all the children of this node are ready.
*/
void _ready();
/**
* @brief This method will remove all no default states from the scene tree and start the default state.
*
*/
void setup();
bool is_current();
/**
* @brief Check if the given state is the current running state.
*
* @param[in] state The state to compare with the running state.
* @return true If the running state and given state are the same.
* @return false If the running state and given state are not the same.
*/
bool is_current(const String state);
/**
* @brief Check if the state machine has a given state.
*
* @param[in] state The state to check for.
* @return true If the state exists.
* @return false If the state doesn't exist.
*/
bool has(const String state);
/**
* @brief Restar the running state by calling its enter and exit methods.
*
* @param[in] state The state that is being restarted.
* @param[in] args The arguments to pass to the state on exit and enter.
*/
void restart(const String state, const Array& args = Array());
/**
* @brief Change to a different state.
*
* @details If the running state is the same as the state it will restart it.
*
* @param[in] state The state to change to.
* @param[in] args The arguments to pass to the exiting state and the entering state.
*/
void change(const String state, const Array &args = Array());
/**
* @brief Call a registered godot method in the class.
*
* @param[in] method The method name to call.
* @param[in] args The arguments to pass to the method.
* @return Variant Returns a Variant based off what the method returns.
*/
Variant call(const String method, const Array &args = Array());
/**
* @brief This method is to link up a signal call back.
*
* @param[in] method The method to call for the signal.
* @param[in] args The arguments to pass to the method.
* @return Variant Returns a Variant based off what the method returns.
*/
Variant _call(const String method, const Array &args = Array());
template <class ...Args> Variant restart(Args ...args)
/**
* @brief Set the default state object.
*
* @param[in] default_state The new default state.
*/
void set_default_state(const String default_state);
/**
* @brief Get the default state object.
*
* @return String The default state.
*/
String get_default_state();
/**
* @brief Set the debug object.
*
* @param[in] debug Whether or not to debug.
*/
void set_debug(bool debug);
/**
* @brief Get the debug object.
*
* @return true If debugging is enabled.
* @return false If debugging is disabled.
*/
bool get_debug();
/**
* @brief Set the current state object.
*
* @param[in] current_state The current state that is running.
*/
void set_current_state(const String current_state);
/**
* @brief Get the current state object.
*
* @return String The current running state.
*/
String get_current_state();
/**
* @brief This method is called when the signal tree_entered is emitted.
*
* @details This will run the setup method to prepare the state machine for use.
*/
void _on_StateMachine_tree_entered();
/**
* @brief This method is called when the signal tree_exiting is emitted.
*
* @details If the tree is in the exiting state readd all the removed state nodes to the scene tree.
* This is important because the memory won't be freed if they are no longer in the scene tree.
*/
void _on_StateMachine_tree_exiting();
/**
* @brief Restarts the running state.
*
* @tparam Args Variable number of arguments to pass to restart.
* @param[in] state The state being restarted.
* @param[in] args The arguments to pass when restarting.
*/
template <class ...Args> void restart(const String state, Args ...args)
{
return restart(Array::make(args...));
return restart(state, Array::make(args...));
}
template <class ...Args> Variant change(const String state, Args ...args)
/**
* @brief Changes to a new state.
*
* @tparam Args Variable number of arguments to pass when chaning states.
* @param[in] state The state to change to.
* @param[in] args The arguments to pass to the new state.
*/
template <class ...Args> void change(const String state, Args ...args)
{
return change(state, Array::make(args...));
}
/**
* @brief Call a registered godot method in the class.
*
* @tparam Args The variable arguments to pass to the method.
* @param[in] method The method to call.
* @param[in] args The arguments to pass to it.
* @return Variant The Variant object returned by the method called.
*/
template <class ...Args> Variant call(const String method, Args ...args)
{
return call(method, Array::make(args...));
}
/**
* @brief This is used to connect a callback from a signal.
*
* @tparam Args The arguments to pass to the callback method.
* @param[in] method The method to call.
* @param[in] args The arguments to pass.
* @return Variant The Variant object returned by the method called.
*/
template <class ...Args> Variant _call(const String method, Args ...args)
{
return _call(method, Array::make(args...));
}
void set_default_state(const String default_state);
String get_default_state();
void set_debug(bool debug);
bool get_debug();
void set_current_state(const String current_state);
String get_current_state();
void _on_StateMachine_tree_entered();
void _on_StateMachine_tree_exiting();
};
}