/*************************************************************************/ /* scene_tree.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /*************************************************************************/ #include "scene_tree.h" #include "core/debugger/engine_debugger.h" #include "core/input/input.h" #include "core/io/marshalls.h" #include "core/io/resource_loader.h" #include "core/message_queue.h" #include "core/os/dir_access.h" #include "core/os/keyboard.h" #include "core/os/os.h" #include "core/print_string.h" #include "core/project_settings.h" #include "node.h" #include "scene/debugger/scene_debugger.h" #include "scene/resources/dynamic_font.h" #include "scene/resources/material.h" #include "scene/resources/mesh.h" #include "scene/resources/packed_scene.h" #include "scene/scene_string_names.h" #include "servers/display_server.h" #include "servers/navigation_server_3d.h" #include "servers/physics_server_2d.h" #include "servers/physics_server_3d.h" #include "window.h" #include void SceneTreeTimer::_bind_methods() { ClassDB::bind_method(D_METHOD("set_time_left", "time"), &SceneTreeTimer::set_time_left); ClassDB::bind_method(D_METHOD("get_time_left"), &SceneTreeTimer::get_time_left); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "time_left"), "set_time_left", "get_time_left"); ADD_SIGNAL(MethodInfo("timeout")); } void SceneTreeTimer::set_time_left(float p_time) { time_left = p_time; } float SceneTreeTimer::get_time_left() const { return time_left; } void SceneTreeTimer::set_pause_mode_process(bool p_pause_mode_process) { process_pause = p_pause_mode_process; } bool SceneTreeTimer::is_pause_mode_process() { return process_pause; } void SceneTreeTimer::release_connections() { List connections; get_all_signal_connections(&connections); for (List::Element *E = connections.front(); E; E = E->next()) { Connection const &connection = E->get(); disconnect(connection.signal.get_name(), connection.callable); } } SceneTreeTimer::SceneTreeTimer() { time_left = 0; process_pause = true; } void SceneTree::tree_changed() { tree_version++; emit_signal(tree_changed_name); } void SceneTree::node_added(Node *p_node) { emit_signal(node_added_name, p_node); } void SceneTree::node_removed(Node *p_node) { if (current_scene == p_node) { current_scene = nullptr; } emit_signal(node_removed_name, p_node); if (call_lock > 0) { call_skip.insert(p_node); } } void SceneTree::node_renamed(Node *p_node) { emit_signal(node_renamed_name, p_node); } SceneTree::Group *SceneTree::add_to_group(const StringName &p_group, Node *p_node) { Map::Element *E = group_map.find(p_group); if (!E) { E = group_map.insert(p_group, Group()); } ERR_FAIL_COND_V_MSG(E->get().nodes.find(p_node) != -1, &E->get(), "Already in group: " + p_group + "."); E->get().nodes.push_back(p_node); //E->get().last_tree_version=0; E->get().changed = true; return &E->get(); } void SceneTree::remove_from_group(const StringName &p_group, Node *p_node) { Map::Element *E = group_map.find(p_group); ERR_FAIL_COND(!E); E->get().nodes.erase(p_node); if (E->get().nodes.empty()) { group_map.erase(E); } } void SceneTree::make_group_changed(const StringName &p_group) { Map::Element *E = group_map.find(p_group); if (E) { E->get().changed = true; } } void SceneTree::flush_transform_notifications() { SelfList *n = xform_change_list.first(); while (n) { Node *node = n->self(); SelfList *nx = n->next(); xform_change_list.remove(n); n = nx; node->notification(NOTIFICATION_TRANSFORM_CHANGED); } } void SceneTree::_flush_ugc() { ugc_locked = true; while (unique_group_calls.size()) { Map>::Element *E = unique_group_calls.front(); Variant v[VARIANT_ARG_MAX]; for (int i = 0; i < E->get().size(); i++) { v[i] = E->get()[i]; } static_assert(VARIANT_ARG_MAX == 5, "This code needs to be updated if VARIANT_ARG_MAX != 5"); call_group_flags(GROUP_CALL_REALTIME, E->key().group, E->key().call, v[0], v[1], v[2], v[3], v[4]); unique_group_calls.erase(E); } ugc_locked = false; } void SceneTree::_update_group_order(Group &g, bool p_use_priority) { if (!g.changed) { return; } if (g.nodes.empty()) { return; } Node **nodes = g.nodes.ptrw(); int node_count = g.nodes.size(); if (p_use_priority) { SortArray node_sort; node_sort.sort(nodes, node_count); } else { SortArray node_sort; node_sort.sort(nodes, node_count); } g.changed = false; } void SceneTree::call_group_flags(uint32_t p_call_flags, const StringName &p_group, const StringName &p_function, VARIANT_ARG_DECLARE) { Map::Element *E = group_map.find(p_group); if (!E) { return; } Group &g = E->get(); if (g.nodes.empty()) { return; } if (p_call_flags & GROUP_CALL_UNIQUE && !(p_call_flags & GROUP_CALL_REALTIME)) { ERR_FAIL_COND(ugc_locked); UGCall ug; ug.call = p_function; ug.group = p_group; if (unique_group_calls.has(ug)) { return; } VARIANT_ARGPTRS; Vector args; for (int i = 0; i < VARIANT_ARG_MAX; i++) { if (argptr[i]->get_type() == Variant::NIL) { break; } args.push_back(*argptr[i]); } unique_group_calls[ug] = args; return; } _update_group_order(g); Vector nodes_copy = g.nodes; Node **nodes = nodes_copy.ptrw(); int node_count = nodes_copy.size(); call_lock++; if (p_call_flags & GROUP_CALL_REVERSE) { for (int i = node_count - 1; i >= 0; i--) { if (call_lock && call_skip.has(nodes[i])) { continue; } if (p_call_flags & GROUP_CALL_REALTIME) { if (p_call_flags & GROUP_CALL_MULTILEVEL) { nodes[i]->call_multilevel(p_function, VARIANT_ARG_PASS); } else { nodes[i]->call(p_function, VARIANT_ARG_PASS); } } else { MessageQueue::get_singleton()->push_call(nodes[i], p_function, VARIANT_ARG_PASS); } } } else { for (int i = 0; i < node_count; i++) { if (call_lock && call_skip.has(nodes[i])) { continue; } if (p_call_flags & GROUP_CALL_REALTIME) { if (p_call_flags & GROUP_CALL_MULTILEVEL) { nodes[i]->call_multilevel(p_function, VARIANT_ARG_PASS); } else { nodes[i]->call(p_function, VARIANT_ARG_PASS); } } else { MessageQueue::get_singleton()->push_call(nodes[i], p_function, VARIANT_ARG_PASS); } } } call_lock--; if (call_lock == 0) { call_skip.clear(); } } void SceneTree::notify_group_flags(uint32_t p_call_flags, const StringName &p_group, int p_notification) { Map::Element *E = group_map.find(p_group); if (!E) { return; } Group &g = E->get(); if (g.nodes.empty()) { return; } _update_group_order(g); Vector nodes_copy = g.nodes; Node **nodes = nodes_copy.ptrw(); int node_count = nodes_copy.size(); call_lock++; if (p_call_flags & GROUP_CALL_REVERSE) { for (int i = node_count - 1; i >= 0; i--) { if (call_lock && call_skip.has(nodes[i])) { continue; } if (p_call_flags & GROUP_CALL_REALTIME) { nodes[i]->notification(p_notification); } else { MessageQueue::get_singleton()->push_notification(nodes[i], p_notification); } } } else { for (int i = 0; i < node_count; i++) { if (call_lock && call_skip.has(nodes[i])) { continue; } if (p_call_flags & GROUP_CALL_REALTIME) { nodes[i]->notification(p_notification); } else { MessageQueue::get_singleton()->push_notification(nodes[i], p_notification); } } } call_lock--; if (call_lock == 0) { call_skip.clear(); } } void SceneTree::set_group_flags(uint32_t p_call_flags, const StringName &p_group, const String &p_name, const Variant &p_value) { Map::Element *E = group_map.find(p_group); if (!E) { return; } Group &g = E->get(); if (g.nodes.empty()) { return; } _update_group_order(g); Vector nodes_copy = g.nodes; Node **nodes = nodes_copy.ptrw(); int node_count = nodes_copy.size(); call_lock++; if (p_call_flags & GROUP_CALL_REVERSE) { for (int i = node_count - 1; i >= 0; i--) { if (call_lock && call_skip.has(nodes[i])) { continue; } if (p_call_flags & GROUP_CALL_REALTIME) { nodes[i]->set(p_name, p_value); } else { MessageQueue::get_singleton()->push_set(nodes[i], p_name, p_value); } } } else { for (int i = 0; i < node_count; i++) { if (call_lock && call_skip.has(nodes[i])) { continue; } if (p_call_flags & GROUP_CALL_REALTIME) { nodes[i]->set(p_name, p_value); } else { MessageQueue::get_singleton()->push_set(nodes[i], p_name, p_value); } } } call_lock--; if (call_lock == 0) { call_skip.clear(); } } void SceneTree::call_group(const StringName &p_group, const StringName &p_function, VARIANT_ARG_DECLARE) { call_group_flags(0, p_group, p_function, VARIANT_ARG_PASS); } void SceneTree::notify_group(const StringName &p_group, int p_notification) { notify_group_flags(0, p_group, p_notification); } void SceneTree::set_group(const StringName &p_group, const String &p_name, const Variant &p_value) { set_group_flags(0, p_group, p_name, p_value); } void SceneTree::init() { initialized = true; root->_set_tree(this); MainLoop::init(); } bool SceneTree::iteration(float p_time) { root_lock++; current_frame++; flush_transform_notifications(); MainLoop::iteration(p_time); physics_process_time = p_time; emit_signal("physics_frame"); _notify_group_pause("physics_process_internal", Node::NOTIFICATION_INTERNAL_PHYSICS_PROCESS); _notify_group_pause("physics_process", Node::NOTIFICATION_PHYSICS_PROCESS); _flush_ugc(); MessageQueue::get_singleton()->flush(); //small little hack flush_transform_notifications(); call_group_flags(GROUP_CALL_REALTIME, "_viewports", "update_worlds"); root_lock--; _flush_delete_queue(); _call_idle_callbacks(); return _quit; } bool SceneTree::idle(float p_time) { //print_line("ram: "+itos(OS::get_singleton()->get_static_memory_usage())+" sram: "+itos(OS::get_singleton()->get_dynamic_memory_usage())); //print_line("node count: "+itos(get_node_count())); //print_line("TEXTURE RAM: "+itos(RS::get_singleton()->get_render_info(RS::INFO_TEXTURE_MEM_USED))); root_lock++; MainLoop::idle(p_time); idle_process_time = p_time; if (multiplayer_poll) { multiplayer->poll(); } emit_signal("idle_frame"); MessageQueue::get_singleton()->flush(); //small little hack flush_transform_notifications(); _notify_group_pause("idle_process_internal", Node::NOTIFICATION_INTERNAL_PROCESS); _notify_group_pause("idle_process", Node::NOTIFICATION_PROCESS); _flush_ugc(); MessageQueue::get_singleton()->flush(); //small little hack flush_transform_notifications(); //transforms after world update, to avoid unnecessary enter/exit notifications call_group_flags(GROUP_CALL_REALTIME, "_viewports", "update_worlds"); root_lock--; _flush_delete_queue(); //go through timers List>::Element *L = timers.back(); //last element for (List>::Element *E = timers.front(); E;) { List>::Element *N = E->next(); if (pause && !E->get()->is_pause_mode_process()) { if (E == L) { break; //break on last, so if new timers were added during list traversal, ignore them. } E = N; continue; } float time_left = E->get()->get_time_left(); time_left -= p_time; E->get()->set_time_left(time_left); if (time_left < 0) { E->get()->emit_signal("timeout"); timers.erase(E); } if (E == L) { break; //break on last, so if new timers were added during list traversal, ignore them. } E = N; } flush_transform_notifications(); //additional transforms after timers update _call_idle_callbacks(); #ifdef TOOLS_ENABLED if (Engine::get_singleton()->is_editor_hint()) { //simple hack to reload fallback environment if it changed from editor String env_path = ProjectSettings::get_singleton()->get("rendering/environment/default_environment"); env_path = env_path.strip_edges(); //user may have added a space or two String cpath; Ref fallback = get_root()->get_world_3d()->get_fallback_environment(); if (fallback.is_valid()) { cpath = fallback->get_path(); } if (cpath != env_path) { if (env_path != String()) { fallback = ResourceLoader::load(env_path); if (fallback.is_null()) { //could not load fallback, set as empty ProjectSettings::get_singleton()->set("rendering/environment/default_environment", ""); } } else { fallback.unref(); } get_root()->get_world_3d()->set_fallback_environment(fallback); } } #endif return _quit; } void SceneTree::finish() { _flush_delete_queue(); _flush_ugc(); initialized = false; MainLoop::finish(); if (root) { root->_set_tree(nullptr); root->_propagate_after_exit_tree(); memdelete(root); //delete root root = nullptr; } // cleanup timers for (List>::Element *E = timers.front(); E; E = E->next()) { E->get()->release_connections(); } timers.clear(); } void SceneTree::quit(int p_exit_code) { if (p_exit_code >= 0) { // Override the exit code if a positive argument is given (the default is `-1`). // This is a shorthand for calling `set_exit_code()` on the OS singleton then quitting. OS::get_singleton()->set_exit_code(p_exit_code); } _quit = true; } void SceneTree::_main_window_close() { if (accept_quit) { _quit = true; } } void SceneTree::_main_window_go_back() { if (quit_on_go_back) { _quit = true; } } void SceneTree::_main_window_focus_in() { Input *id = Input::get_singleton(); if (id) { id->ensure_touch_mouse_raised(); } } void SceneTree::_notification(int p_notification) { switch (p_notification) { case NOTIFICATION_TRANSLATION_CHANGED: { if (!Engine::get_singleton()->is_editor_hint()) { get_root()->propagate_notification(p_notification); } } break; case NOTIFICATION_OS_MEMORY_WARNING: case NOTIFICATION_OS_IME_UPDATE: case NOTIFICATION_WM_ABOUT: case NOTIFICATION_CRASH: case NOTIFICATION_APPLICATION_RESUMED: case NOTIFICATION_APPLICATION_PAUSED: case NOTIFICATION_APPLICATION_FOCUS_IN: case NOTIFICATION_APPLICATION_FOCUS_OUT: { get_root()->propagate_notification(p_notification); //pass these to nodes, since they are mirrored } break; default: break; }; }; void SceneTree::set_auto_accept_quit(bool p_enable) { accept_quit = p_enable; } void SceneTree::set_quit_on_go_back(bool p_enable) { quit_on_go_back = p_enable; } #ifdef TOOLS_ENABLED bool SceneTree::is_node_being_edited(const Node *p_node) const { return Engine::get_singleton()->is_editor_hint() && edited_scene_root && (edited_scene_root->is_a_parent_of(p_node) || edited_scene_root == p_node); } #endif #ifdef DEBUG_ENABLED void SceneTree::set_debug_collisions_hint(bool p_enabled) { debug_collisions_hint = p_enabled; } bool SceneTree::is_debugging_collisions_hint() const { return debug_collisions_hint; } void SceneTree::set_debug_navigation_hint(bool p_enabled) { debug_navigation_hint = p_enabled; } bool SceneTree::is_debugging_navigation_hint() const { return debug_navigation_hint; } #endif void SceneTree::set_debug_collisions_color(const Color &p_color) { debug_collisions_color = p_color; } Color SceneTree::get_debug_collisions_color() const { return debug_collisions_color; } void SceneTree::set_debug_collision_contact_color(const Color &p_color) { debug_collision_contact_color = p_color; } Color SceneTree::get_debug_collision_contact_color() const { return debug_collision_contact_color; } void SceneTree::set_debug_navigation_color(const Color &p_color) { debug_navigation_color = p_color; } Color SceneTree::get_debug_navigation_color() const { return debug_navigation_color; } void SceneTree::set_debug_navigation_disabled_color(const Color &p_color) { debug_navigation_disabled_color = p_color; } Color SceneTree::get_debug_navigation_disabled_color() const { return debug_navigation_disabled_color; } Ref SceneTree::get_debug_navigation_material() { if (navigation_material.is_valid()) { return navigation_material; } Ref line_material = Ref(memnew(StandardMaterial3D)); line_material->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED); line_material->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA); line_material->set_flag(StandardMaterial3D::FLAG_SRGB_VERTEX_COLOR, true); line_material->set_flag(StandardMaterial3D::FLAG_ALBEDO_FROM_VERTEX_COLOR, true); line_material->set_albedo(get_debug_navigation_color()); navigation_material = line_material; return navigation_material; } Ref SceneTree::get_debug_navigation_disabled_material() { if (navigation_disabled_material.is_valid()) { return navigation_disabled_material; } Ref line_material = Ref(memnew(StandardMaterial3D)); line_material->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED); line_material->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA); line_material->set_flag(StandardMaterial3D::FLAG_SRGB_VERTEX_COLOR, true); line_material->set_flag(StandardMaterial3D::FLAG_ALBEDO_FROM_VERTEX_COLOR, true); line_material->set_albedo(get_debug_navigation_disabled_color()); navigation_disabled_material = line_material; return navigation_disabled_material; } Ref SceneTree::get_debug_collision_material() { if (collision_material.is_valid()) { return collision_material; } Ref line_material = Ref(memnew(StandardMaterial3D)); line_material->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED); line_material->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA); line_material->set_flag(StandardMaterial3D::FLAG_SRGB_VERTEX_COLOR, true); line_material->set_flag(StandardMaterial3D::FLAG_ALBEDO_FROM_VERTEX_COLOR, true); line_material->set_albedo(get_debug_collisions_color()); collision_material = line_material; return collision_material; } Ref SceneTree::get_debug_contact_mesh() { if (debug_contact_mesh.is_valid()) { return debug_contact_mesh; } debug_contact_mesh = Ref(memnew(ArrayMesh)); Ref mat = Ref(memnew(StandardMaterial3D)); mat->set_shading_mode(StandardMaterial3D::SHADING_MODE_UNSHADED); mat->set_transparency(StandardMaterial3D::TRANSPARENCY_ALPHA); mat->set_flag(StandardMaterial3D::FLAG_SRGB_VERTEX_COLOR, true); mat->set_flag(StandardMaterial3D::FLAG_ALBEDO_FROM_VERTEX_COLOR, true); mat->set_albedo(get_debug_collision_contact_color()); Vector3 diamond[6] = { Vector3(-1, 0, 0), Vector3(1, 0, 0), Vector3(0, -1, 0), Vector3(0, 1, 0), Vector3(0, 0, -1), Vector3(0, 0, 1) }; /* clang-format off */ int diamond_faces[8 * 3] = { 0, 2, 4, 0, 3, 4, 1, 2, 4, 1, 3, 4, 0, 2, 5, 0, 3, 5, 1, 2, 5, 1, 3, 5, }; /* clang-format on */ Vector indices; for (int i = 0; i < 8 * 3; i++) { indices.push_back(diamond_faces[i]); } Vector vertices; for (int i = 0; i < 6; i++) { vertices.push_back(diamond[i] * 0.1); } Array arr; arr.resize(Mesh::ARRAY_MAX); arr[Mesh::ARRAY_VERTEX] = vertices; arr[Mesh::ARRAY_INDEX] = indices; debug_contact_mesh->add_surface_from_arrays(Mesh::PRIMITIVE_TRIANGLES, arr); debug_contact_mesh->surface_set_material(0, mat); return debug_contact_mesh; } void SceneTree::set_pause(bool p_enabled) { if (p_enabled == pause) { return; } pause = p_enabled; NavigationServer3D::get_singleton()->set_active(!p_enabled); PhysicsServer3D::get_singleton()->set_active(!p_enabled); PhysicsServer2D::get_singleton()->set_active(!p_enabled); if (get_root()) { get_root()->propagate_notification(p_enabled ? Node::NOTIFICATION_PAUSED : Node::NOTIFICATION_UNPAUSED); } } bool SceneTree::is_paused() const { return pause; } void SceneTree::_notify_group_pause(const StringName &p_group, int p_notification) { Map::Element *E = group_map.find(p_group); if (!E) { return; } Group &g = E->get(); if (g.nodes.empty()) { return; } _update_group_order(g, p_notification == Node::NOTIFICATION_PROCESS || p_notification == Node::NOTIFICATION_INTERNAL_PROCESS || p_notification == Node::NOTIFICATION_PHYSICS_PROCESS || p_notification == Node::NOTIFICATION_INTERNAL_PHYSICS_PROCESS); //copy, so copy on write happens in case something is removed from process while being called //performance is not lost because only if something is added/removed the vector is copied. Vector nodes_copy = g.nodes; int node_count = nodes_copy.size(); Node **nodes = nodes_copy.ptrw(); call_lock++; for (int i = 0; i < node_count; i++) { Node *n = nodes[i]; if (call_lock && call_skip.has(n)) { continue; } if (!n->can_process()) { continue; } if (!n->can_process_notification(p_notification)) { continue; } n->notification(p_notification); //ERR_FAIL_COND(node_count != g.nodes.size()); } call_lock--; if (call_lock == 0) { call_skip.clear(); } } /* void SceneMainLoop::_update_listener_2d() { if (listener_2d.is_valid()) { SpatialSound2DServer::get_singleton()->listener_set_space( listener_2d, world_2d->get_sound_space() ); } } */ void SceneTree::_call_input_pause(const StringName &p_group, const StringName &p_method, const Ref &p_input, Viewport *p_viewport) { Map::Element *E = group_map.find(p_group); if (!E) { return; } Group &g = E->get(); if (g.nodes.empty()) { return; } _update_group_order(g); //copy, so copy on write happens in case something is removed from process while being called //performance is not lost because only if something is added/removed the vector is copied. Vector nodes_copy = g.nodes; int node_count = nodes_copy.size(); Node **nodes = nodes_copy.ptrw(); Variant arg = p_input; const Variant *v[1] = { &arg }; call_lock++; for (int i = node_count - 1; i >= 0; i--) { if (p_viewport->is_input_handled()) { break; } Node *n = nodes[i]; if (call_lock && call_skip.has(n)) { continue; } if (!n->can_process()) { continue; } n->call_multilevel(p_method, (const Variant **)v, 1); //ERR_FAIL_COND(node_count != g.nodes.size()); } call_lock--; if (call_lock == 0) { call_skip.clear(); } } Variant SceneTree::_call_group_flags(const Variant **p_args, int p_argcount, Callable::CallError &r_error) { r_error.error = Callable::CallError::CALL_OK; ERR_FAIL_COND_V(p_argcount < 3, Variant()); ERR_FAIL_COND_V(!p_args[0]->is_num(), Variant()); ERR_FAIL_COND_V(p_args[1]->get_type() != Variant::STRING_NAME && p_args[1]->get_type() != Variant::STRING, Variant()); ERR_FAIL_COND_V(p_args[2]->get_type() != Variant::STRING_NAME && p_args[2]->get_type() != Variant::STRING, Variant()); int flags = *p_args[0]; StringName group = *p_args[1]; StringName method = *p_args[2]; Variant v[VARIANT_ARG_MAX]; for (int i = 0; i < MIN(p_argcount - 3, 5); i++) { v[i] = *p_args[i + 3]; } static_assert(VARIANT_ARG_MAX == 5, "This code needs to be updated if VARIANT_ARG_MAX != 5"); call_group_flags(flags, group, method, v[0], v[1], v[2], v[3], v[4]); return Variant(); } Variant SceneTree::_call_group(const Variant **p_args, int p_argcount, Callable::CallError &r_error) { r_error.error = Callable::CallError::CALL_OK; ERR_FAIL_COND_V(p_argcount < 2, Variant()); ERR_FAIL_COND_V(p_args[0]->get_type() != Variant::STRING_NAME && p_args[0]->get_type() != Variant::STRING, Variant()); ERR_FAIL_COND_V(p_args[1]->get_type() != Variant::STRING_NAME && p_args[1]->get_type() != Variant::STRING, Variant()); StringName group = *p_args[0]; StringName method = *p_args[1]; Variant v[VARIANT_ARG_MAX]; for (int i = 0; i < MIN(p_argcount - 2, 5); i++) { v[i] = *p_args[i + 2]; } static_assert(VARIANT_ARG_MAX == 5, "This code needs to be updated if VARIANT_ARG_MAX != 5"); call_group_flags(0, group, method, v[0], v[1], v[2], v[3], v[4]); return Variant(); } int64_t SceneTree::get_frame() const { return current_frame; } Array SceneTree::_get_nodes_in_group(const StringName &p_group) { Array ret; Map::Element *E = group_map.find(p_group); if (!E) { return ret; } _update_group_order(E->get()); //update order just in case int nc = E->get().nodes.size(); if (nc == 0) { return ret; } ret.resize(nc); Node **ptr = E->get().nodes.ptrw(); for (int i = 0; i < nc; i++) { ret[i] = ptr[i]; } return ret; } bool SceneTree::has_group(const StringName &p_identifier) const { return group_map.has(p_identifier); } void SceneTree::get_nodes_in_group(const StringName &p_group, List *p_list) { Map::Element *E = group_map.find(p_group); if (!E) { return; } _update_group_order(E->get()); //update order just in case int nc = E->get().nodes.size(); if (nc == 0) { return; } Node **ptr = E->get().nodes.ptrw(); for (int i = 0; i < nc; i++) { p_list->push_back(ptr[i]); } } void SceneTree::_flush_delete_queue() { _THREAD_SAFE_METHOD_ while (delete_queue.size()) { Object *obj = ObjectDB::get_instance(delete_queue.front()->get()); if (obj) { memdelete(obj); } delete_queue.pop_front(); } } void SceneTree::queue_delete(Object *p_object) { _THREAD_SAFE_METHOD_ ERR_FAIL_NULL(p_object); p_object->_is_queued_for_deletion = true; delete_queue.push_back(p_object->get_instance_id()); } int SceneTree::get_node_count() const { return node_count; } void SceneTree::set_edited_scene_root(Node *p_node) { #ifdef TOOLS_ENABLED edited_scene_root = p_node; #endif } Node *SceneTree::get_edited_scene_root() const { #ifdef TOOLS_ENABLED return edited_scene_root; #else return nullptr; #endif } void SceneTree::set_current_scene(Node *p_scene) { ERR_FAIL_COND(p_scene && p_scene->get_parent() != root); current_scene = p_scene; } Node *SceneTree::get_current_scene() const { return current_scene; } void SceneTree::_change_scene(Node *p_to) { if (current_scene) { memdelete(current_scene); current_scene = nullptr; } // If we're quitting, abort. if (unlikely(_quit)) { if (p_to) { // Prevent memory leak. memdelete(p_to); } return; } if (p_to) { current_scene = p_to; root->add_child(p_to); } } Error SceneTree::change_scene(const String &p_path) { Ref new_scene = ResourceLoader::load(p_path); if (new_scene.is_null()) { return ERR_CANT_OPEN; } return change_scene_to(new_scene); } Error SceneTree::change_scene_to(const Ref &p_scene) { Node *new_scene = nullptr; if (p_scene.is_valid()) { new_scene = p_scene->instance(); ERR_FAIL_COND_V(!new_scene, ERR_CANT_CREATE); } call_deferred("_change_scene", new_scene); return OK; } Error SceneTree::reload_current_scene() { ERR_FAIL_COND_V(!current_scene, ERR_UNCONFIGURED); String fname = current_scene->get_filename(); return change_scene(fname); } void SceneTree::add_current_scene(Node *p_current) { current_scene = p_current; root->add_child(p_current); } Ref SceneTree::create_timer(float p_delay_sec, bool p_process_pause) { Ref stt; stt.instance(); stt->set_pause_mode_process(p_process_pause); stt->set_time_left(p_delay_sec); timers.push_back(stt); return stt; } void SceneTree::_network_peer_connected(int p_id) { emit_signal("network_peer_connected", p_id); } void SceneTree::_network_peer_disconnected(int p_id) { emit_signal("network_peer_disconnected", p_id); } void SceneTree::_connected_to_server() { emit_signal("connected_to_server"); } void SceneTree::_connection_failed() { emit_signal("connection_failed"); } void SceneTree::_server_disconnected() { emit_signal("server_disconnected"); } Ref SceneTree::get_multiplayer() const { return multiplayer; } void SceneTree::set_multiplayer_poll_enabled(bool p_enabled) { multiplayer_poll = p_enabled; } bool SceneTree::is_multiplayer_poll_enabled() const { return multiplayer_poll; } void SceneTree::set_multiplayer(Ref p_multiplayer) { ERR_FAIL_COND(!p_multiplayer.is_valid()); if (multiplayer.is_valid()) { multiplayer->disconnect("network_peer_connected", callable_mp(this, &SceneTree::_network_peer_connected)); multiplayer->disconnect("network_peer_disconnected", callable_mp(this, &SceneTree::_network_peer_disconnected)); multiplayer->disconnect("connected_to_server", callable_mp(this, &SceneTree::_connected_to_server)); multiplayer->disconnect("connection_failed", callable_mp(this, &SceneTree::_connection_failed)); multiplayer->disconnect("server_disconnected", callable_mp(this, &SceneTree::_server_disconnected)); } multiplayer = p_multiplayer; multiplayer->set_root_node(root); multiplayer->connect("network_peer_connected", callable_mp(this, &SceneTree::_network_peer_connected)); multiplayer->connect("network_peer_disconnected", callable_mp(this, &SceneTree::_network_peer_disconnected)); multiplayer->connect("connected_to_server", callable_mp(this, &SceneTree::_connected_to_server)); multiplayer->connect("connection_failed", callable_mp(this, &SceneTree::_connection_failed)); multiplayer->connect("server_disconnected", callable_mp(this, &SceneTree::_server_disconnected)); } void SceneTree::set_network_peer(const Ref &p_network_peer) { multiplayer->set_network_peer(p_network_peer); } Ref SceneTree::get_network_peer() const { return multiplayer->get_network_peer(); } bool SceneTree::is_network_server() const { return multiplayer->is_network_server(); } bool SceneTree::has_network_peer() const { return multiplayer->has_network_peer(); } int SceneTree::get_network_unique_id() const { return multiplayer->get_network_unique_id(); } Vector SceneTree::get_network_connected_peers() const { return multiplayer->get_network_connected_peers(); } int SceneTree::get_rpc_sender_id() const { return multiplayer->get_rpc_sender_id(); } void SceneTree::set_refuse_new_network_connections(bool p_refuse) { multiplayer->set_refuse_new_network_connections(p_refuse); } bool SceneTree::is_refusing_new_network_connections() const { return multiplayer->is_refusing_new_network_connections(); } void SceneTree::_bind_methods() { ClassDB::bind_method(D_METHOD("get_root"), &SceneTree::get_root); ClassDB::bind_method(D_METHOD("has_group", "name"), &SceneTree::has_group); ClassDB::bind_method(D_METHOD("set_auto_accept_quit", "enabled"), &SceneTree::set_auto_accept_quit); ClassDB::bind_method(D_METHOD("set_quit_on_go_back", "enabled"), &SceneTree::set_quit_on_go_back); ClassDB::bind_method(D_METHOD("set_debug_collisions_hint", "enable"), &SceneTree::set_debug_collisions_hint); ClassDB::bind_method(D_METHOD("is_debugging_collisions_hint"), &SceneTree::is_debugging_collisions_hint); ClassDB::bind_method(D_METHOD("set_debug_navigation_hint", "enable"), &SceneTree::set_debug_navigation_hint); ClassDB::bind_method(D_METHOD("is_debugging_navigation_hint"), &SceneTree::is_debugging_navigation_hint); ClassDB::bind_method(D_METHOD("set_edited_scene_root", "scene"), &SceneTree::set_edited_scene_root); ClassDB::bind_method(D_METHOD("get_edited_scene_root"), &SceneTree::get_edited_scene_root); ClassDB::bind_method(D_METHOD("set_pause", "enable"), &SceneTree::set_pause); ClassDB::bind_method(D_METHOD("is_paused"), &SceneTree::is_paused); ClassDB::bind_method(D_METHOD("create_timer", "time_sec", "pause_mode_process"), &SceneTree::create_timer, DEFVAL(true)); ClassDB::bind_method(D_METHOD("get_node_count"), &SceneTree::get_node_count); ClassDB::bind_method(D_METHOD("get_frame"), &SceneTree::get_frame); ClassDB::bind_method(D_METHOD("quit", "exit_code"), &SceneTree::quit, DEFVAL(-1)); ClassDB::bind_method(D_METHOD("queue_delete", "obj"), &SceneTree::queue_delete); MethodInfo mi; mi.name = "call_group_flags"; mi.arguments.push_back(PropertyInfo(Variant::INT, "flags")); mi.arguments.push_back(PropertyInfo(Variant::STRING_NAME, "group")); mi.arguments.push_back(PropertyInfo(Variant::STRING_NAME, "method")); ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "call_group_flags", &SceneTree::_call_group_flags, mi); ClassDB::bind_method(D_METHOD("notify_group_flags", "call_flags", "group", "notification"), &SceneTree::notify_group_flags); ClassDB::bind_method(D_METHOD("set_group_flags", "call_flags", "group", "property", "value"), &SceneTree::set_group_flags); MethodInfo mi2; mi2.name = "call_group"; mi2.arguments.push_back(PropertyInfo(Variant::STRING_NAME, "group")); mi2.arguments.push_back(PropertyInfo(Variant::STRING_NAME, "method")); ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "call_group", &SceneTree::_call_group, mi2); ClassDB::bind_method(D_METHOD("notify_group", "group", "notification"), &SceneTree::notify_group); ClassDB::bind_method(D_METHOD("set_group", "group", "property", "value"), &SceneTree::set_group); ClassDB::bind_method(D_METHOD("get_nodes_in_group", "group"), &SceneTree::_get_nodes_in_group); ClassDB::bind_method(D_METHOD("set_current_scene", "child_node"), &SceneTree::set_current_scene); ClassDB::bind_method(D_METHOD("get_current_scene"), &SceneTree::get_current_scene); ClassDB::bind_method(D_METHOD("change_scene", "path"), &SceneTree::change_scene); ClassDB::bind_method(D_METHOD("change_scene_to", "packed_scene"), &SceneTree::change_scene_to); ClassDB::bind_method(D_METHOD("reload_current_scene"), &SceneTree::reload_current_scene); ClassDB::bind_method(D_METHOD("_change_scene"), &SceneTree::_change_scene); ClassDB::bind_method(D_METHOD("set_multiplayer", "multiplayer"), &SceneTree::set_multiplayer); ClassDB::bind_method(D_METHOD("get_multiplayer"), &SceneTree::get_multiplayer); ClassDB::bind_method(D_METHOD("set_multiplayer_poll_enabled", "enabled"), &SceneTree::set_multiplayer_poll_enabled); ClassDB::bind_method(D_METHOD("is_multiplayer_poll_enabled"), &SceneTree::is_multiplayer_poll_enabled); ClassDB::bind_method(D_METHOD("set_network_peer", "peer"), &SceneTree::set_network_peer); ClassDB::bind_method(D_METHOD("get_network_peer"), &SceneTree::get_network_peer); ClassDB::bind_method(D_METHOD("is_network_server"), &SceneTree::is_network_server); ClassDB::bind_method(D_METHOD("has_network_peer"), &SceneTree::has_network_peer); ClassDB::bind_method(D_METHOD("get_network_connected_peers"), &SceneTree::get_network_connected_peers); ClassDB::bind_method(D_METHOD("get_network_unique_id"), &SceneTree::get_network_unique_id); ClassDB::bind_method(D_METHOD("get_rpc_sender_id"), &SceneTree::get_rpc_sender_id); ClassDB::bind_method(D_METHOD("set_refuse_new_network_connections", "refuse"), &SceneTree::set_refuse_new_network_connections); ClassDB::bind_method(D_METHOD("is_refusing_new_network_connections"), &SceneTree::is_refusing_new_network_connections); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "debug_collisions_hint"), "set_debug_collisions_hint", "is_debugging_collisions_hint"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "debug_navigation_hint"), "set_debug_navigation_hint", "is_debugging_navigation_hint"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "paused"), "set_pause", "is_paused"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "refuse_new_network_connections"), "set_refuse_new_network_connections", "is_refusing_new_network_connections"); ADD_PROPERTY_DEFAULT("refuse_new_network_connections", false); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "edited_scene_root", PROPERTY_HINT_RESOURCE_TYPE, "Node", 0), "set_edited_scene_root", "get_edited_scene_root"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "current_scene", PROPERTY_HINT_RESOURCE_TYPE, "Node", 0), "set_current_scene", "get_current_scene"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "network_peer", PROPERTY_HINT_RESOURCE_TYPE, "NetworkedMultiplayerPeer", 0), "set_network_peer", "get_network_peer"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "root", PROPERTY_HINT_RESOURCE_TYPE, "Node", 0), "", "get_root"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "multiplayer", PROPERTY_HINT_RESOURCE_TYPE, "MultiplayerAPI", 0), "set_multiplayer", "get_multiplayer"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "multiplayer_poll"), "set_multiplayer_poll_enabled", "is_multiplayer_poll_enabled"); ADD_SIGNAL(MethodInfo("tree_changed")); ADD_SIGNAL(MethodInfo("node_added", PropertyInfo(Variant::OBJECT, "node", PROPERTY_HINT_RESOURCE_TYPE, "Node"))); ADD_SIGNAL(MethodInfo("node_removed", PropertyInfo(Variant::OBJECT, "node", PROPERTY_HINT_RESOURCE_TYPE, "Node"))); ADD_SIGNAL(MethodInfo("node_renamed", PropertyInfo(Variant::OBJECT, "node", PROPERTY_HINT_RESOURCE_TYPE, "Node"))); ADD_SIGNAL(MethodInfo("node_configuration_warning_changed", PropertyInfo(Variant::OBJECT, "node", PROPERTY_HINT_RESOURCE_TYPE, "Node"))); ADD_SIGNAL(MethodInfo("idle_frame")); ADD_SIGNAL(MethodInfo("physics_frame")); ADD_SIGNAL(MethodInfo("files_dropped", PropertyInfo(Variant::PACKED_STRING_ARRAY, "files"), PropertyInfo(Variant::INT, "screen"))); ADD_SIGNAL(MethodInfo("network_peer_connected", PropertyInfo(Variant::INT, "id"))); ADD_SIGNAL(MethodInfo("network_peer_disconnected", PropertyInfo(Variant::INT, "id"))); ADD_SIGNAL(MethodInfo("connected_to_server")); ADD_SIGNAL(MethodInfo("connection_failed")); ADD_SIGNAL(MethodInfo("server_disconnected")); BIND_ENUM_CONSTANT(GROUP_CALL_DEFAULT); BIND_ENUM_CONSTANT(GROUP_CALL_REVERSE); BIND_ENUM_CONSTANT(GROUP_CALL_REALTIME); BIND_ENUM_CONSTANT(GROUP_CALL_UNIQUE); } SceneTree *SceneTree::singleton = nullptr; SceneTree::IdleCallback SceneTree::idle_callbacks[SceneTree::MAX_IDLE_CALLBACKS]; int SceneTree::idle_callback_count = 0; void SceneTree::_call_idle_callbacks() { for (int i = 0; i < idle_callback_count; i++) { idle_callbacks[i](); } } void SceneTree::add_idle_callback(IdleCallback p_callback) { ERR_FAIL_COND(idle_callback_count >= MAX_IDLE_CALLBACKS); idle_callbacks[idle_callback_count++] = p_callback; } void SceneTree::get_argument_options(const StringName &p_function, int p_idx, List *r_options) const { if (p_function == "change_scene") { DirAccessRef dir_access = DirAccess::create(DirAccess::ACCESS_RESOURCES); List directories; directories.push_back(dir_access->get_current_dir()); while (!directories.empty()) { dir_access->change_dir(directories.back()->get()); directories.pop_back(); dir_access->list_dir_begin(); String filename = dir_access->get_next(); while (filename != "") { if (filename == "." || filename == "..") { filename = dir_access->get_next(); continue; } if (dir_access->dir_exists(filename)) { directories.push_back(dir_access->get_current_dir().plus_file(filename)); } else if (filename.ends_with(".tscn") || filename.ends_with(".scn")) { r_options->push_back("\"" + dir_access->get_current_dir().plus_file(filename) + "\""); } filename = dir_access->get_next(); } } } } SceneTree::SceneTree() { if (singleton == nullptr) { singleton = this; } _quit = false; accept_quit = true; quit_on_go_back = true; initialized = false; #ifdef DEBUG_ENABLED debug_collisions_hint = false; debug_navigation_hint = false; #endif debug_collisions_color = GLOBAL_DEF("debug/shapes/collision/shape_color", Color(0.0, 0.6, 0.7, 0.5)); debug_collision_contact_color = GLOBAL_DEF("debug/shapes/collision/contact_color", Color(1.0, 0.2, 0.1, 0.8)); debug_navigation_color = GLOBAL_DEF("debug/shapes/navigation/geometry_color", Color(0.1, 1.0, 0.7, 0.4)); debug_navigation_disabled_color = GLOBAL_DEF("debug/shapes/navigation/disabled_geometry_color", Color(1.0, 0.7, 0.1, 0.4)); collision_debug_contacts = GLOBAL_DEF("debug/shapes/collision/max_contacts_displayed", 10000); ProjectSettings::get_singleton()->set_custom_property_info("debug/shapes/collision/max_contacts_displayed", PropertyInfo(Variant::INT, "debug/shapes/collision/max_contacts_displayed", PROPERTY_HINT_RANGE, "0,20000,1")); // No negative tree_version = 1; physics_process_time = 1; idle_process_time = 1; root = nullptr; pause = false; current_frame = 0; tree_changed_name = "tree_changed"; node_added_name = "node_added"; node_removed_name = "node_removed"; node_renamed_name = "node_renamed"; ugc_locked = false; call_lock = 0; root_lock = 0; node_count = 0; //create with mainloop root = memnew(Window); root->set_name("root"); if (!root->get_world_3d().is_valid()) { root->set_world_3d(Ref(memnew(World3D))); } // Initialize network state multiplayer_poll = true; set_multiplayer(Ref(memnew(MultiplayerAPI))); //root->set_world_2d( Ref( memnew( World2D ))); root->set_as_audio_listener(true); root->set_as_audio_listener_2d(true); current_scene = nullptr; int msaa_mode = GLOBAL_DEF("rendering/quality/screen_filters/msaa", 0); ProjectSettings::get_singleton()->set_custom_property_info("rendering/quality/screen_filters/msaa", PropertyInfo(Variant::INT, "rendering/quality/screen_filters/msaa", PROPERTY_HINT_ENUM, "Disabled (Fastest),2x (Fast),4x (Average),8x (Slow),16x (Slower)")); root->set_msaa(Viewport::MSAA(msaa_mode)); int ssaa_mode = GLOBAL_DEF("rendering/quality/screen_filters/screen_space_aa", 0); ProjectSettings::get_singleton()->set_custom_property_info("rendering/quality/screen_filters/screen_space_aa", PropertyInfo(Variant::INT, "rendering/quality/screen_filters/screen_space_aa", PROPERTY_HINT_ENUM, "Disabled (Fastest),FXAA (Fast)")); root->set_screen_space_aa(Viewport::ScreenSpaceAA(ssaa_mode)); { //load default fallback environment //get possible extensions List exts; ResourceLoader::get_recognized_extensions_for_type("Environment", &exts); String ext_hint; for (List::Element *E = exts.front(); E; E = E->next()) { if (ext_hint != String()) { ext_hint += ","; } ext_hint += "*." + E->get(); } //get path String env_path = GLOBAL_DEF("rendering/environment/default_environment", ""); //setup property ProjectSettings::get_singleton()->set_custom_property_info("rendering/environment/default_environment", PropertyInfo(Variant::STRING, "rendering/viewport/default_environment", PROPERTY_HINT_FILE, ext_hint)); env_path = env_path.strip_edges(); if (env_path != String()) { Ref env = ResourceLoader::load(env_path); if (env.is_valid()) { root->get_world_3d()->set_fallback_environment(env); } else { if (Engine::get_singleton()->is_editor_hint()) { //file was erased, clear the field. ProjectSettings::get_singleton()->set("rendering/environment/default_environment", ""); } else { //file was erased, notify user. ERR_PRINT(RTR("Default Environment as specified in Project Settings (Rendering -> Environment -> Default Environment) could not be loaded.")); } } } } root->set_physics_object_picking(GLOBAL_DEF("physics/common/enable_object_picking", true)); root->connect("close_requested", callable_mp(this, &SceneTree::_main_window_close)); root->connect("go_back_requested", callable_mp(this, &SceneTree::_main_window_go_back)); root->connect("focus_entered", callable_mp(this, &SceneTree::_main_window_focus_in)); #ifdef TOOLS_ENABLED edited_scene_root = nullptr; #endif } SceneTree::~SceneTree() { if (root) { root->_set_tree(nullptr); root->_propagate_after_exit_tree(); memdelete(root); } if (singleton == this) { singleton = nullptr; } }