editor_autoload_settings.cpp 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999
  1. /**************************************************************************/
  2. /* editor_autoload_settings.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "editor_autoload_settings.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/core_constants.h"
  33. #include "editor/editor_node.h"
  34. #include "editor/editor_string_names.h"
  35. #include "editor/editor_undo_redo_manager.h"
  36. #include "editor/filesystem_dock.h"
  37. #include "editor/gui/editor_file_dialog.h"
  38. #include "editor/project_settings_editor.h"
  39. #include "scene/main/window.h"
  40. #include "scene/resources/packed_scene.h"
  41. #define PREVIEW_LIST_MAX_SIZE 10
  42. void EditorAutoloadSettings::_notification(int p_what) {
  43. switch (p_what) {
  44. case NOTIFICATION_ENTER_TREE: {
  45. List<String> afn;
  46. ResourceLoader::get_recognized_extensions_for_type("Script", &afn);
  47. ResourceLoader::get_recognized_extensions_for_type("PackedScene", &afn);
  48. for (const String &E : afn) {
  49. file_dialog->add_filter("*." + E);
  50. }
  51. browse_button->set_button_icon(get_editor_theme_icon(SNAME("Folder")));
  52. } break;
  53. case NOTIFICATION_TRANSLATION_CHANGED: {
  54. if (!error_message->get_text().is_empty()) {
  55. _autoload_text_changed(autoload_add_name->get_text());
  56. }
  57. } break;
  58. case NOTIFICATION_THEME_CHANGED: {
  59. browse_button->set_button_icon(get_editor_theme_icon(SNAME("Folder")));
  60. add_autoload->set_button_icon(get_editor_theme_icon(SNAME("Add")));
  61. } break;
  62. case NOTIFICATION_VISIBILITY_CHANGED: {
  63. FileSystemDock *dock = FileSystemDock::get_singleton();
  64. if (dock != nullptr) {
  65. ScriptCreateDialog *dialog = dock->get_script_create_dialog();
  66. if (dialog != nullptr) {
  67. Callable script_created = callable_mp(this, &EditorAutoloadSettings::_script_created);
  68. if (is_visible_in_tree()) {
  69. if (!dialog->is_connected(SNAME("script_created"), script_created)) {
  70. dialog->connect("script_created", script_created);
  71. }
  72. } else {
  73. if (dialog->is_connected(SNAME("script_created"), script_created)) {
  74. dialog->disconnect("script_created", script_created);
  75. }
  76. }
  77. }
  78. }
  79. } break;
  80. }
  81. }
  82. bool EditorAutoloadSettings::_autoload_name_is_valid(const String &p_name, String *r_error) {
  83. if (!p_name.is_valid_unicode_identifier()) {
  84. if (r_error) {
  85. *r_error = TTR("Invalid name.") + " " + TTR("Must be a valid Unicode identifier.");
  86. }
  87. return false;
  88. }
  89. if (ClassDB::class_exists(p_name)) {
  90. if (r_error) {
  91. *r_error = TTR("Invalid name.") + " " + TTR("Must not collide with an existing engine class name.");
  92. }
  93. return false;
  94. }
  95. if (ScriptServer::is_global_class(p_name)) {
  96. if (r_error) {
  97. *r_error = TTR("Invalid name.") + "\n" + TTR("Must not collide with an existing global script class name.");
  98. }
  99. return false;
  100. }
  101. if (Variant::get_type_by_name(p_name) < Variant::VARIANT_MAX) {
  102. if (r_error) {
  103. *r_error = TTR("Invalid name.") + " " + TTR("Must not collide with an existing built-in type name.");
  104. }
  105. return false;
  106. }
  107. for (int i = 0; i < CoreConstants::get_global_constant_count(); i++) {
  108. if (CoreConstants::get_global_constant_name(i) == p_name) {
  109. if (r_error) {
  110. *r_error = TTR("Invalid name.") + " " + TTR("Must not collide with an existing global constant name.");
  111. }
  112. return false;
  113. }
  114. }
  115. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  116. for (const String &keyword : ScriptServer::get_language(i)->get_reserved_words()) {
  117. if (keyword == p_name) {
  118. if (r_error) {
  119. *r_error = TTR("Invalid name.") + " " + TTR("Keyword cannot be used as an Autoload name.");
  120. }
  121. return false;
  122. }
  123. }
  124. }
  125. return true;
  126. }
  127. void EditorAutoloadSettings::_autoload_add() {
  128. if (autoload_add_path->get_text().is_empty()) {
  129. ScriptCreateDialog *dialog = FileSystemDock::get_singleton()->get_script_create_dialog();
  130. String fpath = path;
  131. if (!fpath.ends_with("/")) {
  132. fpath = fpath.get_base_dir();
  133. }
  134. dialog->config("Node", fpath.path_join(vformat("%s.gd", autoload_add_name->get_text())), false, false);
  135. dialog->popup_centered();
  136. } else {
  137. if (autoload_add(autoload_add_name->get_text(), autoload_add_path->get_text())) {
  138. autoload_add_path->set_text("");
  139. }
  140. autoload_add_name->set_text("");
  141. add_autoload->set_disabled(true);
  142. }
  143. }
  144. void EditorAutoloadSettings::_autoload_selected() {
  145. TreeItem *ti = tree->get_selected();
  146. if (!ti) {
  147. return;
  148. }
  149. selected_autoload = "autoload/" + ti->get_text(0);
  150. }
  151. void EditorAutoloadSettings::_autoload_edited() {
  152. if (updating_autoload) {
  153. return;
  154. }
  155. TreeItem *ti = tree->get_edited();
  156. int column = tree->get_edited_column();
  157. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  158. if (column == 0) {
  159. String name = ti->get_text(0);
  160. String old_name = selected_autoload.get_slicec('/', 1);
  161. if (name == old_name) {
  162. return;
  163. }
  164. String error;
  165. if (!_autoload_name_is_valid(name, &error)) {
  166. ti->set_text(0, old_name);
  167. EditorNode::get_singleton()->show_warning(error);
  168. return;
  169. }
  170. if (ProjectSettings::get_singleton()->has_setting("autoload/" + name)) {
  171. ti->set_text(0, old_name);
  172. EditorNode::get_singleton()->show_warning(vformat(TTR("Autoload '%s' already exists!"), name));
  173. return;
  174. }
  175. updating_autoload = true;
  176. name = "autoload/" + name;
  177. int order = ProjectSettings::get_singleton()->get_order(selected_autoload);
  178. String scr_path = GLOBAL_GET(selected_autoload);
  179. undo_redo->create_action(TTR("Rename Autoload"));
  180. undo_redo->add_do_property(ProjectSettings::get_singleton(), name, scr_path);
  181. undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", name, order);
  182. undo_redo->add_do_method(ProjectSettings::get_singleton(), "clear", selected_autoload);
  183. undo_redo->add_undo_property(ProjectSettings::get_singleton(), selected_autoload, scr_path);
  184. undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", selected_autoload, order);
  185. undo_redo->add_undo_method(ProjectSettings::get_singleton(), "clear", name);
  186. undo_redo->add_do_method(this, CoreStringName(call_deferred), "update_autoload");
  187. undo_redo->add_undo_method(this, CoreStringName(call_deferred), "update_autoload");
  188. undo_redo->add_do_method(this, "emit_signal", autoload_changed);
  189. undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
  190. undo_redo->commit_action();
  191. selected_autoload = name;
  192. } else if (column == 2) {
  193. updating_autoload = true;
  194. bool checked = ti->is_checked(2);
  195. String base = "autoload/" + ti->get_text(0);
  196. int order = ProjectSettings::get_singleton()->get_order(base);
  197. String scr_path = GLOBAL_GET(base);
  198. if (scr_path.begins_with("*")) {
  199. scr_path = scr_path.substr(1);
  200. }
  201. // Singleton autoloads are represented with a leading "*" in their path.
  202. if (checked) {
  203. scr_path = "*" + scr_path;
  204. }
  205. undo_redo->create_action(TTR("Toggle Autoload Globals"));
  206. undo_redo->add_do_property(ProjectSettings::get_singleton(), base, scr_path);
  207. undo_redo->add_undo_property(ProjectSettings::get_singleton(), base, GLOBAL_GET(base));
  208. undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", base, order);
  209. undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", base, order);
  210. undo_redo->add_do_method(this, CoreStringName(call_deferred), "update_autoload");
  211. undo_redo->add_undo_method(this, CoreStringName(call_deferred), "update_autoload");
  212. undo_redo->add_do_method(this, "emit_signal", autoload_changed);
  213. undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
  214. undo_redo->commit_action();
  215. }
  216. updating_autoload = false;
  217. }
  218. void EditorAutoloadSettings::_autoload_button_pressed(Object *p_item, int p_column, int p_button, MouseButton p_mouse_button) {
  219. if (p_mouse_button != MouseButton::LEFT) {
  220. return;
  221. }
  222. TreeItem *ti = Object::cast_to<TreeItem>(p_item);
  223. String name = "autoload/" + ti->get_text(0);
  224. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  225. switch (p_button) {
  226. case BUTTON_OPEN: {
  227. _autoload_open(ti->get_text(1));
  228. } break;
  229. case BUTTON_MOVE_UP:
  230. case BUTTON_MOVE_DOWN: {
  231. TreeItem *swap = nullptr;
  232. if (p_button == BUTTON_MOVE_UP) {
  233. swap = ti->get_prev();
  234. } else {
  235. swap = ti->get_next();
  236. }
  237. if (!swap) {
  238. return;
  239. }
  240. String swap_name = "autoload/" + swap->get_text(0);
  241. int order = ProjectSettings::get_singleton()->get_order(name);
  242. int swap_order = ProjectSettings::get_singleton()->get_order(swap_name);
  243. undo_redo->create_action(TTR("Move Autoload"));
  244. undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", name, swap_order);
  245. undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", name, order);
  246. undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", swap_name, order);
  247. undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", swap_name, swap_order);
  248. undo_redo->add_do_method(this, "update_autoload");
  249. undo_redo->add_undo_method(this, "update_autoload");
  250. undo_redo->add_do_method(this, "emit_signal", autoload_changed);
  251. undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
  252. undo_redo->commit_action();
  253. } break;
  254. case BUTTON_DELETE: {
  255. int order = ProjectSettings::get_singleton()->get_order(name);
  256. undo_redo->create_action(TTR("Remove Autoload"));
  257. undo_redo->add_do_property(ProjectSettings::get_singleton(), name, Variant());
  258. undo_redo->add_undo_property(ProjectSettings::get_singleton(), name, GLOBAL_GET(name));
  259. undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", name, order);
  260. undo_redo->add_do_method(this, "update_autoload");
  261. undo_redo->add_undo_method(this, "update_autoload");
  262. undo_redo->add_do_method(this, "emit_signal", autoload_changed);
  263. undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
  264. undo_redo->commit_action();
  265. } break;
  266. }
  267. }
  268. void EditorAutoloadSettings::_autoload_activated() {
  269. TreeItem *ti = tree->get_selected();
  270. if (!ti) {
  271. return;
  272. }
  273. _autoload_open(ti->get_text(1));
  274. }
  275. void EditorAutoloadSettings::_autoload_open(const String &fpath) {
  276. EditorNode::get_singleton()->load_scene_or_resource(fpath);
  277. ProjectSettingsEditor::get_singleton()->hide();
  278. }
  279. void EditorAutoloadSettings::_autoload_file_callback(const String &p_path) {
  280. // Convert the file name to PascalCase, which is the convention for classes in GDScript.
  281. const String class_name = p_path.get_file().get_basename().to_pascal_case();
  282. // If the name collides with a built-in class, prefix the name to make it possible to add without having to edit the name.
  283. // The prefix is subjective, but it provides better UX than leaving the Add button disabled :)
  284. const String prefix = ClassDB::class_exists(class_name) ? "Global" : "";
  285. autoload_add_name->set_text(prefix + class_name);
  286. add_autoload->set_disabled(false);
  287. }
  288. void EditorAutoloadSettings::_autoload_text_submitted(const String &p_name) {
  289. if (!autoload_add_path->get_text().is_empty() && _autoload_name_is_valid(p_name, nullptr)) {
  290. _autoload_add();
  291. }
  292. }
  293. void EditorAutoloadSettings::_autoload_path_text_changed(const String &p_path) {
  294. add_autoload->set_disabled(!_autoload_name_is_valid(autoload_add_name->get_text(), nullptr));
  295. }
  296. void EditorAutoloadSettings::_autoload_text_changed(const String &p_name) {
  297. String error_string;
  298. bool is_name_valid = _autoload_name_is_valid(p_name, &error_string);
  299. add_autoload->set_disabled(!is_name_valid);
  300. error_message->set_text(error_string);
  301. error_message->set_visible(!autoload_add_name->get_text().is_empty() && !is_name_valid);
  302. }
  303. Node *EditorAutoloadSettings::_create_autoload(const String &p_path) {
  304. Node *n = nullptr;
  305. if (ResourceLoader::get_resource_type(p_path) == "PackedScene") {
  306. // Cache the scene reference before loading it (for cyclic references)
  307. Ref<PackedScene> scn;
  308. scn.instantiate();
  309. scn->set_path(p_path);
  310. scn->reload_from_file();
  311. ERR_FAIL_COND_V_MSG(scn.is_null(), nullptr, vformat("Failed to create an autoload, can't load from path: %s.", p_path));
  312. if (scn.is_valid()) {
  313. n = scn->instantiate();
  314. }
  315. } else {
  316. Ref<Resource> res = ResourceLoader::load(p_path);
  317. ERR_FAIL_COND_V_MSG(res.is_null(), nullptr, vformat("Failed to create an autoload, can't load from path: %s.", p_path));
  318. Ref<Script> scr = res;
  319. if (scr.is_valid()) {
  320. ERR_FAIL_COND_V_MSG(!scr->is_valid(), nullptr, vformat("Failed to create an autoload, script '%s' is not compiling.", p_path));
  321. StringName ibt = scr->get_instance_base_type();
  322. bool valid_type = ClassDB::is_parent_class(ibt, "Node");
  323. ERR_FAIL_COND_V_MSG(!valid_type, nullptr, vformat("Failed to create an autoload, script '%s' does not inherit from 'Node'.", p_path));
  324. Object *obj = ClassDB::instantiate(ibt);
  325. ERR_FAIL_NULL_V_MSG(obj, nullptr, vformat("Failed to create an autoload, cannot instantiate '%s'.", ibt));
  326. n = Object::cast_to<Node>(obj);
  327. n->set_script(scr);
  328. }
  329. }
  330. 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));
  331. return n;
  332. }
  333. void EditorAutoloadSettings::init_autoloads() {
  334. for (AutoloadInfo &info : autoload_cache) {
  335. info.node = _create_autoload(info.path);
  336. if (info.node) {
  337. Ref<Script> scr = info.node->get_script();
  338. info.in_editor = scr.is_valid() && scr->is_tool();
  339. info.node->set_name(info.name);
  340. }
  341. if (info.is_singleton) {
  342. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  343. ScriptServer::get_language(i)->add_named_global_constant(info.name, info.node);
  344. }
  345. }
  346. if (!info.is_singleton && !info.in_editor && info.node != nullptr) {
  347. memdelete(info.node);
  348. info.node = nullptr;
  349. }
  350. }
  351. for (const AutoloadInfo &info : autoload_cache) {
  352. if (info.node && info.in_editor) {
  353. // It's important to add the node without deferring because code in plugins or tool scripts
  354. // could use the autoload node when they are enabled.
  355. get_tree()->get_root()->add_child(info.node);
  356. }
  357. }
  358. }
  359. void EditorAutoloadSettings::update_autoload() {
  360. if (updating_autoload) {
  361. return;
  362. }
  363. updating_autoload = true;
  364. HashMap<String, AutoloadInfo> to_remove;
  365. List<AutoloadInfo *> to_add;
  366. for (const AutoloadInfo &info : autoload_cache) {
  367. to_remove.insert(info.name, info);
  368. }
  369. autoload_cache.clear();
  370. tree->clear();
  371. TreeItem *root = tree->create_item();
  372. List<PropertyInfo> props;
  373. ProjectSettings::get_singleton()->get_property_list(&props);
  374. for (const PropertyInfo &pi : props) {
  375. if (!pi.name.begins_with("autoload/")) {
  376. continue;
  377. }
  378. String name = pi.name.get_slicec('/', 1);
  379. String scr_path = GLOBAL_GET(pi.name);
  380. if (name.is_empty()) {
  381. continue;
  382. }
  383. AutoloadInfo info;
  384. info.is_singleton = scr_path.begins_with("*");
  385. if (info.is_singleton) {
  386. scr_path = scr_path.substr(1);
  387. }
  388. info.name = name;
  389. info.path = scr_path;
  390. info.order = ProjectSettings::get_singleton()->get_order(pi.name);
  391. bool need_to_add = true;
  392. if (to_remove.has(name)) {
  393. AutoloadInfo &old_info = to_remove[name];
  394. if (old_info.path == info.path) {
  395. // Still the same resource, check status
  396. info.node = old_info.node;
  397. if (info.node) {
  398. Ref<Script> scr = info.node->get_script();
  399. info.in_editor = scr.is_valid() && scr->is_tool();
  400. if (info.is_singleton == old_info.is_singleton && info.in_editor == old_info.in_editor) {
  401. to_remove.erase(name);
  402. need_to_add = false;
  403. } else {
  404. info.node = nullptr;
  405. }
  406. }
  407. }
  408. }
  409. autoload_cache.push_back(info);
  410. if (need_to_add) {
  411. to_add.push_back(&(autoload_cache.back()->get()));
  412. }
  413. TreeItem *item = tree->create_item(root);
  414. item->set_text(0, name);
  415. item->set_editable(0, true);
  416. item->set_text(1, scr_path);
  417. item->set_selectable(1, true);
  418. item->set_cell_mode(2, TreeItem::CELL_MODE_CHECK);
  419. item->set_editable(2, true);
  420. item->set_text(2, TTRC("Enable"));
  421. item->set_checked(2, info.is_singleton);
  422. item->add_button(3, get_editor_theme_icon(SNAME("Load")), BUTTON_OPEN);
  423. item->add_button(3, get_editor_theme_icon(SNAME("MoveUp")), BUTTON_MOVE_UP);
  424. item->add_button(3, get_editor_theme_icon(SNAME("MoveDown")), BUTTON_MOVE_DOWN);
  425. item->add_button(3, get_editor_theme_icon(SNAME("Remove")), BUTTON_DELETE);
  426. item->set_selectable(3, false);
  427. }
  428. // Remove deleted/changed autoloads
  429. for (KeyValue<String, AutoloadInfo> &E : to_remove) {
  430. AutoloadInfo &info = E.value;
  431. if (info.is_singleton) {
  432. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  433. ScriptServer::get_language(i)->remove_named_global_constant(info.name);
  434. }
  435. }
  436. if (info.in_editor) {
  437. ERR_CONTINUE(!info.node);
  438. callable_mp((Node *)get_tree()->get_root(), &Node::remove_child).call_deferred(info.node);
  439. }
  440. if (info.node) {
  441. info.node->queue_free();
  442. info.node = nullptr;
  443. }
  444. }
  445. // Load new/changed autoloads
  446. List<Node *> nodes_to_add;
  447. for (AutoloadInfo *info : to_add) {
  448. info->node = _create_autoload(info->path);
  449. ERR_CONTINUE(!info->node);
  450. info->node->set_name(info->name);
  451. Ref<Script> scr = info->node->get_script();
  452. info->in_editor = scr.is_valid() && scr->is_tool();
  453. if (info->in_editor) {
  454. //defer so references are all valid on _ready()
  455. nodes_to_add.push_back(info->node);
  456. }
  457. if (info->is_singleton) {
  458. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  459. ScriptServer::get_language(i)->add_named_global_constant(info->name, info->node);
  460. }
  461. }
  462. if (!info->in_editor && !info->is_singleton) {
  463. // No reason to keep this node
  464. memdelete(info->node);
  465. info->node = nullptr;
  466. }
  467. }
  468. for (Node *E : nodes_to_add) {
  469. get_tree()->get_root()->add_child(E);
  470. }
  471. updating_autoload = false;
  472. }
  473. void EditorAutoloadSettings::_script_created(Ref<Script> p_script) {
  474. FileSystemDock::get_singleton()->get_script_create_dialog()->hide();
  475. path = p_script->get_path().get_base_dir();
  476. autoload_add_path->set_text(p_script->get_path());
  477. autoload_add_name->set_text(p_script->get_path().get_file().get_basename().to_pascal_case());
  478. _autoload_add();
  479. }
  480. LineEdit *EditorAutoloadSettings::get_path_box() const {
  481. return autoload_add_path;
  482. }
  483. Variant EditorAutoloadSettings::get_drag_data_fw(const Point2 &p_point, Control *p_control) {
  484. if (autoload_cache.size() <= 1) {
  485. return false;
  486. }
  487. PackedStringArray autoloads;
  488. TreeItem *next = tree->get_next_selected(nullptr);
  489. while (next) {
  490. autoloads.push_back(next->get_text(0));
  491. next = tree->get_next_selected(next);
  492. }
  493. if (autoloads.is_empty() || autoloads.size() == autoload_cache.size()) {
  494. return Variant();
  495. }
  496. VBoxContainer *preview = memnew(VBoxContainer);
  497. int max_size = MIN(PREVIEW_LIST_MAX_SIZE, autoloads.size());
  498. for (int i = 0; i < max_size; i++) {
  499. Label *label = memnew(Label(autoloads[i]));
  500. label->set_self_modulate(Color(1, 1, 1, Math::lerp(1, 0, float(i) / PREVIEW_LIST_MAX_SIZE)));
  501. label->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  502. preview->add_child(label);
  503. }
  504. tree->set_drop_mode_flags(Tree::DROP_MODE_INBETWEEN);
  505. tree->set_drag_preview(preview);
  506. Dictionary drop_data;
  507. drop_data["type"] = "autoload";
  508. drop_data["autoloads"] = autoloads;
  509. return drop_data;
  510. }
  511. bool EditorAutoloadSettings::can_drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_control) const {
  512. if (updating_autoload) {
  513. return false;
  514. }
  515. Dictionary drop_data = p_data;
  516. if (!drop_data.has("type")) {
  517. return false;
  518. }
  519. if (drop_data.has("type")) {
  520. TreeItem *ti = (p_point == Vector2(Math::INF, Math::INF)) ? tree->get_selected() : tree->get_item_at_position(p_point);
  521. if (!ti) {
  522. return false;
  523. }
  524. 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);
  525. return section >= -1;
  526. }
  527. return false;
  528. }
  529. void EditorAutoloadSettings::drop_data_fw(const Point2 &p_point, const Variant &p_data, Control *p_control) {
  530. TreeItem *ti = (p_point == Vector2(Math::INF, Math::INF)) ? tree->get_selected() : tree->get_item_at_position(p_point);
  531. if (!ti) {
  532. return;
  533. }
  534. 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);
  535. if (section < -1) {
  536. return;
  537. }
  538. String name;
  539. bool move_to_back = false;
  540. if (section < 0) {
  541. name = ti->get_text(0);
  542. } else if (ti->get_next()) {
  543. name = ti->get_next()->get_text(0);
  544. } else {
  545. name = ti->get_text(0);
  546. move_to_back = true;
  547. }
  548. int order = ProjectSettings::get_singleton()->get_order("autoload/" + name);
  549. AutoloadInfo aux;
  550. List<AutoloadInfo>::Element *E = nullptr;
  551. if (!move_to_back) {
  552. aux.order = order;
  553. E = autoload_cache.find(aux);
  554. }
  555. Dictionary drop_data = p_data;
  556. PackedStringArray autoloads = drop_data["autoloads"];
  557. // Store the initial order of the autoloads for comparison.
  558. Vector<int> initial_orders;
  559. initial_orders.resize(autoload_cache.size());
  560. int idx = 0;
  561. for (const AutoloadInfo &F : autoload_cache) {
  562. initial_orders.write[idx++] = F.order;
  563. }
  564. // Perform the drag-and-drop operation.
  565. Vector<int> orders;
  566. orders.resize(autoload_cache.size());
  567. for (int i = 0; i < autoloads.size(); i++) {
  568. aux.order = ProjectSettings::get_singleton()->get_order("autoload/" + autoloads[i]);
  569. List<AutoloadInfo>::Element *I = autoload_cache.find(aux);
  570. if (move_to_back) {
  571. autoload_cache.move_to_back(I);
  572. } else if (E != I) {
  573. autoload_cache.move_before(I, E);
  574. } else if (E->next()) {
  575. E = E->next();
  576. } else {
  577. break;
  578. }
  579. }
  580. idx = 0;
  581. for (const AutoloadInfo &F : autoload_cache) {
  582. orders.write[idx++] = F.order;
  583. }
  584. // If the order didn't change, we shouldn't create undo/redo actions.
  585. if (orders == initial_orders) {
  586. return;
  587. }
  588. orders.sort();
  589. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  590. undo_redo->create_action(TTR("Rearrange Autoloads"));
  591. idx = 0;
  592. for (const AutoloadInfo &F : autoload_cache) {
  593. undo_redo->add_do_method(ProjectSettings::get_singleton(), "set_order", "autoload/" + F.name, orders[idx++]);
  594. undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", "autoload/" + F.name, F.order);
  595. }
  596. orders.clear();
  597. undo_redo->add_do_method(this, "update_autoload");
  598. undo_redo->add_undo_method(this, "update_autoload");
  599. undo_redo->add_do_method(this, "emit_signal", autoload_changed);
  600. undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
  601. undo_redo->commit_action();
  602. }
  603. bool EditorAutoloadSettings::autoload_add(const String &p_name, const String &p_path) {
  604. String name = p_name;
  605. String error;
  606. if (!_autoload_name_is_valid(name, &error)) {
  607. EditorNode::get_singleton()->show_warning(TTR("Can't add Autoload:") + "\n" + error);
  608. return false;
  609. }
  610. if (!FileAccess::exists(p_path)) {
  611. EditorNode::get_singleton()->show_warning(TTR("Can't add Autoload:") + "\n" + vformat(TTR("%s is an invalid path. File does not exist."), p_path));
  612. return false;
  613. }
  614. if (!p_path.begins_with("res://")) {
  615. 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));
  616. return false;
  617. }
  618. name = "autoload/" + name;
  619. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  620. undo_redo->create_action(TTR("Add Autoload"));
  621. // Singleton autoloads are represented with a leading "*" in their path.
  622. undo_redo->add_do_property(ProjectSettings::get_singleton(), name, "*" + p_path);
  623. if (ProjectSettings::get_singleton()->has_setting(name)) {
  624. undo_redo->add_undo_property(ProjectSettings::get_singleton(), name, GLOBAL_GET(name));
  625. } else {
  626. undo_redo->add_undo_property(ProjectSettings::get_singleton(), name, Variant());
  627. }
  628. undo_redo->add_do_method(this, "update_autoload");
  629. undo_redo->add_undo_method(this, "update_autoload");
  630. undo_redo->add_do_method(this, "emit_signal", autoload_changed);
  631. undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
  632. undo_redo->commit_action();
  633. return true;
  634. }
  635. void EditorAutoloadSettings::autoload_remove(const String &p_name) {
  636. String name = "autoload/" + p_name;
  637. EditorUndoRedoManager *undo_redo = EditorUndoRedoManager::get_singleton();
  638. int order = ProjectSettings::get_singleton()->get_order(name);
  639. undo_redo->create_action(TTR("Remove Autoload"));
  640. undo_redo->add_do_property(ProjectSettings::get_singleton(), name, Variant());
  641. undo_redo->add_undo_property(ProjectSettings::get_singleton(), name, GLOBAL_GET(name));
  642. undo_redo->add_undo_method(ProjectSettings::get_singleton(), "set_order", name, order);
  643. undo_redo->add_do_method(this, "update_autoload");
  644. undo_redo->add_undo_method(this, "update_autoload");
  645. undo_redo->add_do_method(this, "emit_signal", autoload_changed);
  646. undo_redo->add_undo_method(this, "emit_signal", autoload_changed);
  647. undo_redo->commit_action();
  648. }
  649. void EditorAutoloadSettings::_bind_methods() {
  650. ClassDB::bind_method("update_autoload", &EditorAutoloadSettings::update_autoload);
  651. ClassDB::bind_method("autoload_add", &EditorAutoloadSettings::autoload_add);
  652. ClassDB::bind_method("autoload_remove", &EditorAutoloadSettings::autoload_remove);
  653. ADD_SIGNAL(MethodInfo("autoload_changed"));
  654. }
  655. EditorAutoloadSettings::EditorAutoloadSettings() {
  656. ProjectSettings::get_singleton()->add_hidden_prefix("autoload/");
  657. // Make first cache
  658. List<PropertyInfo> props;
  659. ProjectSettings::get_singleton()->get_property_list(&props);
  660. for (const PropertyInfo &pi : props) {
  661. if (!pi.name.begins_with("autoload/")) {
  662. continue;
  663. }
  664. String name = pi.name.get_slicec('/', 1);
  665. String scr_path = GLOBAL_GET(pi.name);
  666. if (name.is_empty()) {
  667. continue;
  668. }
  669. AutoloadInfo info;
  670. info.is_singleton = scr_path.begins_with("*");
  671. if (info.is_singleton) {
  672. scr_path = scr_path.substr(1);
  673. }
  674. info.name = name;
  675. info.path = scr_path;
  676. info.order = ProjectSettings::get_singleton()->get_order(pi.name);
  677. if (info.is_singleton) {
  678. // Make sure name references work before parsing scripts
  679. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  680. ScriptServer::get_language(i)->add_named_global_constant(info.name, Variant());
  681. }
  682. }
  683. autoload_cache.push_back(info);
  684. }
  685. HBoxContainer *hbc = memnew(HBoxContainer);
  686. add_child(hbc);
  687. error_message = memnew(Label);
  688. error_message->set_auto_translate_mode(AUTO_TRANSLATE_MODE_DISABLED);
  689. error_message->set_focus_mode(FOCUS_ACCESSIBILITY);
  690. error_message->hide();
  691. error_message->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_RIGHT);
  692. error_message->add_theme_color_override(SceneStringName(font_color), EditorNode::get_singleton()->get_editor_theme()->get_color(SNAME("error_color"), EditorStringName(Editor)));
  693. add_child(error_message);
  694. Label *l = memnew(Label);
  695. l->set_text(TTRC("Path:"));
  696. hbc->add_child(l);
  697. autoload_add_path = memnew(LineEdit);
  698. hbc->add_child(autoload_add_path);
  699. autoload_add_path->set_accessibility_name(TTRC("Autoload Path"));
  700. autoload_add_path->set_h_size_flags(Control::SIZE_EXPAND_FILL);
  701. autoload_add_path->set_clear_button_enabled(true);
  702. autoload_add_path->set_placeholder(TTRC("Set path or press \"Add\" to create a script."));
  703. autoload_add_path->connect(SceneStringName(text_changed), callable_mp(this, &EditorAutoloadSettings::_autoload_path_text_changed));
  704. browse_button = memnew(Button);
  705. hbc->add_child(browse_button);
  706. browse_button->set_accessibility_name(TTRC("Select Autoload Path"));
  707. browse_button->connect(SceneStringName(pressed), callable_mp(this, &EditorAutoloadSettings::_browse_autoload_add_path));
  708. file_dialog = memnew(EditorFileDialog);
  709. hbc->add_child(file_dialog);
  710. file_dialog->connect("file_selected", callable_mp(this, &EditorAutoloadSettings::_set_autoload_add_path));
  711. file_dialog->connect("dir_selected", callable_mp(this, &EditorAutoloadSettings::_set_autoload_add_path));
  712. file_dialog->connect("files_selected", callable_mp(this, &EditorAutoloadSettings::_set_autoload_add_path));
  713. hbc->set_h_size_flags(SIZE_EXPAND_FILL);
  714. file_dialog->set_file_mode(EditorFileDialog::FILE_MODE_OPEN_FILE);
  715. file_dialog->connect("file_selected", callable_mp(this, &EditorAutoloadSettings::_autoload_file_callback));
  716. l = memnew(Label);
  717. l->set_text(TTRC("Node Name:"));
  718. hbc->add_child(l);
  719. autoload_add_name = memnew(LineEdit);
  720. autoload_add_name->set_accessibility_name(TTRC("Node Name:"));
  721. autoload_add_name->set_h_size_flags(SIZE_EXPAND_FILL);
  722. autoload_add_name->connect(SceneStringName(text_submitted), callable_mp(this, &EditorAutoloadSettings::_autoload_text_submitted));
  723. autoload_add_name->connect(SceneStringName(text_changed), callable_mp(this, &EditorAutoloadSettings::_autoload_text_changed));
  724. hbc->add_child(autoload_add_name);
  725. add_autoload = memnew(Button);
  726. add_autoload->set_text(TTRC("Add"));
  727. add_autoload->connect(SceneStringName(pressed), callable_mp(this, &EditorAutoloadSettings::_autoload_add));
  728. // The button will be enabled once a valid name is entered (either automatically or manually).
  729. add_autoload->set_disabled(true);
  730. hbc->add_child(add_autoload);
  731. tree = memnew(Tree);
  732. tree->set_accessibility_name(TTRC("Autoloads"));
  733. tree->set_hide_root(true);
  734. tree->set_select_mode(Tree::SELECT_MULTI);
  735. tree->set_allow_reselect(true);
  736. SET_DRAG_FORWARDING_GCD(tree, EditorAutoloadSettings);
  737. tree->set_columns(4);
  738. tree->set_column_titles_visible(true);
  739. tree->set_column_title(0, TTRC("Name"));
  740. tree->set_column_expand(0, true);
  741. tree->set_column_expand_ratio(0, 1);
  742. tree->set_column_title(1, TTRC("Path"));
  743. tree->set_column_expand(1, true);
  744. tree->set_column_clip_content(1, true);
  745. tree->set_column_expand_ratio(1, 2);
  746. tree->set_column_title(2, TTRC("Global Variable"));
  747. tree->set_column_expand(2, false);
  748. tree->set_column_expand(3, false);
  749. tree->connect("cell_selected", callable_mp(this, &EditorAutoloadSettings::_autoload_selected));
  750. tree->connect("item_edited", callable_mp(this, &EditorAutoloadSettings::_autoload_edited));
  751. tree->connect("button_clicked", callable_mp(this, &EditorAutoloadSettings::_autoload_button_pressed));
  752. tree->connect("item_activated", callable_mp(this, &EditorAutoloadSettings::_autoload_activated));
  753. tree->set_v_size_flags(SIZE_EXPAND_FILL);
  754. add_child(tree, true);
  755. }
  756. EditorAutoloadSettings::~EditorAutoloadSettings() {
  757. for (const AutoloadInfo &info : autoload_cache) {
  758. if (info.node && !info.in_editor) {
  759. memdelete(info.node);
  760. }
  761. }
  762. }
  763. void EditorAutoloadSettings::_set_autoload_add_path(const String &p_text) {
  764. autoload_add_path->set_text(p_text);
  765. autoload_add_path->emit_signal(SceneStringName(text_submitted), p_text);
  766. }
  767. void EditorAutoloadSettings::_browse_autoload_add_path() {
  768. file_dialog->popup_file_dialog();
  769. }