script_create_dialog.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936
  1. /*************************************************************************/
  2. /* script_create_dialog.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  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 "script_create_dialog.h"
  31. #include "core/io/resource_saver.h"
  32. #include "core/os/file_access.h"
  33. #include "core/project_settings.h"
  34. #include "core/script_language.h"
  35. #include "core/string_builder.h"
  36. #include "editor/create_dialog.h"
  37. #include "editor/editor_node.h"
  38. #include "editor/editor_scale.h"
  39. #include "editor_file_system.h"
  40. void ScriptCreateDialog::_notification(int p_what) {
  41. switch (p_what) {
  42. case NOTIFICATION_THEME_CHANGED:
  43. case NOTIFICATION_ENTER_TREE: {
  44. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  45. String lang = ScriptServer::get_language(i)->get_type();
  46. Ref<Texture> lang_icon = get_icon(lang, "EditorIcons");
  47. if (lang_icon.is_valid()) {
  48. language_menu->set_item_icon(i, lang_icon);
  49. }
  50. }
  51. String last_lang = EditorSettings::get_singleton()->get_project_metadata("script_setup", "last_selected_language", "");
  52. if (!last_lang.empty()) {
  53. for (int i = 0; i < language_menu->get_item_count(); i++) {
  54. if (language_menu->get_item_text(i) == last_lang) {
  55. language_menu->select(i);
  56. current_language = i;
  57. break;
  58. }
  59. }
  60. } else {
  61. language_menu->select(default_language);
  62. }
  63. path_button->set_icon(get_icon("Folder", "EditorIcons"));
  64. parent_browse_button->set_icon(get_icon("Folder", "EditorIcons"));
  65. parent_search_button->set_icon(get_icon("ClassList", "EditorIcons"));
  66. status_panel->add_style_override("panel", get_stylebox("bg", "Tree"));
  67. } break;
  68. }
  69. }
  70. void ScriptCreateDialog::_path_hbox_sorted() {
  71. if (is_visible()) {
  72. int filename_start_pos = initial_bp.find_last("/") + 1;
  73. int filename_end_pos = initial_bp.length();
  74. if (!is_built_in) {
  75. file_path->select(filename_start_pos, filename_end_pos);
  76. }
  77. // First set cursor to the end of line to scroll LineEdit view
  78. // to the right and then set the actual cursor position.
  79. file_path->set_cursor_position(file_path->get_text().length());
  80. file_path->set_cursor_position(filename_start_pos);
  81. file_path->grab_focus();
  82. }
  83. }
  84. bool ScriptCreateDialog::_can_be_built_in() {
  85. return (supports_built_in && built_in_enabled);
  86. }
  87. void ScriptCreateDialog::config(const String &p_base_name, const String &p_base_path, bool p_built_in_enabled, bool p_load_enabled) {
  88. class_name->set_text("");
  89. class_name->deselect();
  90. parent_name->set_text(p_base_name);
  91. parent_name->deselect();
  92. if (p_base_path != "") {
  93. initial_bp = p_base_path.get_basename();
  94. file_path->set_text(initial_bp + "." + ScriptServer::get_language(language_menu->get_selected())->get_extension());
  95. current_language = language_menu->get_selected();
  96. } else {
  97. initial_bp = "";
  98. file_path->set_text("");
  99. }
  100. file_path->deselect();
  101. built_in_enabled = p_built_in_enabled;
  102. load_enabled = p_load_enabled;
  103. _lang_changed(current_language);
  104. _class_name_changed("");
  105. _path_changed(file_path->get_text());
  106. }
  107. void ScriptCreateDialog::set_inheritance_base_type(const String &p_base) {
  108. base_type = p_base;
  109. }
  110. bool ScriptCreateDialog::_validate_parent(const String &p_string) {
  111. if (p_string.length() == 0)
  112. return false;
  113. if (can_inherit_from_file && p_string.is_quoted()) {
  114. String p = p_string.substr(1, p_string.length() - 2);
  115. if (_validate_path(p, true) == "")
  116. return true;
  117. }
  118. return ClassDB::class_exists(p_string) || ScriptServer::is_global_class(p_string);
  119. }
  120. bool ScriptCreateDialog::_validate_class(const String &p_string) {
  121. if (p_string.length() == 0)
  122. return false;
  123. for (int i = 0; i < p_string.length(); i++) {
  124. if (i == 0) {
  125. if (p_string[0] >= '0' && p_string[0] <= '9')
  126. return false; // no start with number plz
  127. }
  128. bool valid_char = (p_string[i] >= '0' && p_string[i] <= '9') || (p_string[i] >= 'a' && p_string[i] <= 'z') || (p_string[i] >= 'A' && p_string[i] <= 'Z') || p_string[i] == '_' || p_string[i] == '.';
  129. if (!valid_char)
  130. return false;
  131. }
  132. return true;
  133. }
  134. String ScriptCreateDialog::_validate_path(const String &p_path, bool p_file_must_exist) {
  135. String p = p_path.strip_edges();
  136. if (p == "")
  137. return TTR("Path is empty.");
  138. if (p.get_file().get_basename() == "")
  139. return TTR("Filename is empty.");
  140. p = ProjectSettings::get_singleton()->localize_path(p);
  141. if (!p.begins_with("res://"))
  142. return TTR("Path is not local.");
  143. DirAccess *d = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  144. if (d->change_dir(p.get_base_dir()) != OK) {
  145. memdelete(d);
  146. return TTR("Invalid base path.");
  147. }
  148. memdelete(d);
  149. /* Does file already exist */
  150. DirAccess *f = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  151. if (f->dir_exists(p)) {
  152. memdelete(f);
  153. return TTR("A directory with the same name exists.");
  154. } else if (p_file_must_exist && !f->file_exists(p)) {
  155. memdelete(f);
  156. return TTR("File does not exist.");
  157. }
  158. memdelete(f);
  159. /* Check file extension */
  160. String extension = p.get_extension();
  161. List<String> extensions;
  162. // get all possible extensions for script
  163. for (int l = 0; l < language_menu->get_item_count(); l++) {
  164. ScriptServer::get_language(l)->get_recognized_extensions(&extensions);
  165. }
  166. bool found = false;
  167. bool match = false;
  168. int index = 0;
  169. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  170. if (E->get().nocasecmp_to(extension) == 0) {
  171. //FIXME (?) - changing language this way doesn't update controls, needs rework
  172. //language_menu->select(index); // change Language option by extension
  173. found = true;
  174. if (E->get() == ScriptServer::get_language(language_menu->get_selected())->get_extension()) {
  175. match = true;
  176. }
  177. break;
  178. }
  179. index++;
  180. }
  181. if (!found)
  182. return TTR("Invalid extension.");
  183. if (!match)
  184. return TTR("Wrong extension chosen.");
  185. /* Let ScriptLanguage do custom validation */
  186. String path_error = ScriptServer::get_language(language_menu->get_selected())->validate_path(p);
  187. if (path_error != "")
  188. return path_error;
  189. /* All checks passed */
  190. return "";
  191. }
  192. String ScriptCreateDialog::_get_class_name() const {
  193. if (has_named_classes) {
  194. return class_name->get_text();
  195. } else {
  196. return ProjectSettings::get_singleton()->localize_path(file_path->get_text()).get_file().get_basename();
  197. }
  198. }
  199. void ScriptCreateDialog::_class_name_changed(const String &p_name) {
  200. if (_validate_class(class_name->get_text())) {
  201. is_class_name_valid = true;
  202. } else {
  203. is_class_name_valid = false;
  204. }
  205. _update_dialog();
  206. }
  207. void ScriptCreateDialog::_parent_name_changed(const String &p_parent) {
  208. if (_validate_parent(parent_name->get_text())) {
  209. is_parent_name_valid = true;
  210. } else {
  211. is_parent_name_valid = false;
  212. }
  213. _update_dialog();
  214. }
  215. void ScriptCreateDialog::_template_changed(int p_template) {
  216. String selected_template = p_template == 0 ? "" : template_menu->get_item_text(p_template);
  217. EditorSettings::get_singleton()->set_project_metadata("script_setup", "last_selected_template", selected_template);
  218. if (p_template == 0) {
  219. //default
  220. script_template = "";
  221. return;
  222. }
  223. int selected_id = template_menu->get_selected_id();
  224. for (int i = 0; i < template_list.size(); i++) {
  225. const ScriptTemplateInfo &sinfo = template_list[i];
  226. if (sinfo.id == selected_id) {
  227. script_template = sinfo.dir.plus_file(sinfo.name + "." + sinfo.extension);
  228. break;
  229. }
  230. }
  231. }
  232. void ScriptCreateDialog::ok_pressed() {
  233. if (is_new_script_created) {
  234. _create_new();
  235. } else {
  236. _load_exist();
  237. }
  238. is_new_script_created = true;
  239. _update_dialog();
  240. }
  241. void ScriptCreateDialog::_create_new() {
  242. String cname_param = _get_class_name();
  243. Ref<Script> scr;
  244. if (script_template != "") {
  245. scr = ResourceLoader::load(script_template);
  246. if (scr.is_null()) {
  247. alert->set_text(vformat(TTR("Error loading template '%s'"), script_template));
  248. alert->popup_centered();
  249. return;
  250. }
  251. scr = scr->duplicate();
  252. ScriptServer::get_language(language_menu->get_selected())->make_template(cname_param, parent_name->get_text(), scr);
  253. } else {
  254. scr = ScriptServer::get_language(language_menu->get_selected())->get_template(cname_param, parent_name->get_text());
  255. }
  256. if (has_named_classes) {
  257. String cname = class_name->get_text();
  258. if (cname.length())
  259. scr->set_name(cname);
  260. }
  261. if (!is_built_in) {
  262. String lpath = ProjectSettings::get_singleton()->localize_path(file_path->get_text());
  263. scr->set_path(lpath);
  264. Error err = ResourceSaver::save(lpath, scr, ResourceSaver::FLAG_CHANGE_PATH);
  265. if (err != OK) {
  266. alert->set_text(TTR("Error - Could not create script in filesystem."));
  267. alert->popup_centered();
  268. return;
  269. }
  270. }
  271. emit_signal("script_created", scr);
  272. hide();
  273. }
  274. void ScriptCreateDialog::_load_exist() {
  275. String path = file_path->get_text();
  276. RES p_script = ResourceLoader::load(path, "Script");
  277. if (p_script.is_null()) {
  278. alert->set_text(vformat(TTR("Error loading script from %s"), path));
  279. alert->popup_centered();
  280. return;
  281. }
  282. emit_signal("script_created", p_script.get_ref_ptr());
  283. hide();
  284. }
  285. void ScriptCreateDialog::_lang_changed(int l) {
  286. ScriptLanguage *language = ScriptServer::get_language(l);
  287. has_named_classes = language->has_named_classes();
  288. can_inherit_from_file = language->can_inherit_from_file();
  289. supports_built_in = language->supports_builtin_mode();
  290. if (!supports_built_in)
  291. is_built_in = false;
  292. String selected_ext = "." + language->get_extension();
  293. String path = file_path->get_text();
  294. String extension = "";
  295. if (path != "") {
  296. if (path.find(".") != -1) {
  297. extension = path.get_extension();
  298. }
  299. if (extension.length() == 0) {
  300. // add extension if none
  301. path += selected_ext;
  302. _path_changed(path);
  303. } else {
  304. // change extension by selected language
  305. List<String> extensions;
  306. // get all possible extensions for script
  307. for (int m = 0; m < language_menu->get_item_count(); m++) {
  308. ScriptServer::get_language(m)->get_recognized_extensions(&extensions);
  309. }
  310. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  311. if (E->get().nocasecmp_to(extension) == 0) {
  312. path = path.get_basename() + selected_ext;
  313. _path_changed(path);
  314. break;
  315. }
  316. }
  317. }
  318. } else {
  319. path = "class" + selected_ext;
  320. _path_changed(path);
  321. }
  322. file_path->set_text(path);
  323. bool use_templates = language->is_using_templates();
  324. template_menu->set_disabled(!use_templates);
  325. template_menu->clear();
  326. if (use_templates) {
  327. _update_script_templates(language->get_extension());
  328. String last_lang = EditorSettings::get_singleton()->get_project_metadata("script_setup", "last_selected_language", "");
  329. String last_template = EditorSettings::get_singleton()->get_project_metadata("script_setup", "last_selected_template", "");
  330. template_menu->add_item(TTR("Default"));
  331. ScriptTemplateInfo *templates = template_list.ptrw();
  332. Vector<String> origin_names;
  333. origin_names.push_back(TTR("Project"));
  334. origin_names.push_back(TTR("Editor"));
  335. int cur_origin = -1;
  336. // Populate script template items previously sorted and now grouped by origin
  337. for (int i = 0; i < template_list.size(); i++) {
  338. if (int(templates[i].origin) != cur_origin) {
  339. template_menu->add_separator();
  340. String origin_name = origin_names[templates[i].origin];
  341. int last_index = template_menu->get_item_count() - 1;
  342. template_menu->set_item_text(last_index, origin_name);
  343. cur_origin = templates[i].origin;
  344. }
  345. String item_name = templates[i].name.capitalize();
  346. template_menu->add_item(item_name);
  347. int new_id = template_menu->get_item_count() - 1;
  348. templates[i].id = new_id;
  349. }
  350. // Disable overridden
  351. for (Map<String, Vector<int>>::Element *E = template_overrides.front(); E; E = E->next()) {
  352. const Vector<int> &overrides = E->get();
  353. if (overrides.size() == 1) {
  354. continue; // doesn't override anything
  355. }
  356. const ScriptTemplateInfo &extended = template_list[overrides[0]];
  357. StringBuilder override_info;
  358. override_info += TTR("Overrides");
  359. override_info += ": ";
  360. for (int i = 1; i < overrides.size(); i++) {
  361. const ScriptTemplateInfo &overridden = template_list[overrides[i]];
  362. int disable_index = template_menu->get_item_index(overridden.id);
  363. template_menu->set_item_disabled(disable_index, true);
  364. override_info += origin_names[overridden.origin];
  365. if (i < overrides.size() - 1) {
  366. override_info += ", ";
  367. }
  368. }
  369. template_menu->set_item_icon(extended.id, get_icon("Override", "EditorIcons"));
  370. template_menu->get_popup()->set_item_tooltip(extended.id, override_info.as_string());
  371. }
  372. // Reselect last selected template
  373. for (int i = 0; i < template_menu->get_item_count(); i++) {
  374. const String &ti = template_menu->get_item_text(i);
  375. if (language_menu->get_item_text(language_menu->get_selected()) == last_lang && last_template == ti) {
  376. template_menu->select(i);
  377. break;
  378. }
  379. }
  380. } else {
  381. template_menu->add_item(TTR("N/A"));
  382. script_template = "";
  383. }
  384. _template_changed(template_menu->get_selected());
  385. EditorSettings::get_singleton()->set_project_metadata("script_setup", "last_selected_language", language_menu->get_item_text(language_menu->get_selected()));
  386. _parent_name_changed(parent_name->get_text());
  387. _update_dialog();
  388. }
  389. void ScriptCreateDialog::_update_script_templates(const String &p_extension) {
  390. template_list.clear();
  391. template_overrides.clear();
  392. Vector<String> dirs;
  393. // Ordered from local to global for correct override mechanism
  394. dirs.push_back(EditorSettings::get_singleton()->get_project_script_templates_dir());
  395. dirs.push_back(EditorSettings::get_singleton()->get_script_templates_dir());
  396. for (int i = 0; i < dirs.size(); i++) {
  397. Vector<String> list = EditorSettings::get_singleton()->get_script_templates(p_extension, dirs[i]);
  398. for (int j = 0; j < list.size(); j++) {
  399. ScriptTemplateInfo sinfo;
  400. sinfo.origin = ScriptOrigin(i);
  401. sinfo.dir = dirs[i];
  402. sinfo.name = list[j];
  403. sinfo.extension = p_extension;
  404. template_list.push_back(sinfo);
  405. if (!template_overrides.has(sinfo.name)) {
  406. Vector<int> overrides;
  407. overrides.push_back(template_list.size() - 1); // first one
  408. template_overrides.insert(sinfo.name, overrides);
  409. } else {
  410. Vector<int> &overrides = template_overrides[sinfo.name];
  411. overrides.push_back(template_list.size() - 1);
  412. }
  413. }
  414. }
  415. }
  416. void ScriptCreateDialog::_built_in_pressed() {
  417. if (internal->is_pressed()) {
  418. is_built_in = true;
  419. is_new_script_created = true;
  420. } else {
  421. is_built_in = false;
  422. _path_changed(file_path->get_text());
  423. }
  424. _update_dialog();
  425. minimum_size_changed();
  426. }
  427. void ScriptCreateDialog::_browse_path(bool browse_parent, bool p_save) {
  428. is_browsing_parent = browse_parent;
  429. if (p_save) {
  430. file_browse->set_mode(EditorFileDialog::MODE_SAVE_FILE);
  431. file_browse->set_title(TTR("Open Script / Choose Location"));
  432. file_browse->get_ok()->set_text(TTR("Open"));
  433. } else {
  434. file_browse->set_mode(EditorFileDialog::MODE_OPEN_FILE);
  435. file_browse->set_title(TTR("Open Script"));
  436. }
  437. file_browse->set_disable_overwrite_warning(true);
  438. file_browse->clear_filters();
  439. List<String> extensions;
  440. int lang = language_menu->get_selected();
  441. ScriptServer::get_language(lang)->get_recognized_extensions(&extensions);
  442. for (List<String>::Element *E = extensions.front(); E; E = E->next()) {
  443. file_browse->add_filter("*." + E->get());
  444. }
  445. file_browse->set_current_path(file_path->get_text());
  446. file_browse->popup_centered_ratio();
  447. }
  448. void ScriptCreateDialog::_file_selected(const String &p_file) {
  449. String p = ProjectSettings::get_singleton()->localize_path(p_file);
  450. if (is_browsing_parent) {
  451. parent_name->set_text("\"" + p + "\"");
  452. _parent_name_changed(parent_name->get_text());
  453. } else {
  454. file_path->set_text(p);
  455. _path_changed(p);
  456. String filename = p.get_file().get_basename();
  457. int select_start = p.find_last(filename);
  458. file_path->select(select_start, select_start + filename.length());
  459. file_path->set_cursor_position(select_start + filename.length());
  460. file_path->grab_focus();
  461. }
  462. }
  463. void ScriptCreateDialog::_create() {
  464. parent_name->set_text(select_class->get_selected_type().split(" ")[0]);
  465. _parent_name_changed(parent_name->get_text());
  466. }
  467. void ScriptCreateDialog::_browse_class_in_tree() {
  468. select_class->set_base_type(base_type);
  469. select_class->popup_create(true);
  470. }
  471. void ScriptCreateDialog::_path_changed(const String &p_path) {
  472. if (is_built_in) {
  473. return;
  474. }
  475. is_path_valid = false;
  476. is_new_script_created = true;
  477. String path_error = _validate_path(p_path, false);
  478. if (path_error != "") {
  479. _msg_path_valid(false, path_error);
  480. _update_dialog();
  481. return;
  482. }
  483. /* Does file already exist */
  484. DirAccess *f = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  485. String p = ProjectSettings::get_singleton()->localize_path(p_path.strip_edges());
  486. if (f->file_exists(p)) {
  487. is_new_script_created = false;
  488. _msg_path_valid(true, TTR("File exists, it will be reused."));
  489. }
  490. memdelete(f);
  491. is_path_valid = true;
  492. _update_dialog();
  493. }
  494. void ScriptCreateDialog::_path_entered(const String &p_path) {
  495. ok_pressed();
  496. }
  497. void ScriptCreateDialog::_msg_script_valid(bool valid, const String &p_msg) {
  498. error_label->set_text("- " + TTR(p_msg));
  499. if (valid) {
  500. error_label->add_color_override("font_color", get_color("success_color", "Editor"));
  501. } else {
  502. error_label->add_color_override("font_color", get_color("error_color", "Editor"));
  503. }
  504. }
  505. void ScriptCreateDialog::_msg_path_valid(bool valid, const String &p_msg) {
  506. path_error_label->set_text("- " + TTR(p_msg));
  507. if (valid) {
  508. path_error_label->add_color_override("font_color", get_color("success_color", "Editor"));
  509. } else {
  510. path_error_label->add_color_override("font_color", get_color("error_color", "Editor"));
  511. }
  512. }
  513. void ScriptCreateDialog::_update_dialog() {
  514. /* "Add Script Dialog" GUI logic and script checks. */
  515. bool script_ok = true;
  516. // Is script path/name valid (order from top to bottom)?
  517. if (!is_built_in && !is_path_valid) {
  518. _msg_script_valid(false, TTR("Invalid path."));
  519. script_ok = false;
  520. }
  521. if (has_named_classes && (is_new_script_created && !is_class_name_valid)) {
  522. _msg_script_valid(false, TTR("Invalid class name."));
  523. script_ok = false;
  524. }
  525. if (!is_parent_name_valid && is_new_script_created) {
  526. _msg_script_valid(false, TTR("Invalid inherited parent name or path."));
  527. script_ok = false;
  528. }
  529. if (script_ok) {
  530. _msg_script_valid(true, TTR("Script path/name is valid."));
  531. }
  532. // Does script have named classes?
  533. if (has_named_classes) {
  534. if (is_new_script_created) {
  535. class_name->set_editable(true);
  536. class_name->set_placeholder(TTR("Allowed: a-z, A-Z, 0-9, _ and ."));
  537. class_name->set_placeholder_alpha(0.3);
  538. } else {
  539. class_name->set_editable(false);
  540. }
  541. } else {
  542. class_name->set_editable(false);
  543. class_name->set_placeholder(TTR("N/A"));
  544. class_name->set_placeholder_alpha(1);
  545. class_name->set_text("");
  546. }
  547. // Is script Built-in?
  548. if (is_built_in) {
  549. file_path->set_editable(false);
  550. path_button->set_disabled(true);
  551. re_check_path = true;
  552. } else {
  553. file_path->set_editable(true);
  554. path_button->set_disabled(false);
  555. if (re_check_path) {
  556. re_check_path = false;
  557. _path_changed(file_path->get_text());
  558. }
  559. }
  560. if (!_can_be_built_in()) {
  561. internal->set_pressed(false);
  562. }
  563. internal->set_disabled(!_can_be_built_in());
  564. // Is Script created or loaded from existing file?
  565. builtin_warning_label->set_visible(is_built_in);
  566. // Check if the script name is the same as the parent class.
  567. // This warning isn't relevant if the script is built-in.
  568. script_name_warning_label->set_visible(!is_built_in && _get_class_name() == parent_name->get_text());
  569. if (is_built_in) {
  570. get_ok()->set_text(TTR("Create"));
  571. parent_name->set_editable(true);
  572. parent_search_button->set_disabled(false);
  573. parent_browse_button->set_disabled(!can_inherit_from_file);
  574. _msg_path_valid(true, TTR("Built-in script (into scene file)."));
  575. } else if (is_new_script_created) {
  576. // New script created.
  577. get_ok()->set_text(TTR("Create"));
  578. parent_name->set_editable(true);
  579. parent_search_button->set_disabled(false);
  580. parent_browse_button->set_disabled(!can_inherit_from_file);
  581. if (is_path_valid) {
  582. _msg_path_valid(true, TTR("Will create a new script file."));
  583. }
  584. } else if (load_enabled) {
  585. // Script loaded.
  586. get_ok()->set_text(TTR("Load"));
  587. parent_name->set_editable(false);
  588. parent_search_button->set_disabled(true);
  589. parent_browse_button->set_disabled(true);
  590. if (is_path_valid) {
  591. _msg_path_valid(true, TTR("Will load an existing script file."));
  592. }
  593. } else {
  594. get_ok()->set_text(TTR("Create"));
  595. parent_name->set_editable(true);
  596. parent_search_button->set_disabled(false);
  597. parent_browse_button->set_disabled(!can_inherit_from_file);
  598. _msg_path_valid(false, TTR("Script file already exists."));
  599. script_ok = false;
  600. }
  601. get_ok()->set_disabled(!script_ok);
  602. }
  603. void ScriptCreateDialog::_bind_methods() {
  604. ClassDB::bind_method("_path_hbox_sorted", &ScriptCreateDialog::_path_hbox_sorted);
  605. ClassDB::bind_method("_class_name_changed", &ScriptCreateDialog::_class_name_changed);
  606. ClassDB::bind_method("_parent_name_changed", &ScriptCreateDialog::_parent_name_changed);
  607. ClassDB::bind_method("_lang_changed", &ScriptCreateDialog::_lang_changed);
  608. ClassDB::bind_method("_built_in_pressed", &ScriptCreateDialog::_built_in_pressed);
  609. ClassDB::bind_method("_browse_path", &ScriptCreateDialog::_browse_path);
  610. ClassDB::bind_method("_file_selected", &ScriptCreateDialog::_file_selected);
  611. ClassDB::bind_method("_path_changed", &ScriptCreateDialog::_path_changed);
  612. ClassDB::bind_method("_path_entered", &ScriptCreateDialog::_path_entered);
  613. ClassDB::bind_method("_template_changed", &ScriptCreateDialog::_template_changed);
  614. ClassDB::bind_method("_create", &ScriptCreateDialog::_create);
  615. ClassDB::bind_method("_browse_class_in_tree", &ScriptCreateDialog::_browse_class_in_tree);
  616. ClassDB::bind_method(D_METHOD("config", "inherits", "path", "built_in_enabled", "load_enabled"), &ScriptCreateDialog::config, DEFVAL(true), DEFVAL(true));
  617. ADD_SIGNAL(MethodInfo("script_created", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script")));
  618. }
  619. ScriptCreateDialog::ScriptCreateDialog() {
  620. /* DIALOG */
  621. /* Main Controls */
  622. GridContainer *gc = memnew(GridContainer);
  623. gc->set_columns(2);
  624. /* Error Messages Field */
  625. VBoxContainer *vb = memnew(VBoxContainer);
  626. error_label = memnew(Label);
  627. vb->add_child(error_label);
  628. path_error_label = memnew(Label);
  629. vb->add_child(path_error_label);
  630. builtin_warning_label = memnew(Label);
  631. builtin_warning_label->set_text(
  632. TTR("Note: Built-in scripts have some limitations and can't be edited using an external editor."));
  633. vb->add_child(builtin_warning_label);
  634. builtin_warning_label->set_autowrap(true);
  635. builtin_warning_label->hide();
  636. script_name_warning_label = memnew(Label);
  637. script_name_warning_label->set_text(
  638. TTR("Warning: Having the script name be the same as a built-in type is usually not desired."));
  639. vb->add_child(script_name_warning_label);
  640. script_name_warning_label->add_color_override("font_color", Color(1, 0.85, 0.4));
  641. script_name_warning_label->set_autowrap(true);
  642. script_name_warning_label->hide();
  643. status_panel = memnew(PanelContainer);
  644. status_panel->set_h_size_flags(Control::SIZE_FILL);
  645. status_panel->add_child(vb);
  646. /* Spacing */
  647. Control *spacing = memnew(Control);
  648. spacing->set_custom_minimum_size(Size2(0, 10 * EDSCALE));
  649. vb = memnew(VBoxContainer);
  650. vb->add_child(gc);
  651. vb->add_child(spacing);
  652. vb->add_child(status_panel);
  653. HBoxContainer *hb = memnew(HBoxContainer);
  654. hb->add_child(vb);
  655. add_child(hb);
  656. /* Language */
  657. language_menu = memnew(OptionButton);
  658. language_menu->set_custom_minimum_size(Size2(250, 0) * EDSCALE);
  659. language_menu->set_h_size_flags(SIZE_EXPAND_FILL);
  660. gc->add_child(memnew(Label(TTR("Language:"))));
  661. gc->add_child(language_menu);
  662. default_language = -1;
  663. for (int i = 0; i < ScriptServer::get_language_count(); i++) {
  664. String lang = ScriptServer::get_language(i)->get_name();
  665. language_menu->add_item(lang);
  666. if (lang == "GDScript") {
  667. default_language = i;
  668. }
  669. }
  670. if (default_language >= 0) {
  671. language_menu->select(default_language);
  672. }
  673. current_language = default_language;
  674. language_menu->connect("item_selected", this, "_lang_changed");
  675. /* Inherits */
  676. base_type = "Object";
  677. hb = memnew(HBoxContainer);
  678. hb->set_h_size_flags(SIZE_EXPAND_FILL);
  679. parent_name = memnew(LineEdit);
  680. parent_name->connect("text_changed", this, "_parent_name_changed");
  681. parent_name->set_h_size_flags(SIZE_EXPAND_FILL);
  682. hb->add_child(parent_name);
  683. parent_search_button = memnew(Button);
  684. parent_search_button->set_flat(true);
  685. parent_search_button->connect("pressed", this, "_browse_class_in_tree");
  686. hb->add_child(parent_search_button);
  687. parent_browse_button = memnew(Button);
  688. parent_browse_button->set_flat(true);
  689. parent_browse_button->connect("pressed", this, "_browse_path", varray(true, false));
  690. hb->add_child(parent_browse_button);
  691. gc->add_child(memnew(Label(TTR("Inherits:"))));
  692. gc->add_child(hb);
  693. is_browsing_parent = false;
  694. /* Class Name */
  695. class_name = memnew(LineEdit);
  696. class_name->connect("text_changed", this, "_class_name_changed");
  697. class_name->set_h_size_flags(SIZE_EXPAND_FILL);
  698. gc->add_child(memnew(Label(TTR("Class Name:"))));
  699. gc->add_child(class_name);
  700. /* Templates */
  701. template_menu = memnew(OptionButton);
  702. gc->add_child(memnew(Label(TTR("Template:"))));
  703. gc->add_child(template_menu);
  704. template_menu->connect("item_selected", this, "_template_changed");
  705. /* Built-in Script */
  706. internal = memnew(CheckBox);
  707. internal->set_text(TTR("On"));
  708. internal->connect("pressed", this, "_built_in_pressed");
  709. gc->add_child(memnew(Label(TTR("Built-in Script:"))));
  710. gc->add_child(internal);
  711. /* Path */
  712. hb = memnew(HBoxContainer);
  713. hb->connect("sort_children", this, "_path_hbox_sorted");
  714. file_path = memnew(LineEdit);
  715. file_path->connect("text_changed", this, "_path_changed");
  716. file_path->connect("text_entered", this, "_path_entered");
  717. file_path->set_h_size_flags(SIZE_EXPAND_FILL);
  718. hb->add_child(file_path);
  719. path_button = memnew(Button);
  720. path_button->set_flat(true);
  721. path_button->connect("pressed", this, "_browse_path", varray(false, true));
  722. hb->add_child(path_button);
  723. gc->add_child(memnew(Label(TTR("Path:"))));
  724. gc->add_child(hb);
  725. re_check_path = false;
  726. /* Dialog Setup */
  727. select_class = memnew(CreateDialog);
  728. select_class->connect("create", this, "_create");
  729. add_child(select_class);
  730. file_browse = memnew(EditorFileDialog);
  731. file_browse->connect("file_selected", this, "_file_selected");
  732. file_browse->set_mode(EditorFileDialog::MODE_OPEN_FILE);
  733. add_child(file_browse);
  734. get_ok()->set_text(TTR("Create"));
  735. alert = memnew(AcceptDialog);
  736. alert->set_as_minsize();
  737. alert->get_label()->set_autowrap(true);
  738. alert->get_label()->set_align(Label::ALIGN_CENTER);
  739. alert->get_label()->set_valign(Label::VALIGN_CENTER);
  740. alert->get_label()->set_custom_minimum_size(Size2(325, 60) * EDSCALE);
  741. add_child(alert);
  742. set_as_minsize();
  743. set_hide_on_ok(false);
  744. set_title(TTR("Attach Node Script"));
  745. is_parent_name_valid = false;
  746. is_class_name_valid = false;
  747. is_path_valid = false;
  748. has_named_classes = false;
  749. supports_built_in = false;
  750. can_inherit_from_file = false;
  751. is_built_in = false;
  752. built_in_enabled = true;
  753. load_enabled = true;
  754. is_new_script_created = true;
  755. }