/** * bt_player.cpp * ============================================================================= * 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. * ============================================================================= */ #include "bt_player.h" #include "../editor/debugger/limbo_debugger.h" #include "../util/limbo_compat.h" #include "../util/limbo_string_names.h" #ifdef LIMBOAI_MODULE #include "core/config/engine.h" #include "core/debugger/engine_debugger.h" #include "core/error/error_macros.h" #include "core/io/resource_loader.h" #include "core/object/class_db.h" #include "core/os/memory.h" #include "core/string/string_name.h" #include "core/variant/variant.h" #include "main/performance.h" #define IS_DEBUGGER_ACTIVE() (EngineDebugger::is_active()) #define GET_TICKS_USEC() (OS::get_singleton()->get_ticks_usec()) #endif // ! LIMBOAI_MODULE #ifdef LIMBOAI_GDEXTENSION #include #include #include #define IS_DEBUGGER_ACTIVE() (EngineDebugger::get_singleton()->is_active()) #define GET_TICKS_USEC() (Time::get_singleton()->get_ticks_usec()) #endif // ! LIMBOAI_GDEXTENSION VARIANT_ENUM_CAST(BTPlayer::UpdateMode); void BTPlayer::_load_tree() { #ifdef DEBUG_ENABLED if (tree_instance.is_valid() && IS_DEBUGGER_ACTIVE()) { LimboDebugger::get_singleton()->unregister_bt_instance(tree_instance, get_path()); } #endif tree_instance.unref(); ERR_FAIL_COND_MSG(!behavior_tree.is_valid(), "BTPlayer: Initialization failed - needs a valid behavior tree."); ERR_FAIL_COND_MSG(!behavior_tree->get_root_task().is_valid(), "BTPlayer: Initialization failed - behavior tree has no valid root task."); Node *agent = GET_NODE(this, agent_node); ERR_FAIL_NULL_MSG(agent, vformat("BTPlayer: Initialization failed - can't get agent with path '%s'.", agent_node)); Node *scene_root = get_owner(); ERR_FAIL_NULL_MSG(scene_root, "BTPlayer: Initialization failed - can't get scene root (make sure the BTPlayer's owner property is set)."); tree_instance = behavior_tree->instantiate(agent, blackboard, scene_root); #ifdef DEBUG_ENABLED if (IS_DEBUGGER_ACTIVE()) { LimboDebugger::get_singleton()->register_bt_instance(tree_instance, get_path()); } #endif } void BTPlayer::_update_blackboard_plan() { if (blackboard_plan.is_null()) { blackboard_plan = Ref(memnew(BlackboardPlan)); } else if (!RESOURCE_IS_BUILT_IN(blackboard_plan)) { WARN_PRINT_ED("BTPlayer: Using external resource for derived blackboard plan is not supported. Converted to built-in resource."); blackboard_plan = blackboard_plan->duplicate(); } blackboard_plan->set_base_plan(behavior_tree.is_valid() ? behavior_tree->get_blackboard_plan() : nullptr); } void BTPlayer::set_behavior_tree(const Ref &p_tree) { if (Engine::get_singleton()->is_editor_hint()) { if (behavior_tree.is_valid() && behavior_tree->is_connected(LW_NAME(plan_changed), callable_mp(this, &BTPlayer::_update_blackboard_plan))) { behavior_tree->disconnect(LW_NAME(plan_changed), callable_mp(this, &BTPlayer::_update_blackboard_plan)); } if (p_tree.is_valid()) { p_tree->connect(LW_NAME(plan_changed), callable_mp(this, &BTPlayer::_update_blackboard_plan)); } behavior_tree = p_tree; _update_blackboard_plan(); } else { behavior_tree = p_tree; if (get_owner()) { _load_tree(); } } } void BTPlayer::set_agent_node(const NodePath &p_agent_node) { agent_node = p_agent_node; if (tree_instance.is_valid()) { ERR_PRINT("BTPlayer: Agent node cannot be set after the behavior tree is instantiated. This change will not affect the behavior tree instance."); } } void BTPlayer::set_blackboard_plan(const Ref &p_plan) { blackboard_plan = p_plan; _update_blackboard_plan(); } void BTPlayer::set_update_mode(UpdateMode p_mode) { update_mode = p_mode; set_active(active); } void BTPlayer::set_active(bool p_active) { active = p_active; bool is_not_editor = !Engine::get_singleton()->is_editor_hint(); set_process(update_mode == UpdateMode::IDLE && active && is_not_editor); set_physics_process(update_mode == UpdateMode::PHYSICS && active && is_not_editor); set_process_input(active && is_not_editor); } void BTPlayer::update(double p_delta) { if (!tree_instance.is_valid()) { ERR_PRINT_ONCE(vformat("BTPlayer doesn't have a behavior tree with a valid root task to execute (owner: %s)", get_owner())); return; } #ifdef DEBUG_ENABLED double start = GET_TICKS_USEC(); #endif if (active) { last_status = tree_instance->execute(p_delta); emit_signal(LimboStringNames::get_singleton()->updated, last_status); if (last_status == BTTask::SUCCESS || last_status == BTTask::FAILURE) { emit_signal(LimboStringNames::get_singleton()->behavior_tree_finished, last_status); } } #ifdef DEBUG_ENABLED double end = GET_TICKS_USEC(); update_time_acc += (end - start); update_time_n += 1.0; #endif } void BTPlayer::restart() { tree_instance->abort(); set_active(true); } #ifdef DEBUG_ENABLED void BTPlayer::_set_monitor_performance(bool p_monitor_performance) { monitor_performance = p_monitor_performance; if (!get_owner() && monitor_performance) { // Don't add custom monitor if not in scene. return; } if (monitor_performance) { _add_custom_monitor(); } else { _remove_custom_monitor(); } } void BTPlayer::_add_custom_monitor() { if (monitor_id == StringName()) { monitor_id = vformat("LimboAI/update_ms|%s_%s_%s", get_owner()->get_name(), get_name(), String(itos(get_instance_id())).md5_text().substr(0, 4)); } if (!Performance::get_singleton()->has_custom_monitor(monitor_id)) { PERFORMANCE_ADD_CUSTOM_MONITOR(monitor_id, callable_mp(this, &BTPlayer::_get_mean_update_time_msec)); } } void BTPlayer::_remove_custom_monitor() { if (monitor_id != StringName() && Performance::get_singleton()->has_custom_monitor(monitor_id)) { Performance::get_singleton()->remove_custom_monitor(monitor_id); } } double BTPlayer::_get_mean_update_time_msec() { if (update_time_n) { double mean_time_msec = (update_time_acc * 0.001) / update_time_n; update_time_acc = 0.0; update_time_n = 0.0; return mean_time_msec; } return 0.0; } #endif // ! DEBUG_ENABLED void BTPlayer::_notification(int p_notification) { switch (p_notification) { case NOTIFICATION_PROCESS: { Variant time = get_process_delta_time(); update(time); } break; case NOTIFICATION_PHYSICS_PROCESS: { Variant time = get_physics_process_delta_time(); update(time); } break; case NOTIFICATION_READY: { if (!Engine::get_singleton()->is_editor_hint()) { if (blackboard.is_null()) { blackboard = Ref(memnew(Blackboard)); } if (blackboard_plan.is_valid()) { blackboard_plan->populate_blackboard(blackboard, false, this); } if (behavior_tree.is_valid()) { _load_tree(); } } else { _update_blackboard_plan(); } set_active(active); } break; case NOTIFICATION_ENTER_TREE: { #ifdef DEBUG_ENABLED if (tree_instance.is_valid() && IS_DEBUGGER_ACTIVE()) { LimboDebugger::get_singleton()->register_bt_instance(tree_instance, get_path()); } if (monitor_performance) { _add_custom_monitor(); } #endif // DEBUG_ENABLED } break; case NOTIFICATION_EXIT_TREE: { #ifdef DEBUG_ENABLED if (tree_instance.is_valid() && IS_DEBUGGER_ACTIVE()) { LimboDebugger::get_singleton()->unregister_bt_instance(tree_instance, get_path()); } if (monitor_performance) { _remove_custom_monitor(); } #endif // DEBUG_ENABLED if (Engine::get_singleton()->is_editor_hint()) { if (behavior_tree.is_valid() && behavior_tree->is_connected(LW_NAME(plan_changed), callable_mp(this, &BTPlayer::_update_blackboard_plan))) { behavior_tree->disconnect(LW_NAME(plan_changed), callable_mp(this, &BTPlayer::_update_blackboard_plan)); } } } break; } } void BTPlayer::_bind_methods() { ClassDB::bind_method(D_METHOD("set_behavior_tree", "behavior_tree"), &BTPlayer::set_behavior_tree); ClassDB::bind_method(D_METHOD("get_behavior_tree"), &BTPlayer::get_behavior_tree); ClassDB::bind_method(D_METHOD("set_agent_node", "agent_node"), &BTPlayer::set_agent_node); ClassDB::bind_method(D_METHOD("get_agent_node"), &BTPlayer::get_agent_node); ClassDB::bind_method(D_METHOD("set_update_mode", "update_mode"), &BTPlayer::set_update_mode); ClassDB::bind_method(D_METHOD("get_update_mode"), &BTPlayer::get_update_mode); ClassDB::bind_method(D_METHOD("set_active", "active"), &BTPlayer::set_active); ClassDB::bind_method(D_METHOD("get_active"), &BTPlayer::get_active); ClassDB::bind_method(D_METHOD("set_blackboard", "blackboard"), &BTPlayer::set_blackboard); ClassDB::bind_method(D_METHOD("get_blackboard"), &BTPlayer::get_blackboard); ClassDB::bind_method(D_METHOD("set_blackboard_plan", "plan"), &BTPlayer::set_blackboard_plan); ClassDB::bind_method(D_METHOD("get_blackboard_plan"), &BTPlayer::get_blackboard_plan); ClassDB::bind_method(D_METHOD("update", "delta"), &BTPlayer::update); ClassDB::bind_method(D_METHOD("restart"), &BTPlayer::restart); ClassDB::bind_method(D_METHOD("get_last_status"), &BTPlayer::get_last_status); ClassDB::bind_method(D_METHOD("get_tree_instance"), &BTPlayer::get_tree_instance); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "behavior_tree", PROPERTY_HINT_RESOURCE_TYPE, "BehaviorTree"), "set_behavior_tree", "get_behavior_tree"); ADD_PROPERTY(PropertyInfo(Variant::NODE_PATH, "agent_node"), "set_agent_node", "get_agent_node"); ADD_PROPERTY(PropertyInfo(Variant::INT, "update_mode", PROPERTY_HINT_ENUM, "Idle,Physics,Manual"), "set_update_mode", "get_update_mode"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "active"), "set_active", "get_active"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "blackboard", PROPERTY_HINT_NONE, "Blackboard", 0), "set_blackboard", "get_blackboard"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "blackboard_plan", PROPERTY_HINT_RESOURCE_TYPE, "BlackboardPlan", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_EDITOR_INSTANTIATE_OBJECT | PROPERTY_USAGE_ALWAYS_DUPLICATE), "set_blackboard_plan", "get_blackboard_plan"); BIND_ENUM_CONSTANT(IDLE); BIND_ENUM_CONSTANT(PHYSICS); BIND_ENUM_CONSTANT(MANUAL); ADD_SIGNAL(MethodInfo("behavior_tree_finished", PropertyInfo(Variant::INT, "status"))); ADD_SIGNAL(MethodInfo("updated", PropertyInfo(Variant::INT, "status"))); #ifdef DEBUG_ENABLED ClassDB::bind_method(D_METHOD("_set_monitor_performance", "enable"), &BTPlayer::_set_monitor_performance); ClassDB::bind_method(D_METHOD("_get_monitor_performance"), &BTPlayer::_get_monitor_performance); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "monitor_performance"), "_set_monitor_performance", "_get_monitor_performance"); #endif // DEBUG_ENABLED } BTPlayer::BTPlayer() { blackboard = Ref(memnew(Blackboard)); agent_node = LW_NAME(node_pp); } BTPlayer::~BTPlayer() { }