editor_autoload_settings.cpp 31 KB

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