limboai/hsm/limbo_state.h

102 lines
2.9 KiB
C
Raw Permalink Normal View History

/**
* limbo_state.h
* =============================================================================
* Copyright 2021-2024 Serhii Snitsaruk
*
* Use of this source code is governed by an MIT-style
* license that can be found in the LICENSE file or at
* https://opensource.org/licenses/MIT.
* =============================================================================
*/
2022-09-28 10:48:45 +00:00
#ifndef LIMBO_STATE_H
#define LIMBO_STATE_H
2024-01-07 04:54:17 +00:00
#include "../blackboard/blackboard.h"
#include "../blackboard/blackboard_plan.h"
2023-07-20 16:35:36 +00:00
#include "../util/limbo_compat.h"
2024-01-07 04:54:17 +00:00
#include "../util/limbo_string_names.h"
#ifdef LIMBOAI_MODULE
2022-09-28 10:48:45 +00:00
#include "scene/main/node.h"
2024-01-07 04:54:17 +00:00
#endif // LIMBOAI_MODULE
#ifdef LIMBOAI_GDEXTENSION
#include <godot_cpp/core/gdvirtual.gen.inc>
2024-01-07 04:54:17 +00:00
#include <godot_cpp/templates/hash_map.hpp>
#endif // LIMBOAI_GDEXTENSION
2022-09-28 10:48:45 +00:00
2022-09-29 10:54:07 +00:00
class LimboHSM;
2022-09-28 10:48:45 +00:00
class LimboState : public Node {
GDCLASS(LimboState, Node);
private:
bool active;
Ref<BlackboardPlan> blackboard_plan;
2022-12-16 10:56:41 +00:00
Node *agent;
2022-09-28 10:48:45 +00:00
Ref<Blackboard> blackboard;
HashMap<StringName, Callable> handlers;
2022-12-16 10:56:41 +00:00
Callable guard_callable;
2022-09-28 10:48:45 +00:00
Ref<BlackboardPlan> _get_parent_scope_plan() const;
2022-09-28 10:48:45 +00:00
protected:
2022-09-29 10:54:07 +00:00
friend LimboHSM;
2022-12-16 10:56:41 +00:00
2022-09-28 10:48:45 +00:00
static void _bind_methods();
void _notification(int p_what);
2022-12-16 10:56:41 +00:00
virtual void _initialize(Node *p_agent, const Ref<Blackboard> &p_blackboard);
virtual bool _dispatch(const StringName &p_event, const Variant &p_cargo = Variant());
virtual bool _should_use_new_scope() const { return blackboard_plan.is_valid() || is_root(); }
2024-03-11 17:58:40 +00:00
virtual void _update_blackboard_plan();
virtual Node *_get_prefetch_root_for_base_plan();
2022-09-28 10:48:45 +00:00
virtual void _setup();
virtual void _enter();
virtual void _exit();
virtual void _update(double p_delta);
2022-09-28 10:48:45 +00:00
GDVIRTUAL0(_setup);
GDVIRTUAL0(_enter);
GDVIRTUAL0(_exit);
GDVIRTUAL1(_update, double);
#ifdef LIMBOAI_GDEXTENSION
String _to_string() const { return String(get_name()) + ":<" + get_class() + "#" + itos(get_instance_id()) + ">"; }
#endif
2022-09-28 10:48:45 +00:00
public:
2024-03-11 17:58:40 +00:00
void set_blackboard_plan(const Ref<BlackboardPlan> &p_plan);
_FORCE_INLINE_ Ref<BlackboardPlan> get_blackboard_plan() const { return blackboard_plan; }
2022-10-19 21:39:27 +00:00
Ref<Blackboard> get_blackboard() const { return blackboard; }
2022-10-26 21:12:29 +00:00
2022-12-16 10:56:41 +00:00
Node *get_agent() const { return agent; }
void set_agent(Node *p_agent) { agent = p_agent; }
2022-10-19 21:39:27 +00:00
LimboState *named(const String &p_name);
LimboState *call_on_enter(const Callable &p_callable);
LimboState *call_on_exit(const Callable &p_callable);
LimboState *call_on_update(const Callable &p_callable);
2022-09-28 10:48:45 +00:00
void add_event_handler(const StringName &p_event, const Callable &p_handler);
bool dispatch(const StringName &p_event, const Variant &p_cargo = Variant());
_FORCE_INLINE_ StringName event_finished() const { return LW_NAME(EVENT_FINISHED); }
2022-09-28 10:48:45 +00:00
LimboState *get_root() const;
_FORCE_INLINE_ bool is_root() const { return !(get_parent() && IS_CLASS(get_parent(), LimboState)); }
_FORCE_INLINE_ bool is_active() const { return active; }
2022-09-29 20:44:51 +00:00
2022-12-16 10:56:41 +00:00
void set_guard(const Callable &p_guard_callable);
void clear_guard();
2022-09-28 10:48:45 +00:00
LimboState();
};
2024-01-13 16:10:42 +00:00
#endif // LIMBO_STATE_H