editor_settings.cpp 98 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123
  1. /**************************************************************************/
  2. /* editor_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_settings.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/input/input_event.h"
  33. #include "core/input/input_map.h"
  34. #include "core/input/shortcut.h"
  35. #include "core/io/certs_compressed.gen.h"
  36. #include "core/io/dir_access.h"
  37. #include "core/io/file_access.h"
  38. #include "core/io/ip.h"
  39. #include "core/io/resource_loader.h"
  40. #include "core/io/resource_saver.h"
  41. #include "core/object/class_db.h"
  42. #include "core/os/keyboard.h"
  43. #include "core/os/os.h"
  44. #include "core/string/translation_server.h"
  45. #include "core/version.h"
  46. #include "editor/editor_node.h"
  47. #include "editor/editor_paths.h"
  48. #include "editor/editor_property_name_processor.h"
  49. #include "editor/editor_translation.h"
  50. #include "editor/engine_update_label.h"
  51. #include "scene/gui/color_picker.h"
  52. #include "scene/main/node.h"
  53. #include "scene/main/scene_tree.h"
  54. #include "scene/main/window.h"
  55. // PRIVATE METHODS
  56. Ref<EditorSettings> EditorSettings::singleton = nullptr;
  57. // Properties
  58. bool EditorSettings::_set(const StringName &p_name, const Variant &p_value) {
  59. _THREAD_SAFE_METHOD_
  60. bool changed = _set_only(p_name, p_value);
  61. if (changed && initialized) {
  62. changed_settings.insert(p_name);
  63. emit_signal(SNAME("settings_changed"));
  64. }
  65. return true;
  66. }
  67. bool EditorSettings::_set_only(const StringName &p_name, const Variant &p_value) {
  68. _THREAD_SAFE_METHOD_
  69. if (p_name == "shortcuts") {
  70. Array arr = p_value;
  71. for (int i = 0; i < arr.size(); i++) {
  72. Dictionary dict = arr[i];
  73. String shortcut_name = dict["name"];
  74. Array shortcut_events = dict["shortcuts"];
  75. Ref<Shortcut> sc;
  76. sc.instantiate();
  77. sc->set_events(shortcut_events);
  78. add_shortcut(shortcut_name, sc);
  79. }
  80. return false;
  81. } else if (p_name == "builtin_action_overrides") {
  82. Array actions_arr = p_value;
  83. for (int i = 0; i < actions_arr.size(); i++) {
  84. Dictionary action_dict = actions_arr[i];
  85. String action_name = action_dict["name"];
  86. Array events = action_dict["events"];
  87. InputMap *im = InputMap::get_singleton();
  88. im->action_erase_events(action_name);
  89. builtin_action_overrides[action_name].clear();
  90. for (int ev_idx = 0; ev_idx < events.size(); ev_idx++) {
  91. im->action_add_event(action_name, events[ev_idx]);
  92. builtin_action_overrides[action_name].push_back(events[ev_idx]);
  93. }
  94. }
  95. return false;
  96. }
  97. bool changed = false;
  98. if (p_value.get_type() == Variant::NIL) {
  99. if (props.has(p_name)) {
  100. props.erase(p_name);
  101. changed = true;
  102. }
  103. } else {
  104. if (props.has(p_name)) {
  105. if (p_value != props[p_name].variant) {
  106. props[p_name].variant = p_value;
  107. changed = true;
  108. }
  109. } else {
  110. props[p_name] = VariantContainer(p_value, last_order++);
  111. changed = true;
  112. }
  113. if (save_changed_setting) {
  114. if (!props[p_name].save) {
  115. props[p_name].save = true;
  116. changed = true;
  117. }
  118. }
  119. }
  120. return changed;
  121. }
  122. bool EditorSettings::_get(const StringName &p_name, Variant &r_ret) const {
  123. _THREAD_SAFE_METHOD_
  124. if (p_name == "shortcuts") {
  125. Array save_array;
  126. const HashMap<String, List<Ref<InputEvent>>> &builtin_list = InputMap::get_singleton()->get_builtins();
  127. for (const KeyValue<String, Ref<Shortcut>> &shortcut_definition : shortcuts) {
  128. Ref<Shortcut> sc = shortcut_definition.value;
  129. if (builtin_list.has(shortcut_definition.key)) {
  130. // This shortcut was auto-generated from built in actions: don't save.
  131. // If the builtin is overridden, it will be saved in the "builtin_action_overrides" section below.
  132. continue;
  133. }
  134. Array shortcut_events = sc->get_events();
  135. Dictionary dict;
  136. dict["name"] = shortcut_definition.key;
  137. dict["shortcuts"] = shortcut_events;
  138. if (!sc->has_meta("original")) {
  139. // Getting the meta when it doesn't exist will return an empty array. If the 'shortcut_events' have been cleared,
  140. // we still want save the shortcut in this case so that shortcuts that the user has customized are not reset,
  141. // even if the 'original' has not been populated yet. This can happen when calling save() from the Project Manager.
  142. save_array.push_back(dict);
  143. continue;
  144. }
  145. Array original_events = sc->get_meta("original");
  146. bool is_same = Shortcut::is_event_array_equal(original_events, shortcut_events);
  147. if (is_same) {
  148. continue; // Not changed from default; don't save.
  149. }
  150. save_array.push_back(dict);
  151. }
  152. r_ret = save_array;
  153. return true;
  154. } else if (p_name == "builtin_action_overrides") {
  155. Array actions_arr;
  156. for (const KeyValue<String, List<Ref<InputEvent>>> &action_override : builtin_action_overrides) {
  157. List<Ref<InputEvent>> events = action_override.value;
  158. Dictionary action_dict;
  159. action_dict["name"] = action_override.key;
  160. // Convert the list to an array, and only keep key events as this is for the editor.
  161. Array events_arr;
  162. for (const Ref<InputEvent> &ie : events) {
  163. Ref<InputEventKey> iek = ie;
  164. if (iek.is_valid()) {
  165. events_arr.append(iek);
  166. }
  167. }
  168. Array defaults_arr;
  169. List<Ref<InputEvent>> defaults = InputMap::get_singleton()->get_builtins()[action_override.key];
  170. for (const Ref<InputEvent> &default_input_event : defaults) {
  171. if (default_input_event.is_valid()) {
  172. defaults_arr.append(default_input_event);
  173. }
  174. }
  175. bool same = Shortcut::is_event_array_equal(events_arr, defaults_arr);
  176. // Don't save if same as default.
  177. if (same) {
  178. continue;
  179. }
  180. action_dict["events"] = events_arr;
  181. actions_arr.push_back(action_dict);
  182. }
  183. r_ret = actions_arr;
  184. return true;
  185. }
  186. const VariantContainer *v = props.getptr(p_name);
  187. if (!v) {
  188. return false;
  189. }
  190. r_ret = v->variant;
  191. return true;
  192. }
  193. void EditorSettings::_initial_set(const StringName &p_name, const Variant &p_value, bool p_basic) {
  194. set(p_name, p_value);
  195. props[p_name].initial = p_value;
  196. props[p_name].has_default_value = true;
  197. props[p_name].basic = p_basic;
  198. }
  199. struct _EVCSort {
  200. String name;
  201. Variant::Type type = Variant::Type::NIL;
  202. int order = 0;
  203. bool basic = false;
  204. bool save = false;
  205. bool restart_if_changed = false;
  206. bool operator<(const _EVCSort &p_vcs) const { return order < p_vcs.order; }
  207. };
  208. void EditorSettings::_get_property_list(List<PropertyInfo> *p_list) const {
  209. _THREAD_SAFE_METHOD_
  210. RBSet<_EVCSort> vclist;
  211. for (const KeyValue<String, VariantContainer> &E : props) {
  212. const VariantContainer *v = &E.value;
  213. if (v->hide_from_editor) {
  214. continue;
  215. }
  216. _EVCSort vc;
  217. vc.name = E.key;
  218. vc.order = v->order;
  219. vc.type = v->variant.get_type();
  220. vc.basic = v->basic;
  221. vc.save = v->save;
  222. if (vc.save) {
  223. if (v->initial.get_type() != Variant::NIL && v->initial == v->variant) {
  224. vc.save = false;
  225. }
  226. }
  227. vc.restart_if_changed = v->restart_if_changed;
  228. vclist.insert(vc);
  229. }
  230. for (const _EVCSort &E : vclist) {
  231. uint32_t pusage = PROPERTY_USAGE_NONE;
  232. if (E.save || !optimize_save) {
  233. pusage |= PROPERTY_USAGE_STORAGE;
  234. }
  235. if (!E.name.begins_with("_") && !E.name.begins_with("projects/")) {
  236. pusage |= PROPERTY_USAGE_EDITOR;
  237. } else {
  238. pusage |= PROPERTY_USAGE_STORAGE; //hiddens must always be saved
  239. }
  240. PropertyInfo pi(E.type, E.name);
  241. pi.usage = pusage;
  242. if (hints.has(E.name)) {
  243. pi = hints[E.name];
  244. }
  245. if (E.basic) {
  246. pi.usage |= PROPERTY_USAGE_EDITOR_BASIC_SETTING;
  247. }
  248. if (E.restart_if_changed) {
  249. pi.usage |= PROPERTY_USAGE_RESTART_IF_CHANGED;
  250. }
  251. p_list->push_back(pi);
  252. }
  253. p_list->push_back(PropertyInfo(Variant::ARRAY, "shortcuts", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL)); //do not edit
  254. p_list->push_back(PropertyInfo(Variant::ARRAY, "builtin_action_overrides", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
  255. }
  256. void EditorSettings::_add_property_info_bind(const Dictionary &p_info) {
  257. ERR_FAIL_COND(!p_info.has("name"));
  258. ERR_FAIL_COND(!p_info.has("type"));
  259. PropertyInfo pinfo;
  260. pinfo.name = p_info["name"];
  261. ERR_FAIL_COND(!props.has(pinfo.name));
  262. pinfo.type = Variant::Type(p_info["type"].operator int());
  263. ERR_FAIL_INDEX(pinfo.type, Variant::VARIANT_MAX);
  264. if (p_info.has("hint")) {
  265. pinfo.hint = PropertyHint(p_info["hint"].operator int());
  266. }
  267. if (p_info.has("hint_string")) {
  268. pinfo.hint_string = p_info["hint_string"];
  269. }
  270. add_property_hint(pinfo);
  271. }
  272. // Default configs
  273. bool EditorSettings::has_default_value(const String &p_setting) const {
  274. _THREAD_SAFE_METHOD_
  275. if (!props.has(p_setting)) {
  276. return false;
  277. }
  278. return props[p_setting].has_default_value;
  279. }
  280. void EditorSettings::_set_initialized() {
  281. initialized = true;
  282. }
  283. void EditorSettings::_load_defaults(Ref<ConfigFile> p_extra_config) {
  284. _THREAD_SAFE_METHOD_
  285. // Sets up the editor setting with a default value and hint PropertyInfo.
  286. #define EDITOR_SETTING(m_type, m_property_hint, m_name, m_default_value, m_hint_string) \
  287. _initial_set(m_name, m_default_value); \
  288. hints[m_name] = PropertyInfo(m_type, m_name, m_property_hint, m_hint_string);
  289. #define EDITOR_SETTING_BASIC(m_type, m_property_hint, m_name, m_default_value, m_hint_string) \
  290. _initial_set(m_name, m_default_value, true); \
  291. hints[m_name] = PropertyInfo(m_type, m_name, m_property_hint, m_hint_string);
  292. #define EDITOR_SETTING_USAGE(m_type, m_property_hint, m_name, m_default_value, m_hint_string, m_usage) \
  293. _initial_set(m_name, m_default_value); \
  294. hints[m_name] = PropertyInfo(m_type, m_name, m_property_hint, m_hint_string, m_usage);
  295. /* Languages */
  296. {
  297. String lang_hint = "en";
  298. String host_lang = OS::get_singleton()->get_locale();
  299. // Skip locales if Text server lack required features.
  300. Vector<String> locales_to_skip;
  301. if (!TS->has_feature(TextServer::FEATURE_BIDI_LAYOUT) || !TS->has_feature(TextServer::FEATURE_SHAPING)) {
  302. locales_to_skip.push_back("ar"); // Arabic
  303. locales_to_skip.push_back("fa"); // Persian
  304. locales_to_skip.push_back("ur"); // Urdu
  305. }
  306. if (!TS->has_feature(TextServer::FEATURE_BIDI_LAYOUT)) {
  307. locales_to_skip.push_back("he"); // Hebrew
  308. }
  309. if (!TS->has_feature(TextServer::FEATURE_SHAPING)) {
  310. locales_to_skip.push_back("bn"); // Bengali
  311. locales_to_skip.push_back("hi"); // Hindi
  312. locales_to_skip.push_back("ml"); // Malayalam
  313. locales_to_skip.push_back("si"); // Sinhala
  314. locales_to_skip.push_back("ta"); // Tamil
  315. locales_to_skip.push_back("te"); // Telugu
  316. }
  317. if (!locales_to_skip.is_empty()) {
  318. WARN_PRINT("Some locales are not properly supported by selected Text Server and are disabled.");
  319. }
  320. String best;
  321. int best_score = 0;
  322. for (const String &locale : get_editor_locales()) {
  323. // Skip locales which we can't render properly (see above comment).
  324. // Test against language code without regional variants (e.g. ur_PK).
  325. String lang_code = locale.get_slicec('_', 0);
  326. if (locales_to_skip.has(lang_code)) {
  327. continue;
  328. }
  329. lang_hint += ",";
  330. lang_hint += locale;
  331. int score = TranslationServer::get_singleton()->compare_locales(host_lang, locale);
  332. if (score > 0 && score >= best_score) {
  333. best = locale;
  334. best_score = score;
  335. }
  336. }
  337. if (best_score == 0) {
  338. best = "en";
  339. }
  340. EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_ENUM, "interface/editor/editor_language", best, lang_hint, PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING);
  341. }
  342. // Asset library
  343. _initial_set("asset_library/use_threads", true);
  344. /* Interface */
  345. // Editor
  346. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/localize_settings", true, "")
  347. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/dock_tab_style", 0, "Text Only,Icon Only,Text and Icon")
  348. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/ui_layout_direction", 0, "Based on Application Locale,Left-to-Right,Right-to-Left,Based on System Locale", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  349. // Display what the Auto display scale setting effectively corresponds to.
  350. const String display_scale_hint_string = vformat("Auto (%d%%),75%%,100%%,125%%,150%%,175%%,200%%,Custom", Math::round(get_auto_display_scale() * 100));
  351. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/display_scale", 0, display_scale_hint_string, PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING)
  352. EDITOR_SETTING_USAGE(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/editor/custom_display_scale", 1.0, "0.5,3,0.01", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING)
  353. String ed_screen_hints = "Auto (Remembers last position):-5,Screen With Mouse Pointer:-4,Screen With Keyboard Focus:-3,Primary Screen:-2";
  354. for (int i = 0; i < DisplayServer::get_singleton()->get_screen_count(); i++) {
  355. ed_screen_hints += ",Screen " + itos(i + 1) + ":" + itos(i);
  356. }
  357. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/editor_screen", EditorSettings::InitialScreen::INITIAL_SCREEN_AUTO, ed_screen_hints)
  358. String project_manager_screen_hints = "Screen With Mouse Pointer:-4,Screen With Keyboard Focus:-3,Primary Screen:-2";
  359. for (int i = 0; i < DisplayServer::get_singleton()->get_screen_count(); i++) {
  360. project_manager_screen_hints += ",Screen " + itos(i + 1) + ":" + itos(i);
  361. }
  362. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/project_manager_screen", EditorSettings::InitialScreen::INITIAL_SCREEN_PRIMARY, project_manager_screen_hints)
  363. {
  364. EngineUpdateLabel::UpdateMode default_update_mode = EngineUpdateLabel::UpdateMode::NEWEST_UNSTABLE;
  365. if (String(VERSION_STATUS) == String("stable")) {
  366. default_update_mode = EngineUpdateLabel::UpdateMode::NEWEST_STABLE;
  367. }
  368. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "network/connection/engine_version_update_mode", int(default_update_mode), "Disable Update Checks,Check Newest Preview,Check Newest Stable,Check Newest Patch"); // Uses EngineUpdateLabel::UpdateMode.
  369. }
  370. EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/use_embedded_menu", false, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING)
  371. EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/use_native_file_dialogs", false, "", PROPERTY_USAGE_DEFAULT)
  372. EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/expand_to_title", true, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING)
  373. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "interface/editor/main_font_size", 14, "8,48,1")
  374. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "interface/editor/code_font_size", 14, "8,48,1")
  375. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/code_font_contextual_ligatures", 1, "Enabled,Disable Contextual Alternates (Coding Ligatures),Use Custom OpenType Feature Set")
  376. _initial_set("interface/editor/code_font_custom_opentype_features", "");
  377. _initial_set("interface/editor/code_font_custom_variations", "");
  378. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/font_antialiasing", 1, "None,Grayscale,LCD Subpixel")
  379. #ifdef MACOS_ENABLED
  380. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/font_hinting", 0, "Auto (None),None,Light,Normal")
  381. #else
  382. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/font_hinting", 0, "Auto (Light),None,Light,Normal")
  383. #endif
  384. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/font_subpixel_positioning", 1, "Disabled,Auto,One Half of a Pixel,One Quarter of a Pixel")
  385. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/font_disable_embedded_bitmaps", true, "");
  386. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/font_allow_msdf", true, "")
  387. EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "interface/editor/main_font", "", "*.ttf,*.otf,*.woff,*.woff2,*.pfb,*.pfm")
  388. EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "interface/editor/main_font_bold", "", "*.ttf,*.otf,*.woff,*.woff2,*.pfb,*.pfm")
  389. EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "interface/editor/code_font", "", "*.ttf,*.otf,*.woff,*.woff2,*.pfb,*.pfm")
  390. _initial_set("interface/editor/separate_distraction_mode", false, true);
  391. _initial_set("interface/editor/automatically_open_screenshots", true, true);
  392. EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/single_window_mode", false, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING)
  393. _initial_set("interface/editor/mouse_extra_buttons_navigate_history", true);
  394. _initial_set("interface/editor/save_each_scene_on_quit", true, true); // Regression
  395. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/save_on_focus_loss", false, "")
  396. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/accept_dialog_cancel_ok_buttons", 0,
  397. vformat("Auto (%s),Cancel First,OK First", DisplayServer::get_singleton()->get_swap_cancel_ok() ? "OK First" : "Cancel First"),
  398. PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED);
  399. #ifdef DEV_ENABLED
  400. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/show_internal_errors_in_toast_notifications", 0, "Auto (Enabled),Enabled,Disabled")
  401. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/show_update_spinner", 0, "Auto (Enabled),Enabled,Disabled")
  402. #else
  403. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/show_internal_errors_in_toast_notifications", 0, "Auto (Disabled),Enabled,Disabled")
  404. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/show_update_spinner", 0, "Auto (Disabled),Enabled,Disabled")
  405. #endif
  406. _initial_set("interface/editor/keep_screen_on", false, true);
  407. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "interface/editor/low_processor_mode_sleep_usec", 6900, "1,100000,1", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  408. // Default unfocused usec sleep is for 10 FPS. Allow an unfocused FPS limit
  409. // as low as 1 FPS for those who really need low power usage (but don't need
  410. // to preview particles or shaders while the editor is unfocused). With very
  411. // low FPS limits, the editor can take a small while to become usable after
  412. // being focused again, so this should be used at the user's discretion.
  413. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "interface/editor/unfocused_low_processor_mode_sleep_usec", 100000, "1,1000000,1", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  414. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/import_resources_when_unfocused", false, "")
  415. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/vsync_mode", 1, "Disabled,Enabled,Adaptive,Mailbox")
  416. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/update_continuously", false, "")
  417. _initial_set("interface/editors/show_scene_tree_root_selection", true);
  418. _initial_set("interface/editors/derive_script_globals_by_name", true);
  419. _initial_set("docks/scene_tree/ask_before_revoking_unique_name", true);
  420. // Inspector
  421. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "interface/inspector/max_array_dictionary_items_per_page", 20, "10,100,1")
  422. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/show_low_level_opentype_features", false, "")
  423. EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/inspector/float_drag_speed", 5.0, "0.1,100,0.01")
  424. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/inspector/nested_color_mode", 0, "Containers & Resources,Resources,External Resources")
  425. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/delimitate_all_container_and_resources", true, "")
  426. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_ENUM, "interface/inspector/default_property_name_style", EditorPropertyNameProcessor::STYLE_CAPITALIZED, "Raw (e.g. \"z_index\"),Capitalized (e.g. \"Z Index\"),Localized (e.g. \"Z Index\")", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED);
  427. // The lowest value is equal to the minimum float step for 32-bit floats.
  428. // The step must be set manually, as changing this setting should not change the step here.
  429. EDITOR_SETTING_USAGE(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/inspector/default_float_step", 0.001, "0.0000001,1,0.0000001", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING);
  430. EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/disable_folding", false, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED);
  431. EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/auto_unfold_foreign_scenes", true, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  432. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/horizontal_vector2_editing", false, "")
  433. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/horizontal_vector_types_editing", true, "")
  434. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/open_resources_in_current_inspector", true, "")
  435. PackedStringArray open_in_new_inspector_defaults;
  436. // Required for the script editor to work.
  437. open_in_new_inspector_defaults.push_back("Script");
  438. // Required for the GridMap editor to work.
  439. open_in_new_inspector_defaults.push_back("MeshLibrary");
  440. _initial_set("interface/inspector/resources_to_open_in_new_inspector", open_in_new_inspector_defaults);
  441. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/inspector/default_color_picker_mode", (int32_t)ColorPicker::MODE_RGB, "RGB,HSV,RAW,OKHSL")
  442. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/inspector/default_color_picker_shape", (int32_t)ColorPicker::SHAPE_OKHSL_CIRCLE, "HSV Rectangle,HSV Rectangle Wheel,VHS Circle,OKHSL Circle")
  443. // Theme
  444. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_ENUM, "interface/theme/follow_system_theme", false, "")
  445. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_ENUM, "interface/theme/preset", "Default", "Default,Breeze Dark,Godot 2,Gray,Light,Solarized (Dark),Solarized (Light),Black (OLED),Custom")
  446. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_ENUM, "interface/theme/spacing_preset", "Default", "Compact,Default,Spacious,Custom")
  447. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/theme/icon_and_font_color", 0, "Auto,Dark,Light")
  448. EDITOR_SETTING_BASIC(Variant::COLOR, PROPERTY_HINT_NONE, "interface/theme/base_color", Color(0.2, 0.23, 0.31), "")
  449. EDITOR_SETTING_BASIC(Variant::COLOR, PROPERTY_HINT_NONE, "interface/theme/accent_color", Color(0.41, 0.61, 0.91), "")
  450. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/theme/use_system_accent_color", false, "")
  451. EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/theme/contrast", 0.3, "-1,1,0.01")
  452. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/theme/draw_extra_borders", false, "")
  453. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/theme/icon_saturation", 1.0, "0,2,0.01")
  454. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/theme/relationship_line_opacity", 0.1, "0.00,1,0.01")
  455. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "interface/theme/border_size", 0, "0,2,1")
  456. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "interface/theme/corner_radius", 3, "0,6,1")
  457. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "interface/theme/base_spacing", 4, "0,8,1")
  458. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "interface/theme/additional_spacing", 0, "0,8,1")
  459. EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "interface/theme/custom_theme", "", "*.res,*.tres,*.theme", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  460. // Touchscreen
  461. bool has_touchscreen_ui = DisplayServer::get_singleton()->is_touchscreen_available();
  462. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/touchscreen/enable_pan_and_scale_gestures", has_touchscreen_ui, "")
  463. set_restart_if_changed("interface/touchscreen/enable_pan_and_scale_gestures", true);
  464. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/touchscreen/scale_gizmo_handles", has_touchscreen_ui ? 3 : 1, "1,5,1")
  465. set_restart_if_changed("interface/touchscreen/scale_gizmo_handles", true);
  466. // Disable some touchscreen settings by default for the XR Editor.
  467. bool is_native_touchscreen = has_touchscreen_ui && !OS::get_singleton()->has_feature("xr_editor");
  468. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/touchscreen/enable_long_press_as_right_click", is_native_touchscreen, "")
  469. set_restart_if_changed("interface/touchscreen/enable_long_press_as_right_click", true);
  470. EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/touchscreen/increase_scrollbar_touch_area", is_native_touchscreen, "")
  471. set_restart_if_changed("interface/touchscreen/increase_scrollbar_touch_area", true);
  472. // Scene tabs
  473. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/scene_tabs/display_close_button", 1, "Never,If Tab Active,Always"); // TabBar::CloseButtonDisplayPolicy
  474. _initial_set("interface/scene_tabs/show_thumbnail_on_hover", true);
  475. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "interface/scene_tabs/maximum_width", 350, "0,9999,1", PROPERTY_USAGE_DEFAULT)
  476. _initial_set("interface/scene_tabs/show_script_button", false, true);
  477. _initial_set("interface/scene_tabs/restore_scenes_on_load", true, true);
  478. // Multi Window
  479. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/multi_window/enable", true, "");
  480. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/multi_window/restore_windows_on_load", true, "");
  481. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/multi_window/maximize_window", false, "");
  482. set_restart_if_changed("interface/multi_window/enable", true);
  483. /* Filesystem */
  484. // External Programs
  485. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/raster_image_editor", "", "")
  486. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/vector_image_editor", "", "")
  487. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/audio_editor", "", "")
  488. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/3d_model_editor", "", "")
  489. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/terminal_emulator", "", "")
  490. EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_PLACEHOLDER_TEXT, "filesystem/external_programs/terminal_emulator_flags", "", "Call flags with placeholder: {directory}.");
  491. // Directories
  492. EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_DIR, "filesystem/directories/autoscan_project_path", "", "")
  493. const String fs_dir_default_project_path = OS::get_singleton()->has_environment("HOME") ? OS::get_singleton()->get_environment("HOME") : OS::get_singleton()->get_system_dir(OS::SYSTEM_DIR_DOCUMENTS);
  494. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_DIR, "filesystem/directories/default_project_path", fs_dir_default_project_path, "")
  495. // On save
  496. _initial_set("filesystem/on_save/compress_binary_resources", true);
  497. _initial_set("filesystem/on_save/safe_save_on_backup_then_rename", true);
  498. // EditorFileServer
  499. _initial_set("filesystem/file_server/port", 6010);
  500. _initial_set("filesystem/file_server/password", "");
  501. // File dialog
  502. _initial_set("filesystem/file_dialog/show_hidden_files", false);
  503. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "filesystem/file_dialog/display_mode", 0, "Thumbnails,List")
  504. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "filesystem/file_dialog/thumbnail_size", 64, "32,128,16")
  505. // Quick Open dialog
  506. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "filesystem/quick_open_dialog/max_results", 100, "0,10000,1", PROPERTY_USAGE_DEFAULT)
  507. _initial_set("filesystem/quick_open_dialog/show_search_highlight", true);
  508. _initial_set("filesystem/quick_open_dialog/enable_fuzzy_matching", true);
  509. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "filesystem/quick_open_dialog/max_fuzzy_misses", 2, "0,10,1", PROPERTY_USAGE_DEFAULT)
  510. _initial_set("filesystem/quick_open_dialog/include_addons", false);
  511. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "filesystem/quick_open_dialog/default_display_mode", 0, "Adaptive,Last Used")
  512. // Import (for glft module)
  513. EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/import/blender/blender_path", "", "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING)
  514. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "filesystem/import/blender/rpc_port", 6011, "0,65535,1", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  515. EDITOR_SETTING_USAGE(Variant::FLOAT, PROPERTY_HINT_RANGE, "filesystem/import/blender/rpc_server_uptime", 5, "0,300,1,or_greater,suffix:s", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  516. EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/import/fbx/fbx2gltf_path", "", "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  517. // Tools (denoise)
  518. EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_GLOBAL_DIR, "filesystem/tools/oidn/oidn_denoise_path", "", "", PROPERTY_USAGE_DEFAULT)
  519. /* Docks */
  520. // SceneTree
  521. _initial_set("docks/scene_tree/ask_before_deleting_related_animation_tracks", true);
  522. _initial_set("docks/scene_tree/start_create_dialog_fully_expanded", false);
  523. _initial_set("docks/scene_tree/auto_expand_to_selected", true);
  524. _initial_set("docks/scene_tree/center_node_on_reparent", false);
  525. _initial_set("docks/scene_tree/hide_filtered_out_parents", true);
  526. // FileSystem
  527. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "docks/filesystem/thumbnail_size", 64, "32,128,16")
  528. _initial_set("docks/filesystem/always_show_folders", true);
  529. _initial_set("docks/filesystem/textfile_extensions", "txt,md,cfg,ini,log,json,yml,yaml,toml,xml");
  530. _initial_set("docks/filesystem/other_file_extensions", "ico,icns");
  531. // Property editor
  532. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "docks/property_editor/auto_refresh_interval", 0.2, "0.01,1,0.001"); // Update 5 times per second by default.
  533. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "docks/property_editor/subresource_hue_tint", 0.75, "0,1,0.01")
  534. /* Text editor */
  535. // Theme
  536. _initial_set("text_editor/theme/line_spacing", 6);
  537. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_ENUM, "text_editor/theme/color_theme", "Default", "Default,Godot 2,Custom")
  538. // Theme: Highlighting
  539. _load_godot2_text_editor_theme();
  540. // Appearance
  541. // Appearance: Caret
  542. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/appearance/caret/type", 0, "Line,Block")
  543. _initial_set("text_editor/appearance/caret/caret_blink", true, true);
  544. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "text_editor/appearance/caret/caret_blink_interval", 0.5, "0.1,10,0.01")
  545. _initial_set("text_editor/appearance/caret/highlight_current_line", true, true);
  546. _initial_set("text_editor/appearance/caret/highlight_all_occurrences", true, true);
  547. // Appearance: Guidelines
  548. _initial_set("text_editor/appearance/guidelines/show_line_length_guidelines", true, true);
  549. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/appearance/guidelines/line_length_guideline_soft_column", 80, "20,160,1")
  550. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/appearance/guidelines/line_length_guideline_hard_column", 100, "20,160,1")
  551. // Appearance: Gutters
  552. _initial_set("text_editor/appearance/gutters/show_line_numbers", true, true);
  553. _initial_set("text_editor/appearance/gutters/line_numbers_zero_padded", false, true);
  554. _initial_set("text_editor/appearance/gutters/highlight_type_safe_lines", true, true);
  555. _initial_set("text_editor/appearance/gutters/show_info_gutter", true, true);
  556. // Appearance: Minimap
  557. _initial_set("text_editor/appearance/minimap/show_minimap", true, true);
  558. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/appearance/minimap/minimap_width", 80, "50,250,1")
  559. // Appearance: Lines
  560. _initial_set("text_editor/appearance/lines/code_folding", true, true);
  561. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/appearance/lines/word_wrap", 0, "None,Boundary")
  562. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/appearance/lines/autowrap_mode", 3, "Arbitrary:1,Word:2,Word (Smart):3")
  563. // Appearance: Whitespace
  564. _initial_set("text_editor/appearance/whitespace/draw_tabs", true, true);
  565. _initial_set("text_editor/appearance/whitespace/draw_spaces", false, true);
  566. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/appearance/whitespace/line_spacing", 4, "0,50,1")
  567. // Behavior
  568. // Behavior: General
  569. _initial_set("text_editor/behavior/general/empty_selection_clipboard", true);
  570. // Behavior: Navigation
  571. _initial_set("text_editor/behavior/navigation/move_caret_on_right_click", true, true);
  572. _initial_set("text_editor/behavior/navigation/scroll_past_end_of_file", false, true);
  573. _initial_set("text_editor/behavior/navigation/smooth_scrolling", true, true);
  574. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/behavior/navigation/v_scroll_speed", 80, "1,10000,1")
  575. _initial_set("text_editor/behavior/navigation/drag_and_drop_selection", true, true);
  576. _initial_set("text_editor/behavior/navigation/stay_in_script_editor_on_node_selected", true, true);
  577. _initial_set("text_editor/behavior/navigation/open_script_when_connecting_signal_to_existing_method", true, true);
  578. _initial_set("text_editor/behavior/navigation/use_default_word_separators", true); // Includes ´`~$^=+|<> General punctuation and CJK punctuation.
  579. _initial_set("text_editor/behavior/navigation/use_custom_word_separators", false);
  580. _initial_set("text_editor/behavior/navigation/custom_word_separators", ""); // Custom word separators.
  581. // Behavior: Indent
  582. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/behavior/indent/type", 0, "Tabs,Spaces")
  583. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/behavior/indent/size", 4, "1,64,1") // size of 0 crashes.
  584. _initial_set("text_editor/behavior/indent/auto_indent", true);
  585. _initial_set("text_editor/behavior/indent/indent_wrapped_lines", true);
  586. // Behavior: Files
  587. _initial_set("text_editor/behavior/files/trim_trailing_whitespace_on_save", false);
  588. _initial_set("text_editor/behavior/files/trim_final_newlines_on_save", true);
  589. _initial_set("text_editor/behavior/files/autosave_interval_secs", 0);
  590. _initial_set("text_editor/behavior/files/restore_scripts_on_load", true);
  591. _initial_set("text_editor/behavior/files/convert_indent_on_save", true);
  592. _initial_set("text_editor/behavior/files/auto_reload_scripts_on_external_change", false);
  593. _initial_set("text_editor/behavior/files/auto_reload_and_parse_scripts_on_save", true);
  594. _initial_set("text_editor/behavior/files/open_dominant_script_on_scene_change", false, true);
  595. _initial_set("text_editor/behavior/files/drop_preload_resources_as_uid", true, true);
  596. // Behavior: Documentation
  597. _initial_set("text_editor/behavior/documentation/enable_tooltips", true, true);
  598. // Script list
  599. _initial_set("text_editor/script_list/show_members_overview", true, true);
  600. _initial_set("text_editor/script_list/sort_members_outline_alphabetically", false, true);
  601. _initial_set("text_editor/script_list/script_temperature_enabled", true);
  602. _initial_set("text_editor/script_list/script_temperature_history_size", 15);
  603. _initial_set("text_editor/script_list/highlight_scene_scripts", true);
  604. _initial_set("text_editor/script_list/group_help_pages", true);
  605. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/script_list/sort_scripts_by", 0, "Name,Path,None");
  606. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/script_list/list_script_names_as", 0, "Name,Parent Directory And Name,Full Path");
  607. EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "text_editor/external/exec_path", "", "");
  608. EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_PLACEHOLDER_TEXT, "text_editor/external/exec_flags", "{file}", "Call flags with placeholders: {project}, {file}, {col}, {line}.");
  609. // Completion
  610. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "text_editor/completion/idle_parse_delay", 1.5, "0.1,10,0.01")
  611. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "text_editor/completion/idle_parse_delay_with_errors_found", 0.5, "0.1,5,0.01")
  612. _initial_set("text_editor/completion/auto_brace_complete", true, true);
  613. _initial_set("text_editor/completion/code_complete_enabled", true, true);
  614. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "text_editor/completion/code_complete_delay", 0.3, "0.01,5,0.01,or_greater")
  615. _initial_set("text_editor/completion/put_callhint_tooltip_below_current_line", true);
  616. _initial_set("text_editor/completion/complete_file_paths", true);
  617. _initial_set("text_editor/completion/add_type_hints", true, true);
  618. _initial_set("text_editor/completion/add_string_name_literals", false, true);
  619. _initial_set("text_editor/completion/add_node_path_literals", false, true);
  620. _initial_set("text_editor/completion/use_single_quotes", false, true);
  621. _initial_set("text_editor/completion/colorize_suggestions", true);
  622. // External editor (ScriptEditorPlugin)
  623. _initial_set("text_editor/external/use_external_editor", false, true);
  624. _initial_set("text_editor/external/exec_path", "");
  625. // Help
  626. _initial_set("text_editor/help/show_help_index", true);
  627. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/help/help_font_size", 16, "8,48,1")
  628. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/help/help_source_font_size", 15, "8,48,1")
  629. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/help/help_title_font_size", 23, "8,64,1")
  630. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/help/class_reference_examples", 0, "GDScript,C#,GDScript and C#")
  631. _initial_set("text_editor/help/sort_functions_alphabetically", true);
  632. /* Editors */
  633. // GridMap
  634. // GridMapEditor
  635. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/grid_map/pick_distance", 5000.0, "1,8192,0.1,or_greater");
  636. EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "editors/grid_map/palette_min_width", 230, "100,500,1", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED);
  637. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "editors/grid_map/preview_size", 64, "16,128,1")
  638. // 3D
  639. EDITOR_SETTING_BASIC(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d/primary_grid_color", Color(0.56, 0.56, 0.56, 0.5), "")
  640. EDITOR_SETTING_BASIC(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d/secondary_grid_color", Color(0.38, 0.38, 0.38, 0.5), "")
  641. // Use a similar color to the 2D editor selection.
  642. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d/selection_box_color", Color(1.0, 0.5, 0), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  643. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/instantiated", Color(0.7, 0.7, 0.7, 0.6), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  644. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/joint", Color(0.5, 0.8, 1), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  645. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/aabb", Color(0.28, 0.8, 0.82), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  646. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/stream_player_3d", Color(0.4, 0.8, 1), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  647. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/camera", Color(0.8, 0.4, 0.8), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  648. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/decal", Color(0.6, 0.5, 1.0), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  649. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/fog_volume", Color(0.5, 0.7, 1), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  650. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/particles", Color(0.8, 0.7, 0.4), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  651. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/particle_attractor", Color(1, 0.7, 0.5), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  652. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/particle_collision", Color(0.5, 0.7, 1), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  653. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/joint_body_a", Color(0.6, 0.8, 1), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  654. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/joint_body_b", Color(0.6, 0.9, 1), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  655. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/lightmap_lines", Color(0.5, 0.6, 1), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  656. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/lightprobe_lines", Color(0.5, 0.6, 1), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  657. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/occluder", Color(0.8, 0.5, 1), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  658. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/reflection_probe", Color(0.6, 1, 0.5), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  659. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/visibility_notifier", Color(0.8, 0.5, 0.7), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  660. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/voxel_gi", Color(0.5, 1, 0.6), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  661. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/path_tilt", Color(1.0, 1.0, 0.4, 0.9), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  662. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/skeleton", Color(1, 0.8, 0.4), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  663. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/selected_bone", Color(0.8, 0.3, 0.0), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  664. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/csg", Color(0.0, 0.4, 1, 0.15), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  665. EDITOR_SETTING(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/gridmap_grid", Color(0.8, 0.5, 0.1), "")
  666. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/spring_bone_joint", Color(0.8, 0.9, 0.6), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  667. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/spring_bone_collision", Color(0.6, 0.8, 0.9), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  668. EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/spring_bone_inside_collision", Color(0.9, 0.6, 0.8), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  669. _initial_set("editors/3d_gizmos/gizmo_settings/bone_axis_length", (float)0.1);
  670. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d_gizmos/gizmo_settings/bone_shape", 1, "Wire,Octahedron");
  671. EDITOR_SETTING_USAGE(Variant::FLOAT, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size", 0.8, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  672. // If a line is a multiple of this, it uses the primary grid color.
  673. // Use a power of 2 value by default as it's more common to use powers of 2 in level design.
  674. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/primary_grid_steps", 8, "1,100,1")
  675. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/grid_size", 200, "1,2000,1")
  676. // Higher values produce graphical artifacts when far away unless View Z-Far
  677. // is increased significantly more than it really should need to be.
  678. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/grid_division_level_max", 2, "-1,3,1")
  679. // Lower values produce graphical artifacts regardless of view clipping planes, so limit to -2 as a lower bound.
  680. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/grid_division_level_min", 0, "-2,2,1")
  681. // -0.2 seems like a sensible default. -1.0 gives Blender-like behavior, 0.5 gives huge grids.
  682. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/grid_division_level_bias", -0.2, "-1.0,0.5,0.1")
  683. _initial_set("editors/3d/grid_xz_plane", true);
  684. _initial_set("editors/3d/grid_xy_plane", false);
  685. _initial_set("editors/3d/grid_yz_plane", false);
  686. // Use a lower default FOV for the 3D camera compared to the
  687. // Camera3D node as the 3D viewport doesn't span the whole screen.
  688. // This means it's technically viewed from a further distance, which warrants a narrower FOV.
  689. EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/default_fov", 70.0, "1,179,0.1,degrees")
  690. EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/default_z_near", 0.05, "0.01,10,0.01,or_greater,suffix:m")
  691. EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/default_z_far", 4000.0, "0.1,4000,0.1,or_greater,suffix:m")
  692. // 3D: Navigation
  693. _initial_set("editors/3d/navigation/invert_x_axis", false, true);
  694. _initial_set("editors/3d/navigation/invert_y_axis", false, true);
  695. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d/navigation/navigation_scheme", 0, "Godot:0,Maya:1,Modo:2,Tablet/Trackpad:4,Custom:3")
  696. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d/navigation/orbit_mouse_button", 1, "Left Mouse,Middle Mouse,Right Mouse,Mouse Button 4,Mouse Button 5")
  697. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d/navigation/pan_mouse_button", 1, "Left Mouse,Middle Mouse,Right Mouse,Mouse Button 4,Mouse Button 5")
  698. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d/navigation/zoom_mouse_button", 1, "Left Mouse,Middle Mouse,Right Mouse,Mouse Button 4,Mouse Button 5")
  699. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d/navigation/zoom_style", 0, "Vertical,Horizontal")
  700. _initial_set("editors/3d/navigation/emulate_numpad", true, true);
  701. _initial_set("editors/3d/navigation/emulate_3_button_mouse", false, true);
  702. _initial_set("editors/3d/navigation/warped_mouse_panning", true, true);
  703. // 3D: Navigation feel
  704. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/orbit_sensitivity", 0.25, "0.01,20,0.001")
  705. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/translation_sensitivity", 1.0, "0.01,20,0.001")
  706. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/orbit_inertia", 0.0, "0,1,0.001")
  707. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/translation_inertia", 0.05, "0,1,0.001")
  708. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/zoom_inertia", 0.05, "0,1,0.001")
  709. _initial_set("editors/3d/navigation/show_viewport_rotation_gizmo", true);
  710. _initial_set("editors/3d/navigation/show_viewport_navigation_gizmo", DisplayServer::get_singleton()->is_touchscreen_available());
  711. // 3D: Freelook
  712. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d/freelook/freelook_navigation_scheme", 0, "Default,Partially Axis-Locked (id Tech),Fully Axis-Locked (Minecraft)")
  713. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/freelook/freelook_sensitivity", 0.25, "0.01,2,0.001")
  714. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/freelook/freelook_inertia", 0.0, "0,1,0.001")
  715. EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/freelook/freelook_base_speed", 5.0, "0,10,0.01")
  716. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d/freelook/freelook_activation_modifier", 0, "None,Shift,Alt,Meta,Ctrl")
  717. _initial_set("editors/3d/freelook/freelook_speed_zoom_link", false);
  718. // 3D: Manipulator
  719. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/manipulator_gizmo_size", 80, "16,160,1");
  720. EDITOR_SETTING_USAGE(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/manipulator_gizmo_opacity", 0.9, "0,1,0.01", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
  721. // 2D
  722. _initial_set("editors/2d/grid_color", Color(1.0, 1.0, 1.0, 0.07), true);
  723. _initial_set("editors/2d/guides_color", Color(0.6, 0.0, 0.8), true);
  724. _initial_set("editors/2d/smart_snapping_line_color", Color(0.9, 0.1, 0.1), true);
  725. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/2d/bone_width", 5.0, "0.01,20,0.01,or_greater")
  726. _initial_set("editors/2d/bone_color1", Color(1.0, 1.0, 1.0, 0.7));
  727. _initial_set("editors/2d/bone_color2", Color(0.6, 0.6, 0.6, 0.7));
  728. _initial_set("editors/2d/bone_selected_color", Color(0.9, 0.45, 0.45, 0.7));
  729. _initial_set("editors/2d/bone_ik_color", Color(0.9, 0.9, 0.45, 0.7));
  730. _initial_set("editors/2d/bone_outline_color", Color(0.35, 0.35, 0.35, 0.5));
  731. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/2d/bone_outline_size", 2.0, "0.01,8,0.01,or_greater")
  732. _initial_set("editors/2d/viewport_border_color", Color(0.4, 0.4, 1.0, 0.4), true);
  733. _initial_set("editors/2d/use_integer_zoom_by_default", false, true);
  734. EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/2d/zoom_speed_factor", 1.1, "1.01,2,0.01")
  735. // Bone mapper (BoneMapEditorPlugin)
  736. _initial_set("editors/bone_mapper/handle_colors/unset", Color(0.3, 0.3, 0.3));
  737. _initial_set("editors/bone_mapper/handle_colors/set", Color(0.1, 0.6, 0.25));
  738. _initial_set("editors/bone_mapper/handle_colors/missing", Color(0.8, 0.2, 0.8));
  739. _initial_set("editors/bone_mapper/handle_colors/error", Color(0.8, 0.2, 0.2));
  740. // Panning
  741. // Enum should be in sync with ControlScheme in ViewPanner.
  742. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/panning/2d_editor_panning_scheme", 0, "Scroll Zooms,Scroll Pans");
  743. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/panning/sub_editors_panning_scheme", 0, "Scroll Zooms,Scroll Pans");
  744. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/panning/animation_editors_panning_scheme", 1, "Scroll Zooms,Scroll Pans");
  745. _initial_set("editors/panning/simple_panning", false);
  746. _initial_set("editors/panning/warped_mouse_panning", true);
  747. _initial_set("editors/panning/2d_editor_pan_speed", 20, true);
  748. // Tiles editor
  749. _initial_set("editors/tiles_editor/display_grid", true);
  750. _initial_set("editors/tiles_editor/highlight_selected_layer", true);
  751. _initial_set("editors/tiles_editor/grid_color", Color(1.0, 0.5, 0.2, 0.5));
  752. // Polygon editor
  753. _initial_set("editors/polygon_editor/point_grab_radius", has_touchscreen_ui ? 32 : 8);
  754. _initial_set("editors/polygon_editor/show_previous_outline", true);
  755. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/polygon_editor/auto_bake_delay", 1.5, "-1.0,10.0,0.01");
  756. // Animation
  757. _initial_set("editors/animation/autorename_animation_tracks", true);
  758. _initial_set("editors/animation/confirm_insert_track", true, true);
  759. _initial_set("editors/animation/default_create_bezier_tracks", false, true);
  760. _initial_set("editors/animation/default_create_reset_tracks", true, true);
  761. _initial_set("editors/animation/onion_layers_past_color", Color(1, 0, 0));
  762. _initial_set("editors/animation/onion_layers_future_color", Color(0, 1, 0));
  763. // Shader editor
  764. _initial_set("editors/shader_editor/behavior/files/restore_shaders_on_load", true, true);
  765. // Visual editors
  766. EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_ENUM, "editors/visual_editors/color_theme", "Default", "Default,Legacy,Custom")
  767. _load_default_visual_shader_editor_theme();
  768. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/visual_editors/minimap_opacity", 0.85, "0.0,1.0,0.01")
  769. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/visual_editors/lines_curvature", 0.5, "0.0,1.0,0.01")
  770. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "editors/visual_editors/grid_pattern", 1, "Lines,Dots")
  771. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "editors/visual_editors/visual_shader/port_preview_size", 160, "100,400,0.01")
  772. // Export (EditorExportPlugin)
  773. _initial_set("export/ssh/ssh", "");
  774. _initial_set("export/ssh/scp", "");
  775. /* Run */
  776. // Window placement
  777. #ifndef ANDROID_ENABLED
  778. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/window_placement/rect", 1, "Top Left,Centered,Custom Position,Force Maximized,Force Fullscreen")
  779. // Keep the enum values in sync with the `DisplayServer::SCREEN_` enum.
  780. String screen_hints = "Same as Editor:-5,Previous Screen:-4,Next Screen:-3,Primary Screen:-2"; // Note: Main Window Screen:-1 is not used for the main window.
  781. for (int i = 0; i < DisplayServer::get_singleton()->get_screen_count(); i++) {
  782. screen_hints += ",Screen " + itos(i + 1) + ":" + itos(i);
  783. }
  784. _initial_set("run/window_placement/rect_custom_position", Vector2());
  785. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/window_placement/screen", -5, screen_hints)
  786. #endif
  787. // Should match the ANDROID_WINDOW_* constants in 'platform/android/java/editor/src/main/java/org/godotengine/editor/BaseGodotEditor.kt'.
  788. String android_window_hints = "Auto (based on screen size):0,Same as Editor:1,Side-by-side with Editor:2";
  789. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/window_placement/android_window", 0, android_window_hints)
  790. String game_embed_mode_hints = "Disabled:-1,Use Per-Project Configuration:0,Embed Game:1,Make Game Workspace Floating:2";
  791. #ifdef ANDROID_ENABLED
  792. if (OS::get_singleton()->has_feature("xr_editor")) {
  793. game_embed_mode_hints = "Disabled:-1";
  794. } else {
  795. game_embed_mode_hints = "Disabled:-1,Auto (based on screen size):0,Enabled:1";
  796. }
  797. #endif
  798. int default_game_embed_mode = OS::get_singleton()->has_feature("xr_editor") ? -1 : 0;
  799. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/window_placement/game_embed_mode", default_game_embed_mode, game_embed_mode_hints);
  800. // Auto save
  801. _initial_set("run/auto_save/save_before_running", true, true);
  802. // Bottom panel
  803. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/bottom_panel/action_on_play", EditorNode::ACTION_ON_PLAY_OPEN_OUTPUT, "Do Nothing,Open Output,Open Debugger")
  804. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/bottom_panel/action_on_stop", EditorNode::ACTION_ON_STOP_DO_NOTHING, "Do Nothing,Close Bottom Panel")
  805. // Output
  806. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "run/output/font_size", 13, "8,48,1")
  807. _initial_set("run/output/always_clear_output_on_play", true, true);
  808. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "run/output/max_lines", 10000, "100,100000,1")
  809. // Platform
  810. _initial_set("run/platforms/linuxbsd/prefer_wayland", false, true);
  811. set_restart_if_changed("run/platforms/linuxbsd/prefer_wayland", true);
  812. /* Network */
  813. // General
  814. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "network/connection/network_mode", 0, "Offline,Online");
  815. // HTTP Proxy
  816. _initial_set("network/http_proxy/host", "");
  817. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "network/http_proxy/port", 8080, "1,65535,1")
  818. // SSL
  819. EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "network/tls/editor_tls_certificates", _SYSTEM_CERTS_PATH, "*.crt,*.pem", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED);
  820. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "network/tls/enable_tls_v1.3", true, "")
  821. // Debug
  822. _initial_set("network/debug/remote_host", "127.0.0.1"); // Hints provided in setup_network
  823. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "network/debug/remote_port", 6007, "1,65535,1")
  824. /* Debugger/profiler */
  825. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "debugger/auto_switch_to_remote_scene_tree", false, "")
  826. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "debugger/auto_switch_to_stack_trace", true, "")
  827. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "debugger/profiler_frame_history_size", 3600, "60,10000,1")
  828. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "debugger/profiler_frame_max_functions", 64, "16,512,1")
  829. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "debugger/profiler_target_fps", 60, "1,1000,1")
  830. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "debugger/remote_scene_tree_refresh_interval", 1.0, "0.1,10,0.01,or_greater")
  831. EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "debugger/remote_inspect_refresh_interval", 0.2, "0.02,10,0.01,or_greater")
  832. EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "debugger/profile_native_calls", false, "")
  833. // Version control (VersionControlEditorPlugin)
  834. _initial_set("version_control/username", "", true);
  835. _initial_set("version_control/ssh_public_key_path", "");
  836. _initial_set("version_control/ssh_private_key_path", "");
  837. /* Extra config */
  838. EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "input/buffering/agile_event_flushing", false, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING)
  839. EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "input/buffering/use_accumulated_input", true, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING)
  840. // TRANSLATORS: Project Manager here refers to the tool used to create/manage Godot projects.
  841. EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "project_manager/sorting_order", 0, "Last Edited,Name,Path")
  842. EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "project_manager/directory_naming_convention", 1, "No convention,kebab-case,snake_case,camelCase,PascalCase,Title Case")
  843. #if defined(WEB_ENABLED)
  844. // Web platform only supports `gl_compatibility`.
  845. const String default_renderer = "gl_compatibility";
  846. #elif defined(ANDROID_ENABLED)
  847. // Use more suitable rendering method by default.
  848. const String default_renderer = "mobile";
  849. #else
  850. const String default_renderer = "forward_plus";
  851. #endif
  852. EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_ENUM, "project_manager/default_renderer", default_renderer, "forward_plus,mobile,gl_compatibility")
  853. #undef EDITOR_SETTING
  854. #undef EDITOR_SETTING_BASIC
  855. #undef EDITOR_SETTING_USAGE
  856. if (p_extra_config.is_valid()) {
  857. if (p_extra_config->has_section("init_projects") && p_extra_config->has_section_key("init_projects", "list")) {
  858. Vector<String> list = p_extra_config->get_value("init_projects", "list");
  859. for (int i = 0; i < list.size(); i++) {
  860. String proj_name = list[i].replace("/", "::");
  861. set("projects/" + proj_name, list[i]);
  862. }
  863. }
  864. if (p_extra_config->has_section("presets")) {
  865. List<String> keys;
  866. p_extra_config->get_section_keys("presets", &keys);
  867. for (const String &key : keys) {
  868. Variant val = p_extra_config->get_value("presets", key);
  869. set(key, val);
  870. }
  871. }
  872. }
  873. }
  874. void EditorSettings::_load_godot2_text_editor_theme() {
  875. // Godot 2 is only a dark theme; it doesn't have a light theme counterpart.
  876. _initial_set("text_editor/theme/highlighting/symbol_color", Color(0.73, 0.87, 1.0), true);
  877. _initial_set("text_editor/theme/highlighting/keyword_color", Color(1.0, 1.0, 0.7), true);
  878. _initial_set("text_editor/theme/highlighting/control_flow_keyword_color", Color(1.0, 0.85, 0.7), true);
  879. _initial_set("text_editor/theme/highlighting/base_type_color", Color(0.64, 1.0, 0.83), true);
  880. _initial_set("text_editor/theme/highlighting/engine_type_color", Color(0.51, 0.83, 1.0), true);
  881. _initial_set("text_editor/theme/highlighting/user_type_color", Color(0.42, 0.67, 0.93), true);
  882. _initial_set("text_editor/theme/highlighting/comment_color", Color(0.4, 0.4, 0.4), true);
  883. _initial_set("text_editor/theme/highlighting/doc_comment_color", Color(0.5, 0.6, 0.7), true);
  884. _initial_set("text_editor/theme/highlighting/string_color", Color(0.94, 0.43, 0.75), true);
  885. _initial_set("text_editor/theme/highlighting/background_color", Color(0.13, 0.12, 0.15), true);
  886. _initial_set("text_editor/theme/highlighting/completion_background_color", Color(0.17, 0.16, 0.2));
  887. _initial_set("text_editor/theme/highlighting/completion_selected_color", Color(0.26, 0.26, 0.27));
  888. _initial_set("text_editor/theme/highlighting/completion_existing_color", Color(0.87, 0.87, 0.87, 0.13));
  889. _initial_set("text_editor/theme/highlighting/completion_scroll_color", Color(1, 1, 1, 0.29));
  890. _initial_set("text_editor/theme/highlighting/completion_scroll_hovered_color", Color(1, 1, 1, 0.4));
  891. _initial_set("text_editor/theme/highlighting/completion_font_color", Color(0.67, 0.67, 0.67));
  892. _initial_set("text_editor/theme/highlighting/text_color", Color(0.67, 0.67, 0.67), true);
  893. _initial_set("text_editor/theme/highlighting/line_number_color", Color(0.67, 0.67, 0.67, 0.4), true);
  894. _initial_set("text_editor/theme/highlighting/safe_line_number_color", Color(0.67, 0.78, 0.67, 0.6), true);
  895. _initial_set("text_editor/theme/highlighting/caret_color", Color(0.67, 0.67, 0.67), true);
  896. _initial_set("text_editor/theme/highlighting/caret_background_color", Color(0, 0, 0), true);
  897. _initial_set("text_editor/theme/highlighting/text_selected_color", Color(0, 0, 0, 0), true);
  898. _initial_set("text_editor/theme/highlighting/selection_color", Color(0.41, 0.61, 0.91, 0.35), true);
  899. _initial_set("text_editor/theme/highlighting/brace_mismatch_color", Color(1, 0.2, 0.2), true);
  900. _initial_set("text_editor/theme/highlighting/current_line_color", Color(0.3, 0.5, 0.8, 0.15), true);
  901. _initial_set("text_editor/theme/highlighting/line_length_guideline_color", Color(0.3, 0.5, 0.8, 0.1), true);
  902. _initial_set("text_editor/theme/highlighting/word_highlighted_color", Color(0.8, 0.9, 0.9, 0.15), true);
  903. _initial_set("text_editor/theme/highlighting/number_color", Color(0.92, 0.58, 0.2), true);
  904. _initial_set("text_editor/theme/highlighting/function_color", Color(0.4, 0.64, 0.81), true);
  905. _initial_set("text_editor/theme/highlighting/member_variable_color", Color(0.9, 0.31, 0.35), true);
  906. _initial_set("text_editor/theme/highlighting/mark_color", Color(1.0, 0.4, 0.4, 0.4), true);
  907. _initial_set("text_editor/theme/highlighting/bookmark_color", Color(0.08, 0.49, 0.98));
  908. _initial_set("text_editor/theme/highlighting/breakpoint_color", Color(0.9, 0.29, 0.3));
  909. _initial_set("text_editor/theme/highlighting/executing_line_color", Color(0.98, 0.89, 0.27));
  910. _initial_set("text_editor/theme/highlighting/code_folding_color", Color(0.8, 0.8, 0.8, 0.8));
  911. _initial_set("text_editor/theme/highlighting/folded_code_region_color", Color(0.68, 0.46, 0.77, 0.2));
  912. _initial_set("text_editor/theme/highlighting/search_result_color", Color(0.05, 0.25, 0.05, 1));
  913. _initial_set("text_editor/theme/highlighting/search_result_border_color", Color(0.41, 0.61, 0.91, 0.38));
  914. }
  915. void EditorSettings::_load_default_visual_shader_editor_theme() {
  916. // Connection type colors
  917. _initial_set("editors/visual_editors/connection_colors/scalar_color", Color(0.55, 0.55, 0.55));
  918. _initial_set("editors/visual_editors/connection_colors/vector2_color", Color(0.44, 0.43, 0.64));
  919. _initial_set("editors/visual_editors/connection_colors/vector3_color", Color(0.337, 0.314, 0.71));
  920. _initial_set("editors/visual_editors/connection_colors/vector4_color", Color(0.7, 0.65, 0.147));
  921. _initial_set("editors/visual_editors/connection_colors/boolean_color", Color(0.243, 0.612, 0.349));
  922. _initial_set("editors/visual_editors/connection_colors/transform_color", Color(0.71, 0.357, 0.64));
  923. _initial_set("editors/visual_editors/connection_colors/sampler_color", Color(0.659, 0.4, 0.137));
  924. // Node category colors (used for the node headers)
  925. _initial_set("editors/visual_editors/category_colors/output_color", Color(0.26, 0.10, 0.15));
  926. _initial_set("editors/visual_editors/category_colors/color_color", Color(0.5, 0.5, 0.1));
  927. _initial_set("editors/visual_editors/category_colors/conditional_color", Color(0.208, 0.522, 0.298));
  928. _initial_set("editors/visual_editors/category_colors/input_color", Color(0.502, 0.2, 0.204));
  929. _initial_set("editors/visual_editors/category_colors/scalar_color", Color(0.1, 0.5, 0.6));
  930. _initial_set("editors/visual_editors/category_colors/textures_color", Color(0.5, 0.3, 0.1));
  931. _initial_set("editors/visual_editors/category_colors/transform_color", Color(0.5, 0.3, 0.5));
  932. _initial_set("editors/visual_editors/category_colors/utility_color", Color(0.2, 0.2, 0.2));
  933. _initial_set("editors/visual_editors/category_colors/vector_color", Color(0.2, 0.2, 0.5));
  934. _initial_set("editors/visual_editors/category_colors/special_color", Color(0.098, 0.361, 0.294));
  935. _initial_set("editors/visual_editors/category_colors/particle_color", Color(0.12, 0.358, 0.8));
  936. }
  937. bool EditorSettings::_save_text_editor_theme(const String &p_file) {
  938. String theme_section = "color_theme";
  939. Ref<ConfigFile> cf = memnew(ConfigFile); // hex is better?
  940. List<String> keys;
  941. for (const KeyValue<String, VariantContainer> &E : props) {
  942. keys.push_back(E.key);
  943. }
  944. keys.sort();
  945. for (const String &key : keys) {
  946. if (key.begins_with("text_editor/theme/highlighting/") && key.contains("color")) {
  947. cf->set_value(theme_section, key.replace("text_editor/theme/highlighting/", ""), ((Color)props[key].variant).to_html());
  948. }
  949. }
  950. Error err = cf->save(p_file);
  951. return err == OK;
  952. }
  953. bool EditorSettings::_is_default_text_editor_theme(const String &p_theme_name) {
  954. return p_theme_name == "default" || p_theme_name == "godot 2" || p_theme_name == "custom";
  955. }
  956. const String EditorSettings::_get_project_metadata_path() const {
  957. return EditorPaths::get_singleton()->get_project_settings_dir().path_join("project_metadata.cfg");
  958. }
  959. #ifndef DISABLE_DEPRECATED
  960. void EditorSettings::_remove_deprecated_settings() {
  961. erase("run/output/always_open_output_on_play");
  962. erase("run/output/always_close_output_on_stop");
  963. }
  964. #endif
  965. // PUBLIC METHODS
  966. EditorSettings *EditorSettings::get_singleton() {
  967. return singleton.ptr();
  968. }
  969. String EditorSettings::get_existing_settings_path() {
  970. const String config_dir = EditorPaths::get_singleton()->get_config_dir();
  971. int minor = VERSION_MINOR;
  972. String filename;
  973. do {
  974. if (VERSION_MAJOR == 4 && minor < 3) {
  975. // Minor version is used since 4.3, so special case to load older settings.
  976. filename = vformat("editor_settings-%d.tres", VERSION_MAJOR);
  977. minor = -1;
  978. } else {
  979. filename = vformat("editor_settings-%d.%d.tres", VERSION_MAJOR, minor);
  980. minor--;
  981. }
  982. } while (minor >= 0 && !FileAccess::exists(config_dir.path_join(filename)));
  983. return config_dir.path_join(filename);
  984. }
  985. String EditorSettings::get_newest_settings_path() {
  986. const String config_file_name = vformat("editor_settings-%d.%d.tres", VERSION_MAJOR, VERSION_MINOR);
  987. return EditorPaths::get_singleton()->get_config_dir().path_join(config_file_name);
  988. }
  989. void EditorSettings::create() {
  990. // IMPORTANT: create() *must* create a valid EditorSettings singleton,
  991. // as the rest of the engine code will assume it. As such, it should never
  992. // return (incl. via ERR_FAIL) without initializing the singleton member.
  993. if (singleton.ptr()) {
  994. ERR_PRINT("Can't recreate EditorSettings as it already exists.");
  995. return;
  996. }
  997. String config_file_path;
  998. Ref<ConfigFile> extra_config = memnew(ConfigFile);
  999. if (!EditorPaths::get_singleton()) {
  1000. ERR_PRINT("Bug (please report): EditorPaths haven't been initialized, EditorSettings cannot be created properly.");
  1001. goto fail;
  1002. }
  1003. if (EditorPaths::get_singleton()->is_self_contained()) {
  1004. Error err = extra_config->load(EditorPaths::get_singleton()->get_self_contained_file());
  1005. if (err != OK) {
  1006. ERR_PRINT("Can't load extra config from path: " + EditorPaths::get_singleton()->get_self_contained_file());
  1007. }
  1008. }
  1009. if (EditorPaths::get_singleton()->are_paths_valid()) {
  1010. // Validate editor config file.
  1011. ERR_FAIL_COND(!DirAccess::dir_exists_absolute(EditorPaths::get_singleton()->get_config_dir()));
  1012. config_file_path = get_existing_settings_path();
  1013. if (!FileAccess::exists(config_file_path)) {
  1014. config_file_path = get_newest_settings_path();
  1015. goto fail;
  1016. }
  1017. singleton = ResourceLoader::load(config_file_path, "EditorSettings");
  1018. if (singleton.is_null()) {
  1019. ERR_PRINT("Could not load editor settings from path: " + config_file_path);
  1020. config_file_path = get_newest_settings_path();
  1021. goto fail;
  1022. }
  1023. singleton->set_path(get_newest_settings_path()); // Settings can be loaded from older version file, so make sure it's newest.
  1024. singleton->save_changed_setting = true;
  1025. print_verbose("EditorSettings: Load OK!");
  1026. singleton->setup_language();
  1027. singleton->setup_network();
  1028. singleton->load_favorites_and_recent_dirs();
  1029. singleton->list_text_editor_themes();
  1030. #ifndef DISABLE_DEPRECATED
  1031. singleton->_remove_deprecated_settings();
  1032. #endif
  1033. return;
  1034. }
  1035. fail:
  1036. // patch init projects
  1037. String exe_path = OS::get_singleton()->get_executable_path().get_base_dir();
  1038. if (extra_config->has_section("init_projects")) {
  1039. Vector<String> list = extra_config->get_value("init_projects", "list");
  1040. for (int i = 0; i < list.size(); i++) {
  1041. list.write[i] = exe_path.path_join(list[i]);
  1042. }
  1043. extra_config->set_value("init_projects", "list", list);
  1044. }
  1045. singleton.instantiate();
  1046. singleton->set_path(config_file_path, true);
  1047. singleton->save_changed_setting = true;
  1048. singleton->_load_defaults(extra_config);
  1049. singleton->setup_language();
  1050. singleton->setup_network();
  1051. singleton->list_text_editor_themes();
  1052. }
  1053. void EditorSettings::setup_language() {
  1054. String lang = get("interface/editor/editor_language");
  1055. TranslationServer::get_singleton()->set_locale(lang);
  1056. if (lang == "en") {
  1057. return; // Default, nothing to do.
  1058. }
  1059. // Load editor translation for configured/detected locale.
  1060. load_editor_translations(lang);
  1061. load_property_translations(lang);
  1062. // Load class reference translation.
  1063. load_doc_translations(lang);
  1064. // Load extractable translation for projects.
  1065. load_extractable_translations(lang);
  1066. }
  1067. void EditorSettings::setup_network() {
  1068. List<IPAddress> local_ip;
  1069. IP::get_singleton()->get_local_addresses(&local_ip);
  1070. String hint;
  1071. String current = has_setting("network/debug/remote_host") ? get("network/debug/remote_host") : "";
  1072. String selected = "127.0.0.1";
  1073. // Check that current remote_host is a valid interface address and populate hints.
  1074. for (const IPAddress &ip : local_ip) {
  1075. // link-local IPv6 addresses don't work, skipping them
  1076. if (String(ip).begins_with("fe80:0:0:0:")) { // fe80::/64
  1077. continue;
  1078. }
  1079. // Same goes for IPv4 link-local (APIPA) addresses.
  1080. if (String(ip).begins_with("169.254.")) { // 169.254.0.0/16
  1081. continue;
  1082. }
  1083. // Select current IP (found)
  1084. if (ip == current) {
  1085. selected = ip;
  1086. }
  1087. if (!hint.is_empty()) {
  1088. hint += ",";
  1089. }
  1090. hint += ip;
  1091. }
  1092. // Add hints with valid IP addresses to remote_host property.
  1093. add_property_hint(PropertyInfo(Variant::STRING, "network/debug/remote_host", PROPERTY_HINT_ENUM, hint));
  1094. // Fix potentially invalid remote_host due to network change.
  1095. set("network/debug/remote_host", selected);
  1096. }
  1097. void EditorSettings::save() {
  1098. //_THREAD_SAFE_METHOD_
  1099. if (!singleton.ptr()) {
  1100. return;
  1101. }
  1102. Error err = ResourceSaver::save(singleton);
  1103. if (err != OK) {
  1104. ERR_PRINT("Error saving editor settings to " + singleton->get_path());
  1105. } else {
  1106. singleton->changed_settings.clear();
  1107. print_verbose("EditorSettings: Save OK!");
  1108. }
  1109. }
  1110. PackedStringArray EditorSettings::get_changed_settings() const {
  1111. PackedStringArray arr;
  1112. for (const String &setting : changed_settings) {
  1113. arr.push_back(setting);
  1114. }
  1115. return arr;
  1116. }
  1117. bool EditorSettings::check_changed_settings_in_group(const String &p_setting_prefix) const {
  1118. for (const String &setting : changed_settings) {
  1119. if (setting.begins_with(p_setting_prefix)) {
  1120. return true;
  1121. }
  1122. }
  1123. return false;
  1124. }
  1125. void EditorSettings::mark_setting_changed(const String &p_setting) {
  1126. changed_settings.insert(p_setting);
  1127. }
  1128. void EditorSettings::destroy() {
  1129. if (!singleton.ptr()) {
  1130. return;
  1131. }
  1132. save();
  1133. singleton = Ref<EditorSettings>();
  1134. }
  1135. void EditorSettings::set_optimize_save(bool p_optimize) {
  1136. optimize_save = p_optimize;
  1137. }
  1138. // Properties
  1139. void EditorSettings::set_setting(const String &p_setting, const Variant &p_value) {
  1140. _THREAD_SAFE_METHOD_
  1141. set(p_setting, p_value);
  1142. }
  1143. Variant EditorSettings::get_setting(const String &p_setting) const {
  1144. _THREAD_SAFE_METHOD_
  1145. return get(p_setting);
  1146. }
  1147. bool EditorSettings::has_setting(const String &p_setting) const {
  1148. _THREAD_SAFE_METHOD_
  1149. return props.has(p_setting);
  1150. }
  1151. void EditorSettings::erase(const String &p_setting) {
  1152. _THREAD_SAFE_METHOD_
  1153. props.erase(p_setting);
  1154. }
  1155. void EditorSettings::raise_order(const String &p_setting) {
  1156. _THREAD_SAFE_METHOD_
  1157. ERR_FAIL_COND(!props.has(p_setting));
  1158. props[p_setting].order = ++last_order;
  1159. }
  1160. void EditorSettings::set_restart_if_changed(const StringName &p_setting, bool p_restart) {
  1161. _THREAD_SAFE_METHOD_
  1162. if (!props.has(p_setting)) {
  1163. return;
  1164. }
  1165. props[p_setting].restart_if_changed = p_restart;
  1166. }
  1167. void EditorSettings::set_basic(const StringName &p_setting, bool p_basic) {
  1168. _THREAD_SAFE_METHOD_
  1169. if (!props.has(p_setting)) {
  1170. return;
  1171. }
  1172. props[p_setting].basic = p_basic;
  1173. }
  1174. void EditorSettings::set_initial_value(const StringName &p_setting, const Variant &p_value, bool p_update_current) {
  1175. _THREAD_SAFE_METHOD_
  1176. if (!props.has(p_setting)) {
  1177. return;
  1178. }
  1179. props[p_setting].initial = p_value;
  1180. props[p_setting].has_default_value = true;
  1181. if (p_update_current) {
  1182. set(p_setting, p_value);
  1183. }
  1184. }
  1185. Variant _EDITOR_DEF(const String &p_setting, const Variant &p_default, bool p_restart_if_changed, bool p_basic) {
  1186. ERR_FAIL_NULL_V_MSG(EditorSettings::get_singleton(), p_default, "EditorSettings not instantiated yet.");
  1187. Variant ret = p_default;
  1188. if (EditorSettings::get_singleton()->has_setting(p_setting)) {
  1189. ret = EDITOR_GET(p_setting);
  1190. } else {
  1191. EditorSettings::get_singleton()->set_manually(p_setting, p_default);
  1192. }
  1193. EditorSettings::get_singleton()->set_restart_if_changed(p_setting, p_restart_if_changed);
  1194. EditorSettings::get_singleton()->set_basic(p_setting, p_basic);
  1195. if (!EditorSettings::get_singleton()->has_default_value(p_setting)) {
  1196. EditorSettings::get_singleton()->set_initial_value(p_setting, p_default);
  1197. }
  1198. return ret;
  1199. }
  1200. Variant _EDITOR_GET(const String &p_setting) {
  1201. ERR_FAIL_COND_V(!EditorSettings::get_singleton() || !EditorSettings::get_singleton()->has_setting(p_setting), Variant());
  1202. return EditorSettings::get_singleton()->get(p_setting);
  1203. }
  1204. bool EditorSettings::_property_can_revert(const StringName &p_name) const {
  1205. const VariantContainer *property = props.getptr(p_name);
  1206. if (property) {
  1207. return property->has_default_value;
  1208. }
  1209. return false;
  1210. }
  1211. bool EditorSettings::_property_get_revert(const StringName &p_name, Variant &r_property) const {
  1212. const VariantContainer *value = props.getptr(p_name);
  1213. if (value && value->has_default_value) {
  1214. r_property = value->initial;
  1215. return true;
  1216. }
  1217. return false;
  1218. }
  1219. void EditorSettings::add_property_hint(const PropertyInfo &p_hint) {
  1220. _THREAD_SAFE_METHOD_
  1221. hints[p_hint.name] = p_hint;
  1222. }
  1223. // Metadata
  1224. void EditorSettings::set_project_metadata(const String &p_section, const String &p_key, const Variant &p_data) {
  1225. const String path = _get_project_metadata_path();
  1226. if (project_metadata.is_null()) {
  1227. project_metadata.instantiate();
  1228. Error err = project_metadata->load(path);
  1229. if (err != OK && err != ERR_FILE_NOT_FOUND) {
  1230. ERR_PRINT("Cannot load project metadata from file '" + path + "'.");
  1231. }
  1232. }
  1233. project_metadata->set_value(p_section, p_key, p_data);
  1234. Error err = project_metadata->save(path);
  1235. ERR_FAIL_COND_MSG(err != OK, "Cannot save project metadata to file '" + path + "'.");
  1236. }
  1237. Variant EditorSettings::get_project_metadata(const String &p_section, const String &p_key, const Variant &p_default) const {
  1238. if (project_metadata.is_null()) {
  1239. project_metadata.instantiate();
  1240. const String path = _get_project_metadata_path();
  1241. Error err = project_metadata->load(path);
  1242. ERR_FAIL_COND_V_MSG(err != OK && err != ERR_FILE_NOT_FOUND, p_default, "Cannot load project metadata from file '" + path + "'.");
  1243. }
  1244. return project_metadata->get_value(p_section, p_key, p_default);
  1245. }
  1246. void EditorSettings::set_favorites(const Vector<String> &p_favorites) {
  1247. favorites = p_favorites;
  1248. String favorites_file;
  1249. if (Engine::get_singleton()->is_project_manager_hint()) {
  1250. favorites_file = EditorPaths::get_singleton()->get_config_dir().path_join("favorite_dirs");
  1251. } else {
  1252. favorites_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("favorites");
  1253. }
  1254. Ref<FileAccess> f = FileAccess::open(favorites_file, FileAccess::WRITE);
  1255. if (f.is_valid()) {
  1256. for (int i = 0; i < favorites.size(); i++) {
  1257. f->store_line(favorites[i]);
  1258. }
  1259. }
  1260. }
  1261. void EditorSettings::set_favorite_properties(const HashMap<String, PackedStringArray> &p_favorite_properties) {
  1262. favorite_properties = p_favorite_properties;
  1263. String favorite_properties_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("favorite_properties");
  1264. Ref<ConfigFile> cf;
  1265. cf.instantiate();
  1266. for (const KeyValue<String, PackedStringArray> &kv : p_favorite_properties) {
  1267. cf->set_value(kv.key, "properties", kv.value);
  1268. }
  1269. cf->save(favorite_properties_file);
  1270. }
  1271. Vector<String> EditorSettings::get_favorites() const {
  1272. return favorites;
  1273. }
  1274. HashMap<String, PackedStringArray> EditorSettings::get_favorite_properties() const {
  1275. return favorite_properties;
  1276. }
  1277. void EditorSettings::set_recent_dirs(const Vector<String> &p_recent_dirs) {
  1278. recent_dirs = p_recent_dirs;
  1279. String recent_dirs_file;
  1280. if (Engine::get_singleton()->is_project_manager_hint()) {
  1281. recent_dirs_file = EditorPaths::get_singleton()->get_config_dir().path_join("recent_dirs");
  1282. } else {
  1283. recent_dirs_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("recent_dirs");
  1284. }
  1285. Ref<FileAccess> f = FileAccess::open(recent_dirs_file, FileAccess::WRITE);
  1286. if (f.is_valid()) {
  1287. for (int i = 0; i < recent_dirs.size(); i++) {
  1288. f->store_line(recent_dirs[i]);
  1289. }
  1290. }
  1291. }
  1292. Vector<String> EditorSettings::get_recent_dirs() const {
  1293. return recent_dirs;
  1294. }
  1295. void EditorSettings::load_favorites_and_recent_dirs() {
  1296. String favorites_file;
  1297. String favorite_properties_file;
  1298. String recent_dirs_file;
  1299. if (Engine::get_singleton()->is_project_manager_hint()) {
  1300. favorites_file = EditorPaths::get_singleton()->get_config_dir().path_join("favorite_dirs");
  1301. favorite_properties_file = EditorPaths::get_singleton()->get_config_dir().path_join("favorite_properties");
  1302. recent_dirs_file = EditorPaths::get_singleton()->get_config_dir().path_join("recent_dirs");
  1303. } else {
  1304. favorites_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("favorites");
  1305. favorite_properties_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("favorite_properties");
  1306. recent_dirs_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("recent_dirs");
  1307. }
  1308. /// File Favorites
  1309. Ref<FileAccess> f = FileAccess::open(favorites_file, FileAccess::READ);
  1310. if (f.is_valid()) {
  1311. String line = f->get_line().strip_edges();
  1312. while (!line.is_empty()) {
  1313. favorites.append(line);
  1314. line = f->get_line().strip_edges();
  1315. }
  1316. }
  1317. /// Inspector Favorites
  1318. Ref<ConfigFile> cf;
  1319. cf.instantiate();
  1320. if (cf->load(favorite_properties_file) == OK) {
  1321. List<String> secs;
  1322. cf->get_sections(&secs);
  1323. for (String &E : secs) {
  1324. PackedStringArray properties = PackedStringArray(cf->get_value(E, "properties"));
  1325. if (EditorNode::get_editor_data().is_type_recognized(E) || ResourceLoader::exists(E, "Script")) {
  1326. for (const String &property : properties) {
  1327. if (!favorite_properties[E].has(property)) {
  1328. favorite_properties[E].push_back(property);
  1329. }
  1330. }
  1331. }
  1332. }
  1333. }
  1334. /// Recent Directories
  1335. f = FileAccess::open(recent_dirs_file, FileAccess::READ);
  1336. if (f.is_valid()) {
  1337. String line = f->get_line().strip_edges();
  1338. while (!line.is_empty()) {
  1339. recent_dirs.push_back(line);
  1340. line = f->get_line().strip_edges();
  1341. }
  1342. }
  1343. }
  1344. void EditorSettings::list_text_editor_themes() {
  1345. String themes = "Default,Godot 2,Custom";
  1346. Ref<DirAccess> d = DirAccess::open(EditorPaths::get_singleton()->get_text_editor_themes_dir());
  1347. if (d.is_valid()) {
  1348. List<String> custom_themes;
  1349. d->list_dir_begin();
  1350. String file = d->get_next();
  1351. while (!file.is_empty()) {
  1352. if (file.get_extension() == "tet" && !_is_default_text_editor_theme(file.get_basename().to_lower())) {
  1353. custom_themes.push_back(file.get_basename());
  1354. }
  1355. file = d->get_next();
  1356. }
  1357. d->list_dir_end();
  1358. custom_themes.sort();
  1359. for (const String &E : custom_themes) {
  1360. themes += "," + E;
  1361. }
  1362. }
  1363. add_property_hint(PropertyInfo(Variant::STRING, "text_editor/theme/color_theme", PROPERTY_HINT_ENUM, themes));
  1364. }
  1365. void EditorSettings::load_text_editor_theme() {
  1366. String p_file = get("text_editor/theme/color_theme");
  1367. if (_is_default_text_editor_theme(p_file.get_file().to_lower())) {
  1368. if (p_file == "Godot 2") {
  1369. _load_godot2_text_editor_theme();
  1370. }
  1371. return; // sorry for "Settings changed" console spam
  1372. }
  1373. String theme_path = EditorPaths::get_singleton()->get_text_editor_themes_dir().path_join(p_file + ".tet");
  1374. Ref<ConfigFile> cf = memnew(ConfigFile);
  1375. Error err = cf->load(theme_path);
  1376. if (err != OK) {
  1377. return;
  1378. }
  1379. List<String> keys;
  1380. cf->get_section_keys("color_theme", &keys);
  1381. for (const String &key : keys) {
  1382. String val = cf->get_value("color_theme", key);
  1383. // don't load if it's not already there!
  1384. if (has_setting("text_editor/theme/highlighting/" + key)) {
  1385. // make sure it is actually a color
  1386. if (val.is_valid_html_color() && key.contains("color")) {
  1387. props["text_editor/theme/highlighting/" + key].variant = Color::html(val); // change manually to prevent "Settings changed" console spam
  1388. }
  1389. }
  1390. }
  1391. emit_signal(SNAME("settings_changed"));
  1392. // if it doesn't load just use what is currently loaded
  1393. }
  1394. bool EditorSettings::import_text_editor_theme(const String &p_file) {
  1395. if (!p_file.ends_with(".tet")) {
  1396. return false;
  1397. } else {
  1398. if (p_file.get_file().to_lower() == "default.tet") {
  1399. return false;
  1400. }
  1401. Ref<DirAccess> d = DirAccess::open(EditorPaths::get_singleton()->get_text_editor_themes_dir());
  1402. if (d.is_valid()) {
  1403. d->copy(p_file, EditorPaths::get_singleton()->get_text_editor_themes_dir().path_join(p_file.get_file()));
  1404. return true;
  1405. }
  1406. }
  1407. return false;
  1408. }
  1409. bool EditorSettings::save_text_editor_theme() {
  1410. String p_file = get("text_editor/theme/color_theme");
  1411. if (_is_default_text_editor_theme(p_file.get_file().to_lower())) {
  1412. return false;
  1413. }
  1414. String theme_path = EditorPaths::get_singleton()->get_text_editor_themes_dir().path_join(p_file + ".tet");
  1415. return _save_text_editor_theme(theme_path);
  1416. }
  1417. bool EditorSettings::save_text_editor_theme_as(String p_file) {
  1418. if (!p_file.ends_with(".tet")) {
  1419. p_file += ".tet";
  1420. }
  1421. if (_is_default_text_editor_theme(p_file.get_file().to_lower().trim_suffix(".tet"))) {
  1422. return false;
  1423. }
  1424. if (_save_text_editor_theme(p_file)) {
  1425. // switch to theme is saved in the theme directory
  1426. list_text_editor_themes();
  1427. String theme_name = p_file.substr(0, p_file.length() - 4).get_file();
  1428. if (p_file.get_base_dir() == EditorPaths::get_singleton()->get_text_editor_themes_dir()) {
  1429. _initial_set("text_editor/theme/color_theme", theme_name);
  1430. load_text_editor_theme();
  1431. }
  1432. return true;
  1433. }
  1434. return false;
  1435. }
  1436. bool EditorSettings::is_default_text_editor_theme() {
  1437. String p_file = get("text_editor/theme/color_theme");
  1438. return _is_default_text_editor_theme(p_file.get_file().to_lower());
  1439. }
  1440. Vector<String> EditorSettings::get_script_templates(const String &p_extension, const String &p_custom_path) {
  1441. Vector<String> templates;
  1442. String template_dir = EditorPaths::get_singleton()->get_script_templates_dir();
  1443. if (!p_custom_path.is_empty()) {
  1444. template_dir = p_custom_path;
  1445. }
  1446. Ref<DirAccess> d = DirAccess::open(template_dir);
  1447. if (d.is_valid()) {
  1448. d->list_dir_begin();
  1449. String file = d->get_next();
  1450. while (!file.is_empty()) {
  1451. if (file.get_extension() == p_extension) {
  1452. templates.push_back(file.get_basename());
  1453. }
  1454. file = d->get_next();
  1455. }
  1456. d->list_dir_end();
  1457. }
  1458. return templates;
  1459. }
  1460. String EditorSettings::get_editor_layouts_config() const {
  1461. return EditorPaths::get_singleton()->get_config_dir().path_join("editor_layouts.cfg");
  1462. }
  1463. float EditorSettings::get_auto_display_scale() const {
  1464. #ifdef LINUXBSD_ENABLED
  1465. if (DisplayServer::get_singleton()->get_name() == "Wayland") {
  1466. float main_window_scale = DisplayServer::get_singleton()->screen_get_scale(DisplayServer::SCREEN_OF_MAIN_WINDOW);
  1467. if (DisplayServer::get_singleton()->get_screen_count() == 1 || Math::fract(main_window_scale) != 0) {
  1468. // If we have a single screen or the screen of the window is fractional, all
  1469. // bets are off. At this point, let's just return the current's window scale,
  1470. // which is special-cased to the scale of `SCREEN_OF_MAIN_WINDOW`.
  1471. return main_window_scale;
  1472. }
  1473. // If the above branch didn't fire, fractional scaling isn't going to work
  1474. // properly anyways (we're need the ability to change the UI scale at runtime).
  1475. // At this point it's more convenient to "supersample" like we do with other
  1476. // platforms, hoping that the user is only using integer-scaled screens.
  1477. return DisplayServer::get_singleton()->screen_get_max_scale();
  1478. }
  1479. #endif
  1480. #if defined(MACOS_ENABLED) || defined(ANDROID_ENABLED)
  1481. return DisplayServer::get_singleton()->screen_get_max_scale();
  1482. #else
  1483. const int screen = DisplayServer::get_singleton()->window_get_current_screen();
  1484. if (DisplayServer::get_singleton()->screen_get_size(screen) == Vector2i()) {
  1485. // Invalid screen size, skip.
  1486. return 1.0;
  1487. }
  1488. // Use the smallest dimension to use a correct display scale on portrait displays.
  1489. const int smallest_dimension = MIN(DisplayServer::get_singleton()->screen_get_size(screen).x, DisplayServer::get_singleton()->screen_get_size(screen).y);
  1490. if (DisplayServer::get_singleton()->screen_get_dpi(screen) >= 192 && smallest_dimension >= 1400) {
  1491. // hiDPI display.
  1492. return 2.0;
  1493. } else if (smallest_dimension >= 1700) {
  1494. // Likely a hiDPI display, but we aren't certain due to the returned DPI.
  1495. // Use an intermediate scale to handle this situation.
  1496. return 1.5;
  1497. } else if (smallest_dimension <= 800) {
  1498. // Small loDPI display. Use a smaller display scale so that editor elements fit more easily.
  1499. // Icons won't look great, but this is better than having editor elements overflow from its window.
  1500. return 0.75;
  1501. }
  1502. return 1.0;
  1503. #endif
  1504. }
  1505. // Shortcuts
  1506. void EditorSettings::_add_shortcut_default(const String &p_name, const Ref<Shortcut> &p_shortcut) {
  1507. shortcuts[p_name] = p_shortcut;
  1508. }
  1509. void EditorSettings::add_shortcut(const String &p_name, const Ref<Shortcut> &p_shortcut) {
  1510. shortcuts[p_name] = p_shortcut;
  1511. shortcuts[p_name]->set_meta("customized", true);
  1512. }
  1513. bool EditorSettings::is_shortcut(const String &p_name, const Ref<InputEvent> &p_event) const {
  1514. HashMap<String, Ref<Shortcut>>::ConstIterator E = shortcuts.find(p_name);
  1515. ERR_FAIL_COND_V_MSG(!E, false, "Unknown Shortcut: " + p_name + ".");
  1516. return E->value->matches_event(p_event);
  1517. }
  1518. Ref<Shortcut> EditorSettings::get_shortcut(const String &p_name) const {
  1519. HashMap<String, Ref<Shortcut>>::ConstIterator SC = shortcuts.find(p_name);
  1520. if (SC) {
  1521. return SC->value;
  1522. }
  1523. // If no shortcut with the provided name is found in the list, check the built-in shortcuts.
  1524. // Use the first item in the action list for the shortcut event, since a shortcut can only have 1 linked event.
  1525. Ref<Shortcut> sc;
  1526. HashMap<String, List<Ref<InputEvent>>>::ConstIterator builtin_override = builtin_action_overrides.find(p_name);
  1527. if (builtin_override) {
  1528. sc.instantiate();
  1529. sc->set_events_list(&builtin_override->value);
  1530. sc->set_name(InputMap::get_singleton()->get_builtin_display_name(p_name));
  1531. }
  1532. // If there was no override, check the default builtins to see if it has an InputEvent for the provided name.
  1533. if (sc.is_null()) {
  1534. HashMap<String, List<Ref<InputEvent>>>::ConstIterator builtin_default = InputMap::get_singleton()->get_builtins_with_feature_overrides_applied().find(p_name);
  1535. if (builtin_default) {
  1536. sc.instantiate();
  1537. sc->set_events_list(&builtin_default->value);
  1538. sc->set_name(InputMap::get_singleton()->get_builtin_display_name(p_name));
  1539. }
  1540. }
  1541. if (sc.is_valid()) {
  1542. // Add the shortcut to the list.
  1543. shortcuts[p_name] = sc;
  1544. return sc;
  1545. }
  1546. return Ref<Shortcut>();
  1547. }
  1548. void EditorSettings::get_shortcut_list(List<String> *r_shortcuts) {
  1549. for (const KeyValue<String, Ref<Shortcut>> &E : shortcuts) {
  1550. r_shortcuts->push_back(E.key);
  1551. }
  1552. }
  1553. Ref<Shortcut> ED_GET_SHORTCUT(const String &p_path) {
  1554. ERR_FAIL_NULL_V_MSG(EditorSettings::get_singleton(), nullptr, "EditorSettings not instantiated yet.");
  1555. Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(p_path);
  1556. ERR_FAIL_COND_V_MSG(sc.is_null(), sc, "Used ED_GET_SHORTCUT with invalid shortcut: " + p_path);
  1557. return sc;
  1558. }
  1559. void ED_SHORTCUT_OVERRIDE(const String &p_path, const String &p_feature, Key p_keycode, bool p_physical) {
  1560. if (!EditorSettings::get_singleton()) {
  1561. return;
  1562. }
  1563. Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(p_path);
  1564. ERR_FAIL_COND_MSG(sc.is_null(), "Used ED_SHORTCUT_OVERRIDE with invalid shortcut: " + p_path);
  1565. PackedInt32Array arr;
  1566. arr.push_back((int32_t)p_keycode);
  1567. ED_SHORTCUT_OVERRIDE_ARRAY(p_path, p_feature, arr, p_physical);
  1568. }
  1569. void ED_SHORTCUT_OVERRIDE_ARRAY(const String &p_path, const String &p_feature, const PackedInt32Array &p_keycodes, bool p_physical) {
  1570. if (!EditorSettings::get_singleton()) {
  1571. return;
  1572. }
  1573. Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(p_path);
  1574. ERR_FAIL_COND_MSG(sc.is_null(), "Used ED_SHORTCUT_OVERRIDE_ARRAY with invalid shortcut: " + p_path);
  1575. // Only add the override if the OS supports the provided feature.
  1576. if (!OS::get_singleton()->has_feature(p_feature)) {
  1577. if (!(p_feature == "macos" && (OS::get_singleton()->has_feature("web_macos") || OS::get_singleton()->has_feature("web_ios")))) {
  1578. return;
  1579. }
  1580. }
  1581. Array events;
  1582. for (int i = 0; i < p_keycodes.size(); i++) {
  1583. Key keycode = (Key)p_keycodes[i];
  1584. if (OS::get_singleton()->has_feature("macos") || OS::get_singleton()->has_feature("web_macos") || OS::get_singleton()->has_feature("web_ios")) {
  1585. // Use Cmd+Backspace as a general replacement for Delete shortcuts on macOS
  1586. if (keycode == Key::KEY_DELETE) {
  1587. keycode = KeyModifierMask::META | Key::BACKSPACE;
  1588. }
  1589. }
  1590. Ref<InputEventKey> ie;
  1591. if (keycode != Key::NONE) {
  1592. ie = InputEventKey::create_reference(keycode, p_physical);
  1593. events.push_back(ie);
  1594. }
  1595. }
  1596. // Override the existing shortcut only if it wasn't customized by the user.
  1597. if (!sc->has_meta("customized")) {
  1598. sc->set_events(events);
  1599. }
  1600. sc->set_meta("original", events.duplicate(true));
  1601. }
  1602. Ref<Shortcut> ED_SHORTCUT(const String &p_path, const String &p_name, Key p_keycode, bool p_physical) {
  1603. PackedInt32Array arr;
  1604. arr.push_back((int32_t)p_keycode);
  1605. return ED_SHORTCUT_ARRAY(p_path, p_name, arr, p_physical);
  1606. }
  1607. Ref<Shortcut> ED_SHORTCUT_ARRAY(const String &p_path, const String &p_name, const PackedInt32Array &p_keycodes, bool p_physical) {
  1608. Array events;
  1609. for (int i = 0; i < p_keycodes.size(); i++) {
  1610. Key keycode = (Key)p_keycodes[i];
  1611. if (OS::get_singleton()->has_feature("macos") || OS::get_singleton()->has_feature("web_macos") || OS::get_singleton()->has_feature("web_ios")) {
  1612. // Use Cmd+Backspace as a general replacement for Delete shortcuts on macOS
  1613. if (keycode == Key::KEY_DELETE) {
  1614. keycode = KeyModifierMask::META | Key::BACKSPACE;
  1615. }
  1616. }
  1617. Ref<InputEventKey> ie;
  1618. if (keycode != Key::NONE) {
  1619. ie = InputEventKey::create_reference(keycode, p_physical);
  1620. events.push_back(ie);
  1621. }
  1622. }
  1623. if (!EditorSettings::get_singleton()) {
  1624. Ref<Shortcut> sc;
  1625. sc.instantiate();
  1626. sc->set_name(p_name);
  1627. sc->set_events(events);
  1628. sc->set_meta("original", events.duplicate(true));
  1629. return sc;
  1630. }
  1631. Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(p_path);
  1632. if (sc.is_valid()) {
  1633. sc->set_name(p_name); //keep name (the ones that come from disk have no name)
  1634. sc->set_meta("original", events.duplicate(true)); //to compare against changes
  1635. return sc;
  1636. }
  1637. sc.instantiate();
  1638. sc->set_name(p_name);
  1639. sc->set_events(events);
  1640. sc->set_meta("original", events.duplicate(true)); //to compare against changes
  1641. EditorSettings::get_singleton()->_add_shortcut_default(p_path, sc);
  1642. return sc;
  1643. }
  1644. void EditorSettings::set_builtin_action_override(const String &p_name, const TypedArray<InputEvent> &p_events) {
  1645. List<Ref<InputEvent>> event_list;
  1646. // Override the whole list, since events may have their order changed or be added, removed or edited.
  1647. InputMap::get_singleton()->action_erase_events(p_name);
  1648. for (int i = 0; i < p_events.size(); i++) {
  1649. event_list.push_back(p_events[i]);
  1650. InputMap::get_singleton()->action_add_event(p_name, p_events[i]);
  1651. }
  1652. // Check if the provided event array is same as built-in. If it is, it does not need to be added to the overrides.
  1653. // Note that event order must also be the same.
  1654. bool same_as_builtin = true;
  1655. HashMap<String, List<Ref<InputEvent>>>::ConstIterator builtin_default = InputMap::get_singleton()->get_builtins_with_feature_overrides_applied().find(p_name);
  1656. if (builtin_default) {
  1657. const List<Ref<InputEvent>> &builtin_events = builtin_default->value;
  1658. // In the editor we only care about key events.
  1659. List<Ref<InputEventKey>> builtin_key_events;
  1660. for (Ref<InputEventKey> iek : builtin_events) {
  1661. if (iek.is_valid()) {
  1662. builtin_key_events.push_back(iek);
  1663. }
  1664. }
  1665. if (p_events.size() == builtin_key_events.size()) {
  1666. int event_idx = 0;
  1667. // Check equality of each event.
  1668. for (const Ref<InputEventKey> &E : builtin_key_events) {
  1669. if (!E->is_match(p_events[event_idx])) {
  1670. same_as_builtin = false;
  1671. break;
  1672. }
  1673. event_idx++;
  1674. }
  1675. } else {
  1676. same_as_builtin = false;
  1677. }
  1678. }
  1679. if (same_as_builtin && builtin_action_overrides.has(p_name)) {
  1680. builtin_action_overrides.erase(p_name);
  1681. } else {
  1682. builtin_action_overrides[p_name] = event_list;
  1683. }
  1684. // Update the shortcut (if it is used somewhere in the editor) to be the first event of the new list.
  1685. if (shortcuts.has(p_name)) {
  1686. shortcuts[p_name]->set_events_list(&event_list);
  1687. }
  1688. }
  1689. const Array EditorSettings::get_builtin_action_overrides(const String &p_name) const {
  1690. HashMap<String, List<Ref<InputEvent>>>::ConstIterator AO = builtin_action_overrides.find(p_name);
  1691. if (AO) {
  1692. Array event_array;
  1693. List<Ref<InputEvent>> events_list = AO->value;
  1694. for (const Ref<InputEvent> &E : events_list) {
  1695. event_array.push_back(E);
  1696. }
  1697. return event_array;
  1698. }
  1699. return Array();
  1700. }
  1701. void EditorSettings::notify_changes() {
  1702. _THREAD_SAFE_METHOD_
  1703. SceneTree *sml = Object::cast_to<SceneTree>(OS::get_singleton()->get_main_loop());
  1704. if (!sml) {
  1705. return;
  1706. }
  1707. Node *root = sml->get_root()->get_child(0);
  1708. if (!root) {
  1709. return;
  1710. }
  1711. root->propagate_notification(NOTIFICATION_EDITOR_SETTINGS_CHANGED);
  1712. }
  1713. #ifdef TOOLS_ENABLED
  1714. void EditorSettings::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
  1715. const String pf = p_function;
  1716. if (p_idx == 0) {
  1717. if (pf == "has_setting" || pf == "set_setting" || pf == "get_setting" || pf == "erase" ||
  1718. pf == "set_initial_value" || pf == "set_as_basic" || pf == "mark_setting_changed") {
  1719. for (const KeyValue<String, VariantContainer> &E : props) {
  1720. if (E.value.hide_from_editor) {
  1721. continue;
  1722. }
  1723. r_options->push_back(E.key.quote());
  1724. }
  1725. } else if (pf == "get_project_metadata" && project_metadata.is_valid()) {
  1726. List<String> sections;
  1727. project_metadata->get_sections(&sections);
  1728. for (const String &section : sections) {
  1729. r_options->push_back(section.quote());
  1730. }
  1731. } else if (pf == "set_builtin_action_override") {
  1732. for (const StringName &action : InputMap::get_singleton()->get_actions()) {
  1733. r_options->push_back(String(action).quote());
  1734. }
  1735. }
  1736. }
  1737. Object::get_argument_options(p_function, p_idx, r_options);
  1738. }
  1739. #endif
  1740. void EditorSettings::_bind_methods() {
  1741. ClassDB::bind_method(D_METHOD("has_setting", "name"), &EditorSettings::has_setting);
  1742. ClassDB::bind_method(D_METHOD("set_setting", "name", "value"), &EditorSettings::set_setting);
  1743. ClassDB::bind_method(D_METHOD("get_setting", "name"), &EditorSettings::get_setting);
  1744. ClassDB::bind_method(D_METHOD("erase", "property"), &EditorSettings::erase);
  1745. ClassDB::bind_method(D_METHOD("set_initial_value", "name", "value", "update_current"), &EditorSettings::set_initial_value);
  1746. ClassDB::bind_method(D_METHOD("add_property_info", "info"), &EditorSettings::_add_property_info_bind);
  1747. ClassDB::bind_method(D_METHOD("set_project_metadata", "section", "key", "data"), &EditorSettings::set_project_metadata);
  1748. ClassDB::bind_method(D_METHOD("get_project_metadata", "section", "key", "default"), &EditorSettings::get_project_metadata, DEFVAL(Variant()));
  1749. ClassDB::bind_method(D_METHOD("set_favorites", "dirs"), &EditorSettings::set_favorites);
  1750. ClassDB::bind_method(D_METHOD("get_favorites"), &EditorSettings::get_favorites);
  1751. ClassDB::bind_method(D_METHOD("set_recent_dirs", "dirs"), &EditorSettings::set_recent_dirs);
  1752. ClassDB::bind_method(D_METHOD("get_recent_dirs"), &EditorSettings::get_recent_dirs);
  1753. ClassDB::bind_method(D_METHOD("set_builtin_action_override", "name", "actions_list"), &EditorSettings::set_builtin_action_override);
  1754. ClassDB::bind_method(D_METHOD("check_changed_settings_in_group", "setting_prefix"), &EditorSettings::check_changed_settings_in_group);
  1755. ClassDB::bind_method(D_METHOD("get_changed_settings"), &EditorSettings::get_changed_settings);
  1756. ClassDB::bind_method(D_METHOD("mark_setting_changed", "setting"), &EditorSettings::mark_setting_changed);
  1757. ADD_SIGNAL(MethodInfo("settings_changed"));
  1758. BIND_CONSTANT(NOTIFICATION_EDITOR_SETTINGS_CHANGED);
  1759. }
  1760. EditorSettings::EditorSettings() {
  1761. last_order = 0;
  1762. _load_defaults();
  1763. callable_mp(this, &EditorSettings::_set_initialized).call_deferred();
  1764. }