editor_autoload_settings.cpp 32 KB

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