limboai/bt/bt_player.h

/**
 * bt_player.h
 * =============================================================================
 * Copyright 2021-2023 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 BT_PLAYER_H
#define BT_PLAYER_H

#include "scene/main/node.h"

#include "behavior_tree.h"
#include "modules/limboai/blackboard/blackboard.h"
#include "tasks/bt_task.h"

class BTPlayer : public Node {
	GDCLASS(BTPlayer, Node);

public:
	enum UpdateMode : unsigned int {
		IDLE, // automatically call update() during NOTIFICATION_PROCESS
		PHYSICS, //# automatically call update() during NOTIFICATION_PHYSICS
		MANUAL, // manually update state machine, user must call update(delta)
	};

private:
	Ref<BehaviorTree> behavior_tree;
	UpdateMode update_mode = UpdateMode::PHYSICS;
	bool active = true;
	Ref<Blackboard> blackboard;
	bool prefetch_nodepath_vars = true;
	int last_status = -1;

	Ref<BTTask> tree_instance;

	void _load_tree();

protected:
	static void _bind_methods();

	void _set_blackboard_data(Dictionary p_value) { blackboard->set_data(p_value.duplicate()); }
	Dictionary _get_blackboard_data() const { return blackboard->get_data(); }

	void _notification(int p_notification);

public:
	void set_behavior_tree(const Ref<BehaviorTree> &p_tree);
	Ref<BehaviorTree> get_behavior_tree() const { return behavior_tree; };

	void set_update_mode(UpdateMode p_mode);
	UpdateMode get_update_mode() const { return update_mode; }

	void set_active(bool p_active);
	bool get_active() const { return active; }

	Ref<Blackboard> get_blackboard() const { return blackboard; }
	void set_blackboard(const Ref<Blackboard> &p_blackboard) { blackboard = p_blackboard; }

	void set_prefetch_nodepath_vars(bool p_value) { prefetch_nodepath_vars = p_value; }
	bool get_prefetch_nodepath_vars() const { return prefetch_nodepath_vars; }

	void update(double p_delta);
	void restart();
	int get_last_status() const { return last_status; }

	BTPlayer();
	~BTPlayer();

#ifdef DEBUG_ENABLED
	// Performace monitoring.
private:
	bool monitor_performance = false;
	StringName monitor_id;
	double update_time_acc = 0.0;
	double update_time_n = 0.0;

	void _set_monitor_performance(bool p_monitor_performance);
	bool _get_monitor_performance() const { return monitor_performance; }
	double _get_mean_update_time_msec();

#endif // DEBUG_ENABLED
};

#endif // BT_PLAYER_H