Natalie Martin
5ccc031eca
The `EditorAutoloadSettings` class does not expect an autoload node to be freed in between its initial instantiation and any calls to `update_autoload()`. But this actually *can* happen if the autoload is an editor script and happens to run something like `queue_free()` shortly after being initialized. When this happens, opening the project settings panel results in a crash, since the editor is trying to locate data such as the node's script after it has already been deleted. To fix this, just verify that the node still exists prior to accessing any of the node's data. (cherry picked from commit 90d0be8fa34f69bd7cf3a40432a2504234fa5797)
956 lines
31 KiB
C++
956 lines
31 KiB
C++
/**************************************************************************/
|
|
/* editor_autoload_settings.cpp */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* 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 "editor_autoload_settings.h"
|
|
|
|
#include "core/config/project_settings.h"
|
|
#include "core/core_constants.h"
|
|
#include "core/io/resource_loader.h"
|
|
#include "core/io/resource_saver.h"
|
|
#include "core/object/callable_mp.h"
|
|
#include "core/object/class_db.h"
|
|
#include "editor/docks/filesystem_dock.h"
|
|
#include "editor/editor_node.h"
|
|
#include "editor/editor_undo_redo_manager.h"
|
|
#include "editor/gui/editor_file_dialog.h"
|
|
#include "editor/scene/scene_create_dialog.h"
|
|
#include "editor/settings/project_settings_editor.h"
|
|
#include "scene/gui/button.h"
|
|
#include "scene/gui/tree.h"
|
|
#include "scene/main/scene_tree.h"
|
|
#include "scene/main/window.h"
|
|
#include "scene/resources/packed_scene.h"
|
|
|
|
#define PREVIEW_LIST_MAX_SIZE 10
|
|
|
|
void EditorAutoloadSettings::_notification(int p_what) {
|
|
switch (p_what) {
|
|
case NOTIFICATION_ENTER_TREE: {
|
|
List<String> afn;
|
|
ResourceLoader::get_recognized_extensions_for_type("PackedScene", &afn);
|
|
|
|
for (const String &E : afn) {
|
|
scene_file_dialog->add_filter("*." + E);
|
|
}
|
|
|
|
ResourceLoader::get_recognized_extensions_for_type("Script", &afn);
|
|
|
|
for (const String &E : afn) {
|
|
autoload_file_dialog->add_filter("*." + E);
|
|
}
|
|
} break;
|
|
|
|
case NOTIFICATION_THEME_CHANGED: {
|
|
browse_button->set_button_icon(get_editor_theme_icon(SNAME("FileBrowse")));
|
|
create_script_autoload->set_button_icon(get_editor_theme_icon(SNAME("Add")));
|
|
create_scene_autoload->set_button_icon(get_editor_theme_icon(SNAME("Add")));
|
|
} break;
|
|
}
|
|
}
|
|
|
|
bool EditorAutoloadSettings::_autoload_name_is_valid(const String &p_name, String *r_error) {
|
|
if (!p_name.is_valid_unicode_identifier()) {
|
|
if (r_error) {
|
|
*r_error = TTR("Must be a valid Unicode identifier.");
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
if (ClassDB::class_exists(p_name)) {
|
|
if (r_error) {
|
|
*r_error = TTR("Must not collide with an existing engine class name.");
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
if (ScriptServer::is_global_class(p_name)) {
|
|
if (r_error) {
|
|
*r_error = TTR("Must not collide with an existing global script class name.");
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
if (Variant::get_type_by_name(p_name) < Variant::VARIANT_MAX) {
|
|
if (r_error) {
|
|
*r_error = TTR("Must not collide with an existing built-in type name.");
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
for (int i = 0; i < CoreConstants::get_global_constant_count(); i++) {
|
|
if (CoreConstants::get_global_constant_name(i) == p_name) {
|
|
if (r_error) {
|
|
*r_error = TTR("Must not collide with an existing global constant name.");
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
|
|
for (const String &keyword : ScriptServer::get_language(i)->get_reserved_words()) {
|
|
if (keyword == p_name) {
|
|
if (r_error) {
|
|
*r_error = TTR("Keyword cannot be used as an Autoload name.");
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
void EditorAutoloadSettings::_autoload_selected() {
|
|
TreeItem *ti = tree->get_selected();
|
|
|
|
if (!ti) {
|
|
return;
|
|
}
|
|
|
|
selected_autoload = "autoload/" + ti->get_text(0);
|
|
}
|
|
|
|
void EditorAutoloadSettings::_autoload_edited() {
|
|
if (updating_autoload) {
|
|
return;
|
|
}
|
|
|
|
TreeItem *ti = tree->get_edited();
|
|
int column = tree->get_edited_column();
|
|
|
|
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
|
|
|
|
if (column == 0) {
|
|
String name = ti->get_text(0);
|
|
String old_name = selected_autoload.get_slicec('/', 1);
|
|
|
|
if (name == old_name) {
|
|
return;
|
|
}
|
|
|
|
String error;
|
|
if (!_autoload_name_is_valid(name, &error)) {
|
|
ti->set_text(0, old_name);
|
|
EditorNode::get_singleton()->show_warning(error);
|
|
return;
|
|
}
|
|
|
|
if (ProjectSettings::get_singleton()->has_setting("autoload/" + name)) {
|
|
ti->set_text(0, old_name);
|
|
EditorNode::get_singleton()->show_warning(vformat(TTR("Autoload '%s' already exists!"), name));
|
|
return;
|
|
}
|
|
|
|
updating_autoload = true;
|
|
|
|
name = "autoload/" + name;
|
|
|
|
int order = ProjectSettings::get_singleton()->get_order(selected_autoload);
|
|
String scr_path = GLOBAL_GET(selected_autoload);
|
|
|
|
undo_redo->create_action(TTR("Rename Autoload"));
|
|
|
|
undo_redo->add_do_property(ProjectSettings::get_singleton(), name, scr_path);
|
|
undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", name, order);
|
|
undo_redo->add_do_method(ProjectSettings::get_singleton(), "clear", selected_autoload);
|
|
|
|
undo_redo->add_undo_property(ProjectSettings::get_singleton(), selected_autoload, scr_path);
|
|
undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", selected_autoload, order);
|
|
undo_redo->add_undo_method(ProjectSettings::get_singleton(), "clear", name);
|
|
|
|
undo_redo->add_do_method(this, CoreStringName(call_deferred), "update_autoload");
|
|
undo_redo->add_undo_method(this, CoreStringName(call_deferred), "update_autoload");
|
|
|
|
undo_redo->add_do_method(this, "emit_signal", autoload_changed);
|
|
undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
|
|
|
|
undo_redo->commit_action();
|
|
|
|
selected_autoload = name;
|
|
} else if (column == 2) {
|
|
updating_autoload = true;
|
|
|
|
bool checked = ti->is_checked(2);
|
|
String base = "autoload/" + ti->get_text(0);
|
|
|
|
int order = ProjectSettings::get_singleton()->get_order(base);
|
|
String scr_path = GLOBAL_GET(base);
|
|
|
|
if (scr_path.begins_with("*")) {
|
|
scr_path = scr_path.substr(1);
|
|
}
|
|
|
|
// Singleton autoloads are represented with a leading "*" in their path.
|
|
if (checked) {
|
|
scr_path = "*" + scr_path;
|
|
}
|
|
|
|
undo_redo->create_action(TTR("Toggle Autoload Globals"));
|
|
|
|
undo_redo->add_do_property(ProjectSettings::get_singleton(), base, scr_path);
|
|
undo_redo->add_undo_property(ProjectSettings::get_singleton(), base, GLOBAL_GET(base));
|
|
|
|
undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", base, order);
|
|
undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", base, order);
|
|
|
|
undo_redo->add_do_method(this, CoreStringName(call_deferred), "update_autoload");
|
|
undo_redo->add_undo_method(this, CoreStringName(call_deferred), "update_autoload");
|
|
|
|
undo_redo->add_do_method(this, "emit_signal", autoload_changed);
|
|
undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
|
|
|
|
undo_redo->commit_action();
|
|
}
|
|
|
|
updating_autoload = false;
|
|
}
|
|
|
|
void EditorAutoloadSettings::_autoload_button_pressed(Object *p_item, int p_column, int p_button, MouseButton p_mouse_button) {
|
|
if (p_mouse_button != MouseButton::LEFT) {
|
|
return;
|
|
}
|
|
TreeItem *ti = Object::cast_to<TreeItem>(p_item);
|
|
|
|
String name = "autoload/" + ti->get_text(0);
|
|
|
|
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
|
|
|
|
switch (p_button) {
|
|
case BUTTON_MOVE_UP:
|
|
case BUTTON_MOVE_DOWN: {
|
|
TreeItem *swap = nullptr;
|
|
|
|
if (p_button == BUTTON_MOVE_UP) {
|
|
swap = ti->get_prev();
|
|
} else {
|
|
swap = ti->get_next();
|
|
}
|
|
|
|
if (!swap) {
|
|
return;
|
|
}
|
|
|
|
String swap_name = "autoload/" + swap->get_text(0);
|
|
|
|
int order = ProjectSettings::get_singleton()->get_order(name);
|
|
int swap_order = ProjectSettings::get_singleton()->get_order(swap_name);
|
|
|
|
undo_redo->create_action(TTR("Move Autoload"));
|
|
|
|
undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", name, swap_order);
|
|
undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", name, order);
|
|
|
|
undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", swap_name, order);
|
|
undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", swap_name, swap_order);
|
|
|
|
undo_redo->add_do_method(this, "update_autoload");
|
|
undo_redo->add_undo_method(this, "update_autoload");
|
|
|
|
undo_redo->add_do_method(this, "emit_signal", autoload_changed);
|
|
undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
|
|
|
|
undo_redo->commit_action();
|
|
} break;
|
|
case BUTTON_DELETE: {
|
|
int order = ProjectSettings::get_singleton()->get_order(name);
|
|
|
|
undo_redo->create_action(TTR("Remove Autoload"));
|
|
|
|
undo_redo->add_do_property(ProjectSettings::get_singleton(), name, Variant());
|
|
|
|
undo_redo->add_undo_property(ProjectSettings::get_singleton(), name, GLOBAL_GET(name));
|
|
undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", name, order);
|
|
|
|
undo_redo->add_do_method(this, "update_autoload");
|
|
undo_redo->add_undo_method(this, "update_autoload");
|
|
|
|
undo_redo->add_do_method(this, "emit_signal", autoload_changed);
|
|
undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
|
|
|
|
undo_redo->commit_action();
|
|
} break;
|
|
}
|
|
}
|
|
|
|
void EditorAutoloadSettings::_autoload_activated() {
|
|
TreeItem *ti = tree->get_selected();
|
|
if (!ti) {
|
|
return;
|
|
}
|
|
_autoload_open(ti->get_text(1));
|
|
}
|
|
|
|
void EditorAutoloadSettings::_autoload_open(const String &fpath) {
|
|
EditorNode::get_singleton()->load_scene_or_resource(fpath);
|
|
ProjectSettingsEditor::get_singleton()->hide();
|
|
}
|
|
|
|
Node *EditorAutoloadSettings::_create_autoload(const String &p_path) {
|
|
Node *n = nullptr;
|
|
if (ResourceLoader::get_resource_type(p_path) == "PackedScene") {
|
|
// Cache the scene reference before loading it (for cyclic references)
|
|
Ref<PackedScene> scn;
|
|
scn.instantiate();
|
|
scn->set_path(ResourceUID::ensure_path(p_path));
|
|
scn->reload_from_file();
|
|
ERR_FAIL_COND_V_MSG(scn.is_null(), nullptr, vformat("Failed to create an autoload, can't load from UID or path: %s.", p_path));
|
|
|
|
if (scn.is_valid()) {
|
|
n = scn->instantiate();
|
|
}
|
|
} else {
|
|
Ref<Resource> res = ResourceLoader::load(p_path);
|
|
ERR_FAIL_COND_V_MSG(res.is_null(), nullptr, vformat("Failed to create an autoload, can't load from UID or path: %s.", p_path));
|
|
|
|
Ref<Script> scr = res;
|
|
if (scr.is_valid()) {
|
|
ERR_FAIL_COND_V_MSG(!scr->is_valid(), nullptr, vformat("Failed to create an autoload, script '%s' is not compiling.", p_path));
|
|
|
|
StringName ibt = scr->get_instance_base_type();
|
|
bool valid_type = ClassDB::is_parent_class(ibt, "Node");
|
|
ERR_FAIL_COND_V_MSG(!valid_type, nullptr, vformat("Failed to create an autoload, script '%s' does not inherit from 'Node'.", p_path));
|
|
|
|
Object *obj = ClassDB::instantiate(ibt);
|
|
ERR_FAIL_NULL_V_MSG(obj, nullptr, vformat("Failed to create an autoload, cannot instantiate '%s'.", ibt));
|
|
|
|
n = Object::cast_to<Node>(obj);
|
|
n->set_script(scr);
|
|
}
|
|
}
|
|
|
|
ERR_FAIL_NULL_V_MSG(n, nullptr, vformat("Failed to create an autoload, path is not pointing to a scene or a script: %s.", p_path));
|
|
|
|
return n;
|
|
}
|
|
void EditorAutoloadSettings::_create_script_autoload() {
|
|
if (!script_create_dialog) {
|
|
script_create_dialog = memnew(ScriptCreateDialog);
|
|
add_child(script_create_dialog);
|
|
script_create_dialog->connect("script_created", callable_mp(this, &EditorAutoloadSettings::_script_created));
|
|
}
|
|
script_create_dialog->config("Node", "res://new_autoload_script.gd", false, false);
|
|
script_create_dialog->popup_centered();
|
|
}
|
|
|
|
void EditorAutoloadSettings::_create_scene_autoload() {
|
|
scene_file_dialog->set_current_file("new_autoload_scene.tscn");
|
|
scene_file_dialog->popup_file_dialog();
|
|
}
|
|
|
|
void EditorAutoloadSettings::init_autoloads() {
|
|
for (AutoloadInfo &info : autoload_cache) {
|
|
info.node = _create_autoload(ResourceUID::ensure_path(info.path));
|
|
|
|
if (info.node) {
|
|
Ref<Script> scr = info.node->get_script();
|
|
info.in_editor = scr.is_valid() && scr->is_tool();
|
|
info.node->set_name(info.name);
|
|
}
|
|
|
|
if (info.is_singleton) {
|
|
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
|
|
ScriptServer::get_language(i)->add_named_global_constant(info.name, info.node);
|
|
}
|
|
}
|
|
|
|
if (!info.is_singleton && !info.in_editor && info.node != nullptr) {
|
|
memdelete(info.node);
|
|
info.node = nullptr;
|
|
}
|
|
}
|
|
|
|
for (const AutoloadInfo &info : autoload_cache) {
|
|
if (info.node && info.in_editor) {
|
|
// It's important to add the node without deferring because code in plugins or tool scripts
|
|
// could use the autoload node when they are enabled.
|
|
get_tree()->get_root()->add_child(info.node);
|
|
}
|
|
}
|
|
}
|
|
|
|
void EditorAutoloadSettings::_autoload_file_selected(const String &p_path) {
|
|
_add_autoload(p_path.get_file().get_basename(), p_path);
|
|
}
|
|
|
|
void EditorAutoloadSettings::_scene_file_selected(const String &p_path) {
|
|
if (!scene_create_dialog) {
|
|
scene_create_dialog = memnew(SceneCreateDialog);
|
|
add_child(scene_create_dialog);
|
|
scene_create_dialog->connect(SceneStringName(confirmed), callable_mp(this, &EditorAutoloadSettings::_scene_created));
|
|
}
|
|
scene_create_dialog->config(p_path.get_base_dir(), p_path.get_file().get_basename());
|
|
scene_create_dialog->popup_centered();
|
|
}
|
|
|
|
void EditorAutoloadSettings::_script_created(Ref<Script> p_script) {
|
|
FileSystemDock::get_singleton()->get_script_create_dialog()->hide();
|
|
path = p_script->get_path().get_base_dir();
|
|
_add_autoload(p_script->get_path().get_file().get_basename(), p_script->get_path());
|
|
}
|
|
|
|
void EditorAutoloadSettings::_scene_created() {
|
|
Node *root = scene_create_dialog->create_scene_root();
|
|
|
|
Ref<PackedScene> ps;
|
|
ps.instantiate();
|
|
ps->pack(root);
|
|
|
|
Error err = ResourceSaver::save(ps, scene_create_dialog->get_scene_path());
|
|
if (err != OK) {
|
|
EditorNode::get_singleton()->show_warning(vformat(TTR("Failed to create scene. Error: %d."), err));
|
|
return;
|
|
}
|
|
|
|
_add_autoload(scene_create_dialog->get_root_name(), scene_create_dialog->get_scene_path());
|
|
}
|
|
|
|
void EditorAutoloadSettings::_add_autoload(const String &p_name, const String &p_path) {
|
|
// Convert the file name to PascalCase, which is the convention for classes in GDScript.
|
|
String autoload_name = p_name.to_pascal_case();
|
|
|
|
// If the name collides with a built-in class, prefix the name to make it possible to add without having to edit the name.
|
|
// The prefix is subjective, but it provides better UX than throwing an error :)
|
|
if (ClassDB::class_exists(autoload_name)) {
|
|
autoload_name += "Global";
|
|
}
|
|
|
|
autoload_name = autoload_name.validate_ascii_identifier();
|
|
autoload_add(autoload_name, p_path);
|
|
}
|
|
|
|
void EditorAutoloadSettings::update_autoload() {
|
|
if (updating_autoload) {
|
|
return;
|
|
}
|
|
|
|
updating_autoload = true;
|
|
|
|
HashMap<String, AutoloadInfo> to_remove;
|
|
List<AutoloadInfo *> to_add;
|
|
|
|
for (const AutoloadInfo &info : autoload_cache) {
|
|
to_remove.insert(info.name, info);
|
|
}
|
|
|
|
autoload_cache.clear();
|
|
|
|
tree->clear();
|
|
TreeItem *root = tree->create_item();
|
|
|
|
List<PropertyInfo> props;
|
|
ProjectSettings::get_singleton()->get_property_list(&props);
|
|
|
|
for (const PropertyInfo &pi : props) {
|
|
if (!pi.name.begins_with("autoload/")) {
|
|
continue;
|
|
}
|
|
|
|
String name = pi.name.get_slicec('/', 1);
|
|
String scr_path = GLOBAL_GET(pi.name);
|
|
|
|
if (name.is_empty()) {
|
|
continue;
|
|
}
|
|
|
|
AutoloadInfo info;
|
|
info.is_singleton = scr_path.begins_with("*");
|
|
|
|
if (info.is_singleton) {
|
|
scr_path = scr_path.substr(1);
|
|
}
|
|
|
|
info.name = name;
|
|
info.path = ResourceUID::get_singleton()->path_to_uid(scr_path);
|
|
info.order = ProjectSettings::get_singleton()->get_order(pi.name);
|
|
|
|
bool need_to_add = true;
|
|
if (to_remove.has(name)) {
|
|
AutoloadInfo &old_info = to_remove[name];
|
|
if (old_info.path == info.path) {
|
|
// Still the same resource, check status
|
|
info.node = old_info.node;
|
|
if (info.node && info.node->is_instance()) {
|
|
Ref<Script> scr = info.node->get_script();
|
|
info.in_editor = scr.is_valid() && scr->is_tool();
|
|
if (info.is_singleton == old_info.is_singleton && info.in_editor == old_info.in_editor) {
|
|
to_remove.erase(name);
|
|
need_to_add = false;
|
|
} else {
|
|
info.node = nullptr;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
autoload_cache.push_back(info);
|
|
|
|
if (need_to_add) {
|
|
to_add.push_back(&(autoload_cache.back()->get()));
|
|
}
|
|
|
|
TreeItem *item = tree->create_item(root);
|
|
item->set_text(0, name);
|
|
item->set_auto_translate_mode(0, AUTO_TRANSLATE_MODE_DISABLED); // For tooltip.
|
|
item->set_editable(0, true);
|
|
|
|
item->set_text(1, ResourceUID::ensure_path(scr_path));
|
|
item->set_selectable(1, true);
|
|
|
|
item->set_cell_mode(2, TreeItem::CELL_MODE_CHECK);
|
|
item->set_editable(2, true);
|
|
item->set_text(2, TTRC("Enable"));
|
|
item->set_checked(2, info.is_singleton);
|
|
item->add_button(3, get_editor_theme_icon(SNAME("MoveUp")), BUTTON_MOVE_UP);
|
|
item->add_button(3, get_editor_theme_icon(SNAME("MoveDown")), BUTTON_MOVE_DOWN);
|
|
item->add_button(3, get_editor_theme_icon(SNAME("Remove")), BUTTON_DELETE);
|
|
item->set_selectable(3, false);
|
|
}
|
|
|
|
// Remove deleted/changed autoloads
|
|
for (KeyValue<String, AutoloadInfo> &E : to_remove) {
|
|
AutoloadInfo &info = E.value;
|
|
if (info.is_singleton) {
|
|
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
|
|
ScriptServer::get_language(i)->remove_named_global_constant(info.name);
|
|
}
|
|
}
|
|
if (info.in_editor) {
|
|
ERR_CONTINUE(!info.node);
|
|
callable_mp((Node *)get_tree()->get_root(), &Node::remove_child).call_deferred(info.node);
|
|
}
|
|
|
|
if (info.node) {
|
|
info.node->queue_free();
|
|
info.node = nullptr;
|
|
}
|
|
}
|
|
|
|
// Load new/changed autoloads
|
|
List<Node *> nodes_to_add;
|
|
for (AutoloadInfo *info : to_add) {
|
|
info->node = _create_autoload(info->path);
|
|
|
|
ERR_CONTINUE(!info->node);
|
|
info->node->set_name(info->name);
|
|
|
|
Ref<Script> scr = info->node->get_script();
|
|
info->in_editor = scr.is_valid() && scr->is_tool();
|
|
|
|
if (info->in_editor) {
|
|
//defer so references are all valid on _ready()
|
|
nodes_to_add.push_back(info->node);
|
|
}
|
|
|
|
if (info->is_singleton) {
|
|
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
|
|
ScriptServer::get_language(i)->add_named_global_constant(info->name, info->node);
|
|
}
|
|
}
|
|
|
|
if (!info->in_editor && !info->is_singleton) {
|
|
// No reason to keep this node
|
|
memdelete(info->node);
|
|
info->node = nullptr;
|
|
}
|
|
}
|
|
|
|
for (Node *E : nodes_to_add) {
|
|
get_tree()->get_root()->add_child(E);
|
|
}
|
|
|
|
updating_autoload = false;
|
|
}
|
|
|
|
Variant EditorAutoloadSettings::get_drag_data_fw(const Point2 &p_point, Control *p_control) {
|
|
if (autoload_cache.size() <= 1) {
|
|
return false;
|
|
}
|
|
|
|
PackedStringArray autoloads;
|
|
|
|
TreeItem *next = tree->get_next_selected(nullptr);
|
|
|
|
while (next) {
|
|
autoloads.push_back(next->get_text(0));
|
|
next = tree->get_next_selected(next);
|
|
}
|
|
|
|
if (autoloads.is_empty() || autoloads.size() == autoload_cache.size()) {
|
|
return Variant();
|
|
}
|
|
|
|
VBoxContainer *preview = memnew(VBoxContainer);
|
|
|
|
int max_size = MIN(PREVIEW_LIST_MAX_SIZE, autoloads.size());
|
|
|
|
for (int i = 0; i < max_size; i++) {
|
|
Label *label = memnew(Label(autoloads[i]));
|
|
label->set_self_modulate(Color(1, 1, 1, Math::lerp(1, 0, float(i) / PREVIEW_LIST_MAX_SIZE)));
|
|
label->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
|
|
|
|
preview->add_child(label);
|
|
}
|
|
|
|
tree->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN);
|
|
tree->set_drag_preview(preview);
|
|
|
|
Dictionary drop_data;
|
|
drop_data["type"] = "autoload";
|
|
drop_data["autoloads"] = autoloads;
|
|
|
|
return drop_data;
|
|
}
|
|
|
|
bool EditorAutoloadSettings::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_control) const {
|
|
if (updating_autoload) {
|
|
return false;
|
|
}
|
|
|
|
Dictionary drop_data = p_data;
|
|
|
|
if (!drop_data.has("type")) {
|
|
return false;
|
|
}
|
|
|
|
if (drop_data.has("type")) {
|
|
TreeItem *ti = (p_point == Vector2(Math::INF, Math::INF)) ? tree->get_selected() : tree->get_item_at_position(p_point);
|
|
|
|
if (!ti) {
|
|
return false;
|
|
}
|
|
|
|
int section = (p_point == Vector2(Math::INF, Math::INF)) ? tree->get_drop_section_at_position(tree->get_item_rect(ti).position) : tree->get_drop_section_at_position(p_point);
|
|
|
|
return section >= -1;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
void EditorAutoloadSettings::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_control) {
|
|
TreeItem *ti = (p_point == Vector2(Math::INF, Math::INF)) ? tree->get_selected() : tree->get_item_at_position(p_point);
|
|
|
|
if (!ti) {
|
|
return;
|
|
}
|
|
|
|
int section = (p_point == Vector2(Math::INF, Math::INF)) ? tree->get_drop_section_at_position(tree->get_item_rect(ti).position) : tree->get_drop_section_at_position(p_point);
|
|
|
|
if (section < -1) {
|
|
return;
|
|
}
|
|
|
|
String name;
|
|
bool move_to_back = false;
|
|
|
|
if (section < 0) {
|
|
name = ti->get_text(0);
|
|
} else if (ti->get_next()) {
|
|
name = ti->get_next()->get_text(0);
|
|
} else {
|
|
name = ti->get_text(0);
|
|
move_to_back = true;
|
|
}
|
|
|
|
int order = ProjectSettings::get_singleton()->get_order("autoload/" + name);
|
|
|
|
AutoloadInfo aux;
|
|
List<AutoloadInfo>::Element *E = nullptr;
|
|
|
|
if (!move_to_back) {
|
|
aux.order = order;
|
|
E = autoload_cache.find(aux);
|
|
}
|
|
|
|
Dictionary drop_data = p_data;
|
|
PackedStringArray autoloads = drop_data["autoloads"];
|
|
|
|
// Store the initial order of the autoloads for comparison.
|
|
Vector<int> initial_orders;
|
|
initial_orders.resize(autoload_cache.size());
|
|
int idx = 0;
|
|
for (const AutoloadInfo &F : autoload_cache) {
|
|
initial_orders.write[idx++] = F.order;
|
|
}
|
|
|
|
// Perform the drag-and-drop operation.
|
|
Vector<int> orders;
|
|
orders.resize(autoload_cache.size());
|
|
|
|
for (int i = 0; i < autoloads.size(); i++) {
|
|
aux.order = ProjectSettings::get_singleton()->get_order("autoload/" + autoloads[i]);
|
|
|
|
List<AutoloadInfo>::Element *I = autoload_cache.find(aux);
|
|
|
|
if (move_to_back) {
|
|
autoload_cache.move_to_back(I);
|
|
} else if (E != I) {
|
|
autoload_cache.move_before(I, E);
|
|
} else if (E->next()) {
|
|
E = E->next();
|
|
} else {
|
|
break;
|
|
}
|
|
}
|
|
|
|
idx = 0;
|
|
for (const AutoloadInfo &F : autoload_cache) {
|
|
orders.write[idx++] = F.order;
|
|
}
|
|
|
|
// If the order didn't change, we shouldn't create undo/redo actions.
|
|
if (orders == initial_orders) {
|
|
return;
|
|
}
|
|
|
|
orders.sort();
|
|
|
|
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
|
|
|
|
undo_redo->create_action(TTR("Rearrange Autoloads"));
|
|
|
|
idx = 0;
|
|
for (const AutoloadInfo &F : autoload_cache) {
|
|
undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", "autoload/" + F.name, orders[idx++]);
|
|
undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", "autoload/" + F.name, F.order);
|
|
}
|
|
|
|
orders.clear();
|
|
|
|
undo_redo->add_do_method(this, "update_autoload");
|
|
undo_redo->add_undo_method(this, "update_autoload");
|
|
|
|
undo_redo->add_do_method(this, "emit_signal", autoload_changed);
|
|
undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
|
|
|
|
undo_redo->commit_action();
|
|
}
|
|
|
|
bool EditorAutoloadSettings::autoload_add(const String &p_name, const String &p_path) {
|
|
String name = p_name;
|
|
|
|
String error;
|
|
if (!_autoload_name_is_valid(name, &error)) {
|
|
EditorNode::get_singleton()->show_warning(TTR("Can't add Autoload:") + "\n" + vformat(TTR("%s is an invalid name."), p_name) + " " + error);
|
|
return false;
|
|
}
|
|
|
|
if (!FileAccess::exists(p_path)) {
|
|
EditorNode::get_singleton()->show_warning(TTR("Can't add Autoload:") + "\n" + vformat(TTR("%s is an invalid path. File does not exist."), p_path));
|
|
return false;
|
|
}
|
|
|
|
if (!p_path.begins_with("res://")) {
|
|
EditorNode::get_singleton()->show_warning(TTR("Can't add Autoload:") + "\n" + vformat(TTR("%s is an invalid path. Not in resource path (res://)."), p_path));
|
|
return false;
|
|
}
|
|
|
|
name = "autoload/" + name;
|
|
|
|
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
|
|
|
|
undo_redo->create_action(TTR("Add Autoload"));
|
|
// Singleton autoloads are represented with a leading "*" in their path.
|
|
undo_redo->add_do_property(ProjectSettings::get_singleton(), name, "*" + ResourceUID::get_singleton()->path_to_uid(p_path));
|
|
|
|
if (ProjectSettings::get_singleton()->has_setting(name)) {
|
|
undo_redo->add_undo_property(ProjectSettings::get_singleton(), name, GLOBAL_GET(name));
|
|
} else {
|
|
undo_redo->add_undo_property(ProjectSettings::get_singleton(), name, Variant());
|
|
}
|
|
|
|
undo_redo->add_do_method(this, "update_autoload");
|
|
undo_redo->add_undo_method(this, "update_autoload");
|
|
|
|
undo_redo->add_do_method(this, "emit_signal", autoload_changed);
|
|
undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
|
|
|
|
undo_redo->commit_action();
|
|
|
|
return true;
|
|
}
|
|
|
|
void EditorAutoloadSettings::autoload_remove(const String &p_name) {
|
|
String name = "autoload/" + p_name;
|
|
|
|
EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
|
|
|
|
int order = ProjectSettings::get_singleton()->get_order(name);
|
|
|
|
undo_redo->create_action(TTR("Remove Autoload"));
|
|
|
|
undo_redo->add_do_property(ProjectSettings::get_singleton(), name, Variant());
|
|
|
|
undo_redo->add_undo_property(ProjectSettings::get_singleton(), name, GLOBAL_GET(name));
|
|
undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", name, order);
|
|
|
|
undo_redo->add_do_method(this, "update_autoload");
|
|
undo_redo->add_undo_method(this, "update_autoload");
|
|
|
|
undo_redo->add_do_method(this, "emit_signal", autoload_changed);
|
|
undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
|
|
|
|
undo_redo->commit_action();
|
|
}
|
|
|
|
void EditorAutoloadSettings::_bind_methods() {
|
|
ClassDB::bind_method("update_autoload", &EditorAutoloadSettings::update_autoload);
|
|
ClassDB::bind_method("autoload_add", &EditorAutoloadSettings::autoload_add);
|
|
ClassDB::bind_method("autoload_remove", &EditorAutoloadSettings::autoload_remove);
|
|
|
|
ADD_SIGNAL(MethodInfo("autoload_changed"));
|
|
}
|
|
|
|
EditorAutoloadSettings::EditorAutoloadSettings() {
|
|
ProjectSettings::get_singleton()->add_hidden_prefix("autoload/");
|
|
|
|
// Make first cache
|
|
List<PropertyInfo> props;
|
|
ProjectSettings::get_singleton()->get_property_list(&props);
|
|
for (const PropertyInfo &pi : props) {
|
|
if (!pi.name.begins_with("autoload/")) {
|
|
continue;
|
|
}
|
|
|
|
String name = pi.name.get_slicec('/', 1);
|
|
String scr_path = GLOBAL_GET(pi.name);
|
|
|
|
if (name.is_empty()) {
|
|
continue;
|
|
}
|
|
|
|
AutoloadInfo info;
|
|
info.is_singleton = scr_path.begins_with("*");
|
|
|
|
if (info.is_singleton) {
|
|
scr_path = scr_path.substr(1);
|
|
}
|
|
|
|
info.name = name;
|
|
info.path = ResourceUID::get_singleton()->path_to_uid(scr_path);
|
|
info.order = ProjectSettings::get_singleton()->get_order(pi.name);
|
|
|
|
if (info.is_singleton) {
|
|
// Make sure name references work before parsing scripts
|
|
for (int i = 0; i < ScriptServer::get_language_count(); i++) {
|
|
ScriptServer::get_language(i)->add_named_global_constant(info.name, Variant());
|
|
}
|
|
}
|
|
|
|
autoload_cache.push_back(info);
|
|
}
|
|
|
|
HBoxContainer *hbc = memnew(HBoxContainer);
|
|
add_child(hbc);
|
|
|
|
autoload_file_dialog = memnew(EditorFileDialog);
|
|
autoload_file_dialog->set_file_mode(FileDialog::FILE_MODE_OPEN_FILE);
|
|
hbc->add_child(autoload_file_dialog);
|
|
autoload_file_dialog->connect("file_selected", callable_mp(this, &EditorAutoloadSettings::_autoload_file_selected));
|
|
|
|
scene_file_dialog = memnew(EditorFileDialog);
|
|
scene_file_dialog->set_file_mode(FileDialog::FILE_MODE_SAVE_FILE);
|
|
hbc->add_child(scene_file_dialog);
|
|
scene_file_dialog->connect("file_selected", callable_mp(this, &EditorAutoloadSettings::_scene_file_selected));
|
|
|
|
browse_button = memnew(Button);
|
|
browse_button->set_text(TTRC("Select Script/Scene"));
|
|
hbc->add_child(browse_button);
|
|
browse_button->connect(SceneStringName(pressed), callable_mp(autoload_file_dialog, &FileDialog::popup_file_dialog));
|
|
|
|
create_script_autoload = memnew(Button);
|
|
create_script_autoload->set_text(TTRC("Create Script"));
|
|
hbc->add_child(create_script_autoload);
|
|
create_script_autoload->connect(SceneStringName(pressed), callable_mp(this, &EditorAutoloadSettings::_create_script_autoload));
|
|
|
|
create_scene_autoload = memnew(Button);
|
|
create_scene_autoload->set_text(TTRC("Create Scene"));
|
|
hbc->add_child(create_scene_autoload);
|
|
create_scene_autoload->connect(SceneStringName(pressed), callable_mp(this, &EditorAutoloadSettings::_create_scene_autoload));
|
|
|
|
MarginContainer *mc = memnew(MarginContainer);
|
|
mc->set_v_size_flags(SIZE_EXPAND_FILL);
|
|
mc->set_theme_type_variation("NoBorderHorizontalBottomWide");
|
|
add_child(mc);
|
|
|
|
tree = memnew(Tree);
|
|
tree->set_accessibility_name(TTRC("Autoloads"));
|
|
tree->set_hide_root(true);
|
|
tree->set_select_mode(Tree::SELECT_MULTI);
|
|
tree->set_allow_reselect(true);
|
|
|
|
SET_DRAG_FORWARDING_GCD(tree, EditorAutoloadSettings);
|
|
|
|
tree->set_theme_type_variation("TreeTable");
|
|
tree->set_hide_folding(true);
|
|
tree->set_columns(4);
|
|
tree->set_column_titles_visible(true);
|
|
|
|
tree->set_column_title(0, TTRC("Name"));
|
|
tree->set_column_title_tooltip_text(0, TTRC("Name of the autoload. Double-click to rename."));
|
|
tree->set_column_title_alignment(0, HORIZONTAL_ALIGNMENT_LEFT);
|
|
tree->set_column_expand(0, true);
|
|
tree->set_column_expand_ratio(0, 1);
|
|
|
|
tree->set_column_title(1, TTRC("Path"));
|
|
tree->set_column_title_tooltip_text(1, TTRC("Path to the autoload file. Double-click to open it."));
|
|
tree->set_column_title_alignment(1, HORIZONTAL_ALIGNMENT_LEFT);
|
|
tree->set_column_expand(1, true);
|
|
tree->set_column_clip_content(1, true);
|
|
tree->set_column_expand_ratio(1, 2);
|
|
|
|
tree->set_column_title(2, TTRC("Global Variable"));
|
|
tree->set_column_title_tooltip_text(2, TTRC("If enabled, this autoload can be accessed in scripts using its name."));
|
|
tree->set_column_expand(2, false);
|
|
|
|
tree->set_column_expand(3, false);
|
|
|
|
tree->connect("cell_selected", callable_mp(this, &EditorAutoloadSettings::_autoload_selected));
|
|
tree->connect("item_edited", callable_mp(this, &EditorAutoloadSettings::_autoload_edited));
|
|
tree->connect("button_clicked", callable_mp(this, &EditorAutoloadSettings::_autoload_button_pressed));
|
|
tree->connect("item_activated", callable_mp(this, &EditorAutoloadSettings::_autoload_activated));
|
|
|
|
mc->add_child(tree, true);
|
|
}
|
|
|
|
EditorAutoloadSettings::~EditorAutoloadSettings() {
|
|
for (const AutoloadInfo &info : autoload_cache) {
|
|
if (info.node && !info.in_editor) {
|
|
memdelete(info.node);
|
|
}
|
|
}
|
|
}
|