94 lines
3.6 KiB
C++
94 lines
3.6 KiB
C++
/**
|
|
* blackboard_plan.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.
|
|
* =============================================================================
|
|
*/
|
|
|
|
#ifndef BLACKBOARD_PLAN_H
|
|
#define BLACKBOARD_PLAN_H
|
|
|
|
#include "bb_variable.h"
|
|
#include "blackboard.h"
|
|
|
|
#ifdef LIMBOAI_MODULE
|
|
#include "core/io/resource.h"
|
|
#endif // LIMBOAI_MODULE
|
|
|
|
#ifdef LIMBOAI_GDEXTENSION
|
|
#include <godot_cpp/classes/resource.hpp>
|
|
using namespace godot;
|
|
#endif // LIMBOAI_GDEXTENSION
|
|
|
|
class BlackboardPlan : public Resource {
|
|
GDCLASS(BlackboardPlan, Resource);
|
|
|
|
private:
|
|
List<Pair<StringName, BBVariable>> var_list;
|
|
HashMap<StringName, BBVariable> var_map;
|
|
|
|
// When base is not null, the plan is considered to be derived from the base plan.
|
|
// A derived plan can only have variables that exist in the base plan,
|
|
// and only the values can be different in those variables.
|
|
Ref<BlackboardPlan> base;
|
|
|
|
// Mapping between variables in this plan and their parent scope names.
|
|
// Used for linking variables to their parent scope counterparts upon Blackboard creation/population.
|
|
HashMap<StringName, StringName> parent_scope_mapping;
|
|
// BlackboardPlan that will be used in parent scope Blackboard creation at runtime.
|
|
// Used to provide hints in the inspector. When set, mapping is enabled in the inspector.
|
|
Ref<BlackboardPlan> parent_scope_plan;
|
|
|
|
// If true, NodePath variables will be prefetched, so that the vars will contain node pointers instead (upon BB creation/population).
|
|
bool prefetch_nodepath_vars = true;
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
|
|
bool _set(const StringName &p_name, const Variant &p_value);
|
|
bool _get(const StringName &p_name, Variant &r_ret) const;
|
|
void _get_property_list(List<PropertyInfo> *p_list) const;
|
|
bool _property_can_revert(const StringName &p_name) const;
|
|
bool _property_get_revert(const StringName &p_name, Variant &r_property) const;
|
|
|
|
public:
|
|
void set_base_plan(const Ref<BlackboardPlan> &p_base);
|
|
Ref<BlackboardPlan> get_base_plan() const { return base; }
|
|
|
|
void set_parent_scope_plan(const Ref<BlackboardPlan> &p_plan);
|
|
Ref<BlackboardPlan> get_parent_scope_plan() const { return parent_scope_plan; }
|
|
bool is_mapping_enabled() const { return parent_scope_plan.is_valid(); }
|
|
bool has_mapping(const StringName &p_name) const;
|
|
|
|
void set_prefetch_nodepath_vars(bool p_enable);
|
|
bool is_prefetching_nodepath_vars() const;
|
|
|
|
void add_var(const StringName &p_name, const BBVariable &p_var);
|
|
void remove_var(const StringName &p_name);
|
|
BBVariable get_var(const StringName &p_name);
|
|
Pair<StringName, BBVariable> get_var_by_index(int p_index);
|
|
_FORCE_INLINE_ bool has_var(const StringName &p_name) { return var_map.has(p_name); }
|
|
_FORCE_INLINE_ bool is_empty() const { return var_map.is_empty(); }
|
|
int get_var_count() const { return var_map.size(); }
|
|
|
|
PackedStringArray list_vars() const;
|
|
StringName get_var_name(const BBVariable &p_var) const;
|
|
bool is_valid_var_name(const StringName &p_name) const;
|
|
void rename_var(const StringName &p_name, const StringName &p_new_name);
|
|
void move_var(int p_index, int p_new_index);
|
|
|
|
void sync_with_base_plan();
|
|
_FORCE_INLINE_ bool is_derived() const { return base.is_valid(); }
|
|
|
|
Ref<Blackboard> create_blackboard(Node *p_agent, const Ref<Blackboard> &p_parent_scope = Ref<Blackboard>());
|
|
void populate_blackboard(const Ref<Blackboard> &p_blackboard, bool overwrite, Node *p_node);
|
|
|
|
BlackboardPlan();
|
|
};
|
|
|
|
#endif // BLACKBOARD_PLAN_H
|