limboai/bt/bt_task.cpp

/* bt_task.cpp */

#include "bt_task.h"

#include "core/class_db.h"
#include "core/error_macros.h"
#include "core/object.h"
#include "core/script_language.h"
#include "core/variant.h"
#include "editor/editor_node.h"
#include "modules/limboai/blackboard.h"
#include "modules/limboai/limbo_string_names.h"
#include "modules/limboai/limbo_utility.h"
#include <cstddef>

String BTTask::_generate_name() const {
	if (get_script_instance()) {
		if (get_script_instance()->has_method(LimboStringNames::get_singleton()->_generate_name)) {
			ERR_FAIL_COND_V_MSG(!get_script_instance()->get_script()->is_tool(), "ERROR: not a tool script", "Task script should be a \"tool\" script!");
			return get_script_instance()->call(LimboStringNames::get_singleton()->_generate_name);
		}
		String name = get_script_instance()->get_script()->get_path();
		if (!name.empty()) {
			// Generate name based on script file
			name = name.get_basename().get_file().trim_prefix("BT");
			return name;
		}
	}
	return get_class().trim_prefix("BT");
}

Array BTTask::_get_children() const {
	Array arr;
	int num_children = get_child_count();
	arr.resize(num_children);
	for (int i = 0; i < num_children; i++) {
		arr[i] = get_child(i).ptr();
	}

	return arr;
}

void BTTask::_set_children(Array p_children) {
	children.clear();
	const int num_children = p_children.size();
	children.resize(num_children);
	for (int i = 0; i < num_children; i++) {
		Variant task_var = p_children[i];
		Ref<BTTask> task_ref = task_var;
		task_ref->parent = this;
		children.set(i, task_var);
	}
}

String BTTask::get_task_name() const {
	if (custom_name.empty()) {
		return _generate_name();
	}
	return custom_name;
}

Ref<BTTask> BTTask::get_root() const {
	const BTTask *task = this;
	while (!task->is_root()) {
		task = task->parent;
	}
	return Ref<BTTask>(task);
}

void BTTask::set_custom_name(const String &p_name) {
	if (custom_name != p_name) {
		custom_name = p_name;
		emit_changed();
	}
};

void BTTask::initialize(Object *p_agent, const Ref<Blackboard> &p_blackboard) {
	ERR_FAIL_COND(p_agent == nullptr);
	ERR_FAIL_COND(p_blackboard == nullptr);
	agent = p_agent;
	blackboard = p_blackboard;
	for (int i = 0; i < children.size(); i++) {
		get_child(i)->initialize(p_agent, p_blackboard);
	}
	if (get_script_instance() &&
			get_script_instance()->has_method(LimboStringNames::get_singleton()->_setup)) {
		get_script_instance()->call(LimboStringNames::get_singleton()->_setup);
	} else {
		_setup();
	}
}

Ref<BTTask> BTTask::clone() const {
	Ref<BTTask> inst = duplicate(false);
	inst->parent = nullptr;
	inst->agent = nullptr;
	inst->blackboard.unref();
	for (int i = 0; i < children.size(); i++) {
		Ref<BTTask> c = get_child(i)->clone();
		c->parent = inst.ptr();
		inst->children.set(i, c);
	}

	// Make BBParam properties unique.
	List<PropertyInfo> props;
	inst->get_property_list(&props);
	Map<RES, RES> duplicates;
	for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {
		if (!(E->get().usage & PROPERTY_USAGE_STORAGE)) {
			continue;
		}

		Variant v = inst->get(E->get().name);

		if (v.is_ref()) {
			REF ref = v;
			if (ref.is_valid()) {
				RES res = ref;
				if (res.is_valid() && res->is_class("BBParam")) {
					if (!duplicates.has(res)) {
						duplicates[res] = res->duplicate();
					}
					res = duplicates[res];
					inst->set(E->get().name, res);
				}
			}
		}
	}

	return inst;
}

int BTTask::execute(float p_delta) {
	if (status != RUNNING) {
		if (get_script_instance() &&
				// get_script_instance()->get_script()->is_valid() &&
				get_script_instance()->has_method(LimboStringNames::get_singleton()->_enter)) {
			get_script_instance()->call(LimboStringNames::get_singleton()->_enter);
		} else {
			_enter();
		}
	}

	if (get_script_instance() &&
			// get_script_instance()->get_script()->is_valid() &&
			get_script_instance()->has_method(LimboStringNames::get_singleton()->_tick)) {
		status = get_script_instance()->call(LimboStringNames::get_singleton()->_tick, Variant(p_delta));
	} else {
		status = _tick(p_delta);
	}

	if (status != RUNNING) {
		if (get_script_instance() &&
				// get_script_instance()->get_script()->is_valid() &&
				get_script_instance()->has_method(LimboStringNames::get_singleton()->_exit)) {
			get_script_instance()->call(LimboStringNames::get_singleton()->_exit);
		} else {
			_exit();
		}
	}
	return status;
}

