editor_autoload_settings.cpp 31 KB

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