void BTTask::cancel() {
	for (int i = 0; i < children.size(); i++) {
		get_child(i)->cancel();
	}
	if (status == RUNNING) {
		if (get_script_instance() &&
				// get_script_instance()->get_script()->is_valid() &&
				get_script_instance()->has_method(LimboStringNames::get_singleton()->_exit)) {
			get_script_instance()->call(LimboStringNames::get_singleton()->_exit);
		} else {
			_exit();
		}
	}
	status = FRESH;
}

Ref<BTTask> BTTask::get_child(int p_idx) const {
	ERR_FAIL_INDEX_V(p_idx, children.size(), nullptr);
	return children.get(p_idx);
}

int BTTask::get_child_count() const {
	return children.size();
}

void BTTask::add_child(Ref<BTTask> p_child) {
	ERR_FAIL_COND_MSG(p_child->get_parent().is_valid(), "p_child already has a parent!");
	p_child->parent = this;
	children.push_back(p_child);
	emit_changed();
}

void BTTask::add_child_at_index(Ref<BTTask> p_child, int p_idx) {
	ERR_FAIL_COND_MSG(p_child->get_parent().is_valid(), "p_child already has a parent!");
	if (p_idx < 0 || p_idx > children.size()) {
		p_idx = children.size();
	}
	children.insert(p_idx, p_child);
	p_child->parent = this;
	emit_changed();
}

void BTTask::remove_child(Ref<BTTask> p_child) {
	int idx = children.find(p_child);
	if (idx == -1) {
		ERR_FAIL_MSG("p_child not found!");
	} else {
		children.remove(idx);
		p_child->parent = nullptr;
		emit_changed();
	}
}

void BTTask::remove_child_at_index(int p_idx) {
	ERR_FAIL_INDEX(p_idx, get_child_count());
	children.remove(p_idx);
}

bool BTTask::has_child(const Ref<BTTask> &p_child) const {
	return children.find(p_child) != -1;
}

bool BTTask::is_descendant_of(const Ref<BTTask> &p_task) const {
	const BTTask *task = this;
	while (task != nullptr) {
		task = task->parent;
		if (task == p_task.ptr()) {
			return true;
		}
	}
	return false;
}

int BTTask::get_child_index(const Ref<BTTask> &p_child) const {
	return children.find(p_child);
}

Ref<BTTask> BTTask::next_sibling() const {
	if (parent != nullptr) {
		int idx = parent->get_child_index(Ref<BTTask>(this));
		if (idx != -1 && parent->get_child_count() > (idx + 1)) {
			return parent->get_child(idx + 1);
		}
	}
	return Ref<BTTask>();
}

String BTTask::get_configuration_warning() const {
	String warning = "";
	if (get_script_instance() &&
			get_script_instance()->has_method(LimboStringNames::get_singleton()->_get_configuration_warning)) {
		warning = get_script_instance()->call(LimboStringNames::get_singleton()->_get_configuration_warning);
	}
	return warning;
}

void BTTask::print_tree(int p_initial_tabs) const {
	String tabs = "--";
	for (int i = 0; i < p_initial_tabs; i++) {
		tabs += "--";
	}
	print_line(vformat("%s Name: %s Instance: %s", tabs, get_task_name(), Ref<BTTask>(this)));
	for (int i = 0; i < get_child_count(); i++) {
		get_child(i)->print_tree(p_initial_tabs + 1);
	}
}

void BTTask::_bind_methods() {
	// Properties.
	ClassDB::bind_method(D_METHOD("get_custom_name"), &BTTask::get_custom_name);
	ClassDB::bind_method(D_METHOD("set_custom_name", "p_name"), &BTTask::set_custom_name);

	ClassDB::bind_method(D_METHOD("get_agent"), &BTTask::get_agent);
	ClassDB::bind_method(D_METHOD("set_agent", "p_agent"), &BTTask::set_agent);

	ClassDB::bind_method(D_METHOD("_get_children"), &BTTask::_get_children);
	ClassDB::bind_method(D_METHOD("_set_children", "p_children"), &BTTask::_set_children);

	ClassDB::bind_method(D_METHOD("get_blackboard"), &BTTask::get_blackboard);
	ClassDB::bind_method(D_METHOD("get_parent"), &BTTask::get_parent);
	ClassDB::bind_method(D_METHOD("get_status"), &BTTask::get_status);

	ADD_PROPERTY(PropertyInfo(Variant::STRING, "custom_name"), "set_custom_name", "get_custom_name");
	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "agent", PROPERTY_HINT_RESOURCE_TYPE, "Object", 0), "set_agent", "get_agent");
	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "blackboard", PROPERTY_HINT_RESOURCE_TYPE, "Blackboard", 0), "", "get_blackboard");
	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "parent", PROPERTY_HINT_RESOURCE_TYPE, "BTTask", 0), "", "get_parent");
	ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "children", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR | PROPERTY_USAGE_INTERNAL), "_set_children", "_get_children");
	ADD_PROPERTY(PropertyInfo(Variant::INT, "status", PROPERTY_HINT_NONE, "", 0), "", "get_status");

	// Virtual methods.
	ClassDB::bind_method(D_METHOD("_setup"), &BTTask::_setup);
	BIND_VMETHOD(MethodInfo("_setup"));
	ClassDB::bind_method(D_METHOD("_enter"), &BTTask::_enter);
	BIND_VMETHOD(MethodInfo("_enter"))
	ClassDB::bind_method(D_METHOD("_exit"), &BTTask::_exit);
	BIND_VMETHOD(MethodInfo("_exit"));
	ClassDB::bind_method(D_METHOD("_tick", "p_delta"), &BTTask::_tick);
	BIND_VMETHOD(MethodInfo(Variant::INT, "_tick", PropertyInfo(Variant::REAL, "p_delta")));
	ClassDB::bind_method(D_METHOD("_generate_name"), &BTTask::_generate_name);
	BIND_VMETHOD(MethodInfo(PropertyInfo(Variant::STRING, ""), "_generate_name"));
	ClassDB::bind_method(D_METHOD("_get_configuration_warning"), &BTTask::get_configuration_warning);
	BIND_VMETHOD(MethodInfo(PropertyInfo(Variant::STRING, ""), "_get_configuration_warning"));

	// Public Methods.
	ClassDB::bind_method(D_METHOD("is_root"), &BTTask::is_root);
	ClassDB::bind_method(D_METHOD("get_root"), &BTTask::get_root);
	ClassDB::bind_method(D_METHOD("initialize", "p_agent", "p_blackboard"), &BTTask::initialize);
	ClassDB::bind_method(D_METHOD("clone"), &BTTask::clone);
	ClassDB::bind_method(D_METHOD("execute", "p_delta"), &BTTask::execute);
	ClassDB::bind_method(D_METHOD("get_child", "p_idx"), &BTTask::get_child);
	ClassDB::bind_method(D_METHOD("get_child_count"), &BTTask::get_child_count);
	ClassDB::bind_method(D_METHOD("add_child", "p_child"), &BTTask::add_child);
	ClassDB::bind_method(D_METHOD("add_child_at_index", "p_child", "p_idx"), &BTTask::add_child_at_index);
	ClassDB::bind_method(D_METHOD("remove_child", "p_child"), &BTTask::remove_child);
	ClassDB::bind_method(D_METHOD("remove_child_at_index", "p_idx"), &BTTask::remove_child_at_index);
	ClassDB::bind_method(D_METHOD("has_child", "p_child"), &BTTask::has_child);
	ClassDB::bind_method(D_METHOD("is_descendant_of", "p_task"), &BTTask::is_descendant_of);
	ClassDB::bind_method(D_METHOD("get_child_index", "p_child"), &BTTask::get_child_index);
	ClassDB::bind_method(D_METHOD("next_sibling"), &BTTask::next_sibling);
	ClassDB::bind_method(D_METHOD("print_tree", "p_initial_tabs"), &BTTask::print_tree, Variant(0));
	ClassDB::bind_method(D_METHOD("get_task_name"), &BTTask::get_task_name);

	// Enums.
	ClassDB::bind_integer_constant(get_class_static(), "TaskStatus", "FRESH", FRESH);
	ClassDB::bind_integer_constant(get_class_static(), "TaskStatus", "RUNNING", RUNNING);
	ClassDB::bind_integer_constant(get_class_static(), "TaskStatus", "FAILURE", FAILURE);
	ClassDB::bind_integer_constant(get_class_static(), "TaskStatus", "SUCCESS", SUCCESS);
}

BTTask::BTTask() {
	custom_name = String();
	agent = nullptr;
	parent = nullptr;
	children = Vector<Ref<BTTask>>();
	status = FRESH;
}

BTTask::~BTTask() {
	for (int i = 0; i < get_child_count(); i++) {
		ERR_FAIL_COND(!get_child(i).is_valid());
		get_child(i)->parent = nullptr;
		get_child(i).unref();
	}
}