Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
Path: blob/master/editor/settings/editor_settings.cpp
21000 views
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
31
#include "editor_settings.h"
32
33
#include "core/config/project_settings.h"
34
#include "core/input/input_event.h"
35
#include "core/input/input_map.h"
36
#include "core/input/shortcut.h"
37
#include "core/io/certs_compressed.gen.h"
38
#include "core/io/dir_access.h"
39
#include "core/io/file_access.h"
40
#include "core/io/ip.h"
41
#include "core/io/resource_loader.h"
42
#include "core/io/resource_saver.h"
43
#include "core/object/class_db.h"
44
#include "core/os/keyboard.h"
45
#include "core/os/os.h"
46
#include "core/string/translation_server.h"
47
#include "core/version.h"
48
#include "editor/editor_node.h"
49
#include "editor/file_system/editor_paths.h"
50
#include "editor/inspector/editor_property_name_processor.h"
51
#include "editor/project_manager/engine_update_label.h"
52
#include "editor/themes/editor_theme_manager.h"
53
#include "editor/translations/editor_translation.h"
54
#include "main/main.h"
55
#include "modules/regex/regex.h"
56
#include "scene/gui/color_picker.h"
57
#include "scene/gui/file_dialog.h"
58
#include "scene/main/node.h"
59
#include "scene/main/scene_tree.h"
60
#include "scene/main/window.h"
61
#include "scene/resources/animation.h"
62
63
// PRIVATE METHODS
64
65
Ref<EditorSettings> EditorSettings::singleton = nullptr;
66
67
// Properties
68
69
bool EditorSettings::_set(const StringName &p_name, const Variant &p_value) {
70
_THREAD_SAFE_METHOD_
71
72
bool changed = _set_only(p_name, p_value);
73
if (changed && initialized) {
74
changed_settings.insert(p_name);
75
if (p_name == SNAME("text_editor/external/exec_path")) {
76
const StringName exec_args_name = "text_editor/external/exec_flags";
77
const String exec_args_value = _guess_exec_args_for_extenal_editor(p_value);
78
if (!exec_args_value.is_empty() && _set_only(exec_args_name, exec_args_value)) {
79
changed_settings.insert(exec_args_name);
80
}
81
}
82
emit_signal(SNAME("settings_changed"));
83
84
if (p_name == SNAME("interface/editor/editor_language")) {
85
setup_language(false);
86
}
87
}
88
return true;
89
}
90
91
bool EditorSettings::_set_only(const StringName &p_name, const Variant &p_value) {
92
_THREAD_SAFE_METHOD_
93
94
if (p_name == "shortcuts") {
95
Array arr = p_value;
96
for (int i = 0; i < arr.size(); i++) {
97
Dictionary dict = arr[i];
98
String shortcut_name = dict["name"];
99
100
Array shortcut_events = dict["shortcuts"];
101
102
Ref<Shortcut> sc;
103
sc.instantiate();
104
sc->set_events(shortcut_events);
105
_add_shortcut_default(shortcut_name, sc);
106
}
107
108
return false;
109
} else if (p_name == "builtin_action_overrides") {
110
Array actions_arr = p_value;
111
for (int i = 0; i < actions_arr.size(); i++) {
112
Dictionary action_dict = actions_arr[i];
113
114
String action_name = action_dict["name"];
115
Array events = action_dict["events"];
116
117
InputMap *im = InputMap::get_singleton();
118
im->action_erase_events(action_name);
119
120
builtin_action_overrides[action_name].clear();
121
for (int ev_idx = 0; ev_idx < events.size(); ev_idx++) {
122
im->action_add_event(action_name, events[ev_idx]);
123
builtin_action_overrides[action_name].push_back(events[ev_idx]);
124
}
125
}
126
return false;
127
}
128
129
bool changed = false;
130
131
if (p_value.get_type() == Variant::NIL) {
132
if (props.has(p_name)) {
133
props.erase(p_name);
134
changed = true;
135
}
136
} else {
137
if (props.has(p_name)) {
138
if (p_value != props[p_name].variant) {
139
props[p_name].variant = p_value;
140
changed = true;
141
}
142
} else {
143
props[p_name] = VariantContainer(p_value, last_order++);
144
changed = true;
145
}
146
147
if (save_changed_setting) {
148
if (!props[p_name].save) {
149
props[p_name].save = true;
150
changed = true;
151
}
152
}
153
}
154
155
return changed;
156
}
157
158
bool EditorSettings::_get(const StringName &p_name, Variant &r_ret) const {
159
_THREAD_SAFE_METHOD_
160
161
if (p_name == "shortcuts") {
162
Array save_array;
163
const HashMap<String, List<Ref<InputEvent>>> &builtin_list = InputMap::get_singleton()->get_builtins();
164
for (const KeyValue<String, Ref<Shortcut>> &shortcut_definition : shortcuts) {
165
Ref<Shortcut> sc = shortcut_definition.value;
166
167
if (builtin_list.has(shortcut_definition.key)) {
168
// This shortcut was auto-generated from built in actions: don't save.
169
// If the builtin is overridden, it will be saved in the "builtin_action_overrides" section below.
170
continue;
171
}
172
173
Array shortcut_events = sc->get_events();
174
175
Dictionary dict;
176
dict["name"] = shortcut_definition.key;
177
dict["shortcuts"] = shortcut_events;
178
179
if (!sc->has_meta("original")) {
180
// Getting the meta when it doesn't exist will return an empty array. If the 'shortcut_events' have been cleared,
181
// we still want save the shortcut in this case so that shortcuts that the user has customized are not reset,
182
// even if the 'original' has not been populated yet. This can happen when calling save() from the Project Manager.
183
save_array.push_back(dict);
184
continue;
185
}
186
187
Array original_events = sc->get_meta("original");
188
189
bool is_same = Shortcut::is_event_array_equal(original_events, shortcut_events);
190
if (is_same) {
191
continue; // Not changed from default; don't save.
192
}
193
194
save_array.push_back(dict);
195
}
196
r_ret = save_array;
197
return true;
198
} else if (p_name == "builtin_action_overrides") {
199
Array actions_arr;
200
for (const KeyValue<String, List<Ref<InputEvent>>> &action_override : builtin_action_overrides) {
201
const List<Ref<InputEvent>> *defaults = InputMap::get_singleton()->get_builtins().getptr(action_override.key);
202
if (!defaults) {
203
continue;
204
}
205
206
List<Ref<InputEvent>> events = action_override.value;
207
208
Dictionary action_dict;
209
action_dict["name"] = action_override.key;
210
211
// Convert the list to an array, and only keep key events as this is for the editor.
212
Array events_arr;
213
for (const Ref<InputEvent> &ie : events) {
214
Ref<InputEventKey> iek = ie;
215
if (iek.is_valid()) {
216
events_arr.append(iek);
217
}
218
}
219
220
Array defaults_arr;
221
for (const Ref<InputEvent> &default_input_event : *defaults) {
222
if (default_input_event.is_valid()) {
223
defaults_arr.append(default_input_event);
224
}
225
}
226
227
bool same = Shortcut::is_event_array_equal(events_arr, defaults_arr);
228
229
// Don't save if same as default.
230
if (same) {
231
continue;
232
}
233
234
action_dict["events"] = events_arr;
235
actions_arr.push_back(action_dict);
236
}
237
238
r_ret = actions_arr;
239
return true;
240
}
241
242
const VariantContainer *v = props.getptr(p_name);
243
if (!v) {
244
return false;
245
}
246
r_ret = v->variant;
247
return true;
248
}
249
250
void EditorSettings::_initial_set(const StringName &p_name, const Variant &p_value, bool p_basic) {
251
set(p_name, p_value);
252
props[p_name].initial = p_value;
253
props[p_name].has_default_value = true;
254
props[p_name].basic = p_basic;
255
}
256
257
struct _EVCSort {
258
String name;
259
Variant::Type type = Variant::Type::NIL;
260
int order = 0;
261
bool basic = false;
262
bool save = false;
263
bool restart_if_changed = false;
264
265
bool operator<(const _EVCSort &p_vcs) const { return order < p_vcs.order; }
266
};
267
268
void EditorSettings::_get_property_list(List<PropertyInfo> *p_list) const {
269
_THREAD_SAFE_METHOD_
270
271
RBSet<_EVCSort> vclist;
272
273
for (const KeyValue<String, VariantContainer> &E : props) {
274
const VariantContainer *v = &E.value;
275
276
if (v->hide_from_editor) {
277
continue;
278
}
279
280
_EVCSort vc;
281
vc.name = E.key;
282
vc.order = v->order;
283
vc.type = v->variant.get_type();
284
vc.basic = v->basic;
285
vc.save = v->save;
286
if (vc.save) {
287
if (v->initial.get_type() != Variant::NIL && v->initial == v->variant) {
288
vc.save = false;
289
}
290
}
291
vc.restart_if_changed = v->restart_if_changed;
292
293
vclist.insert(vc);
294
}
295
296
for (const _EVCSort &E : vclist) {
297
uint32_t pusage = PROPERTY_USAGE_NONE;
298
if (E.save || !optimize_save) {
299
pusage |= PROPERTY_USAGE_STORAGE;
300
}
301
302
if (!E.name.begins_with("_") && !E.name.begins_with("projects/")) {
303
pusage |= PROPERTY_USAGE_EDITOR;
304
} else {
305
pusage |= PROPERTY_USAGE_STORAGE; //hiddens must always be saved
306
}
307
308
PropertyInfo pi(E.type, E.name);
309
pi.usage = pusage;
310
if (hints.has(E.name)) {
311
pi = hints[E.name];
312
}
313
314
if (E.basic) {
315
pi.usage |= PROPERTY_USAGE_EDITOR_BASIC_SETTING;
316
}
317
318
if (E.restart_if_changed) {
319
pi.usage |= PROPERTY_USAGE_RESTART_IF_CHANGED;
320
}
321
322
p_list->push_back(pi);
323
}
324
325
p_list->push_back(PropertyInfo(Variant::ARRAY, "shortcuts", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL)); //do not edit
326
p_list->push_back(PropertyInfo(Variant::ARRAY, "builtin_action_overrides", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
327
}
328
329
void EditorSettings::_add_property_info_bind(const Dictionary &p_info) {
330
ERR_FAIL_COND_MSG(!p_info.has("name"), "Property info is missing \"name\" field.");
331
ERR_FAIL_COND_MSG(!p_info.has("type"), "Property info is missing \"type\" field.");
332
333
if (p_info.has("usage")) {
334
WARN_PRINT("\"usage\" is not supported in add_property_info().");
335
}
336
337
PropertyInfo pinfo;
338
pinfo.name = p_info["name"];
339
ERR_FAIL_COND(!props.has(pinfo.name));
340
pinfo.type = Variant::Type(p_info["type"].operator int());
341
ERR_FAIL_INDEX(pinfo.type, Variant::VARIANT_MAX);
342
343
if (p_info.has("hint")) {
344
pinfo.hint = PropertyHint(p_info["hint"].operator int());
345
}
346
if (p_info.has("hint_string")) {
347
pinfo.hint_string = p_info["hint_string"];
348
}
349
350
add_property_hint(pinfo);
351
}
352
353
// Default configs
354
bool EditorSettings::has_default_value(const String &p_setting) const {
355
_THREAD_SAFE_METHOD_
356
357
if (!props.has(p_setting)) {
358
return false;
359
}
360
return props[p_setting].has_default_value;
361
}
362
363
void EditorSettings::_set_initialized() {
364
initialized = true;
365
}
366
367
static LocalVector<String> _get_skipped_locales() {
368
// Skip locales if Text server lack required features.
369
LocalVector<String> locales_to_skip;
370
if (!TS->has_feature(TextServer::FEATURE_BIDI_LAYOUT) || !TS->has_feature(TextServer::FEATURE_SHAPING)) {
371
locales_to_skip.push_back("ar"); // Arabic.
372
locales_to_skip.push_back("fa"); // Persian.
373
locales_to_skip.push_back("ur"); // Urdu.
374
}
375
if (!TS->has_feature(TextServer::FEATURE_BIDI_LAYOUT)) {
376
locales_to_skip.push_back("he"); // Hebrew.
377
}
378
if (!TS->has_feature(TextServer::FEATURE_SHAPING)) {
379
locales_to_skip.push_back("bn"); // Bengali.
380
locales_to_skip.push_back("hi"); // Hindi.
381
locales_to_skip.push_back("ml"); // Malayalam.
382
locales_to_skip.push_back("si"); // Sinhala.
383
locales_to_skip.push_back("ta"); // Tamil.
384
locales_to_skip.push_back("te"); // Telugu.
385
}
386
return locales_to_skip;
387
}
388
389
void EditorSettings::_load_defaults(Ref<ConfigFile> p_extra_config) {
390
_THREAD_SAFE_METHOD_
391
// Sets up the editor setting with a default value and hint PropertyInfo.
392
#define EDITOR_SETTING(m_type, m_property_hint, m_name, m_default_value, m_hint_string) \
393
_initial_set(m_name, m_default_value); \
394
hints[m_name] = PropertyInfo(m_type, m_name, m_property_hint, m_hint_string);
395
396
#define EDITOR_SETTING_BASIC(m_type, m_property_hint, m_name, m_default_value, m_hint_string) \
397
_initial_set(m_name, m_default_value, true); \
398
hints[m_name] = PropertyInfo(m_type, m_name, m_property_hint, m_hint_string);
399
400
#define EDITOR_SETTING_USAGE(m_type, m_property_hint, m_name, m_default_value, m_hint_string, m_usage) \
401
_initial_set(m_name, m_default_value); \
402
hints[m_name] = PropertyInfo(m_type, m_name, m_property_hint, m_hint_string, m_usage);
403
404
/* Languages */
405
406
{
407
String lang_hint;
408
const String host_lang = OS::get_singleton()->get_locale();
409
410
// Skip locales which we can't render properly.
411
const LocalVector<String> locales_to_skip = _get_skipped_locales();
412
if (!locales_to_skip.is_empty()) {
413
WARN_PRINT("Some locales are not properly supported by selected Text Server and are disabled.");
414
}
415
416
String best = "en";
417
int best_score = 0;
418
for (const String &locale : get_editor_locales()) {
419
// Test against language code without regional variants (e.g. ur_PK).
420
String lang_code = locale.get_slicec('_', 0);
421
if (locales_to_skip.has(lang_code)) {
422
continue;
423
}
424
425
lang_hint += ";";
426
const String lang_name = TranslationServer::get_singleton()->get_locale_name(locale);
427
lang_hint += vformat("%s/[%s] %s", locale, locale, lang_name);
428
429
int score = TranslationServer::get_singleton()->compare_locales(host_lang, locale);
430
if (score > 0 && score >= best_score) {
431
best = locale;
432
best_score = score;
433
}
434
}
435
lang_hint = vformat(";auto/Auto (%s);en/[en] English", TranslationServer::get_singleton()->get_locale_name(best)) + lang_hint;
436
437
EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_ENUM, "interface/editor/editor_language", "auto", lang_hint, PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED | PROPERTY_USAGE_EDITOR_BASIC_SETTING);
438
}
439
440
// Asset library
441
_initial_set("asset_library/use_threads", true);
442
443
/* Interface */
444
445
// Editor
446
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/localize_settings", true, "")
447
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/dock_tab_style", 0, "Text Only,Icon Only,Text and Icon")
448
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/bottom_dock_tab_style", 0, "Text Only,Icon Only,Text and Icon")
449
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)
450
451
// Display what the Auto display scale setting effectively corresponds to.
452
const String display_scale_hint_string = vformat("Auto (%d%%),75%%,100%%,125%%,150%%,175%%,200%%,Custom", Math::round(get_auto_display_scale() * 100));
453
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)
454
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)
455
456
String ed_screen_hints = "Auto (Remembers last position):-5,Screen With Mouse Pointer:-4,Screen With Keyboard Focus:-3,Primary Screen:-2";
457
for (int i = 0; i < DisplayServer::get_singleton()->get_screen_count(); i++) {
458
ed_screen_hints += ",Screen " + itos(i + 1) + ":" + itos(i);
459
}
460
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/editor_screen", EditorSettings::InitialScreen::INITIAL_SCREEN_AUTO, ed_screen_hints)
461
462
#ifdef WINDOWS_ENABLED
463
String tablet_hints = "Use Project Settings:-1";
464
for (int i = 0; i < DisplayServer::get_singleton()->tablet_get_driver_count(); i++) {
465
String drv_name = DisplayServer::get_singleton()->tablet_get_driver_name(i);
466
if (EditorPropertyNameProcessor::get_singleton()) {
467
drv_name = EditorPropertyNameProcessor::get_singleton()->process_name(drv_name, EditorPropertyNameProcessor::STYLE_CAPITALIZED); // Note: EditorPropertyNameProcessor is not available when doctool is used, but this value is not part of docs.
468
}
469
tablet_hints += vformat(",%s:%d", drv_name, i);
470
}
471
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/tablet_driver", -1, tablet_hints);
472
#else
473
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/tablet_driver", -1, "Default:-1");
474
#endif
475
476
String project_manager_screen_hints = "Screen With Mouse Pointer:-4,Screen With Keyboard Focus:-3,Primary Screen:-2";
477
for (int i = 0; i < DisplayServer::get_singleton()->get_screen_count(); i++) {
478
project_manager_screen_hints += ",Screen " + itos(i + 1) + ":" + itos(i);
479
}
480
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/project_manager_screen", EditorSettings::InitialScreen::INITIAL_SCREEN_PRIMARY, project_manager_screen_hints)
481
482
{
483
const String update_hint = vformat("Disable Update Checks,Auto (%s),Check Newest Preview,Check Newest Stable,Check Newest Patch", (str_compare(GODOT_VERSION_STATUS, "stable") == 0) ? "Stable" : "Preview");
484
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "network/connection/check_for_updates", EngineUpdateLabel::UpdateMode::AUTO, update_hint);
485
}
486
487
EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/use_embedded_menu", false, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_EDITOR_BASIC_SETTING)
488
EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/use_native_file_dialogs", false, "", PROPERTY_USAGE_DEFAULT)
489
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)
490
491
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "interface/editor/main_font_size", 14, "8,48,1")
492
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "interface/editor/code_font_size", 14, "8,48,1")
493
_initial_set("interface/editor/main_font_custom_opentype_features", "");
494
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")
495
_initial_set("interface/editor/code_font_custom_opentype_features", "");
496
_initial_set("interface/editor/code_font_custom_variations", "");
497
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/font_antialiasing", 1, "None,Grayscale,LCD Subpixel")
498
#ifdef MACOS_ENABLED
499
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/font_hinting", 0, "Auto (None),None,Light,Normal")
500
#else
501
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/font_hinting", 0, "Auto (Light),None,Light,Normal")
502
#endif
503
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")
504
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/font_disable_embedded_bitmaps", true, "");
505
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/font_allow_msdf", true, "")
506
507
EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "interface/editor/main_font", "", "*.ttf,*.otf,*.woff,*.woff2,*.pfb,*.pfm")
508
EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "interface/editor/main_font_bold", "", "*.ttf,*.otf,*.woff,*.woff2,*.pfb,*.pfm")
509
EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "interface/editor/code_font", "", "*.ttf,*.otf,*.woff,*.woff2,*.pfb,*.pfm")
510
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/editor/dragging_hover_wait_seconds", 0.5, "0.01,10,0.01,or_greater,suffix:s");
511
_initial_set("interface/editor/separate_distraction_mode", false, true);
512
_initial_set("interface/editor/automatically_open_screenshots", true, true);
513
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)
514
_initial_set("interface/editor/mouse_extra_buttons_navigate_history", true);
515
_initial_set("interface/editor/save_each_scene_on_quit", true, true); // Regression
516
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/save_on_focus_loss", false, "")
517
EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/accept_dialog_cancel_ok_buttons", 0,
518
vformat("Auto (%s),Cancel First,OK First", DisplayServer::get_singleton()->get_swap_cancel_ok() ? "OK First" : "Cancel First"),
519
PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED);
520
#ifdef DEV_ENABLED
521
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/show_internal_errors_in_toast_notifications", 0, "Auto (Enabled),Enabled,Disabled")
522
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/show_update_spinner", 0, "Auto (Enabled),Enabled,Disabled")
523
#else
524
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/show_internal_errors_in_toast_notifications", 0, "Auto (Disabled),Enabled,Disabled")
525
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/show_update_spinner", 0, "Auto (Disabled),Enabled,Disabled")
526
#endif
527
528
_initial_set("interface/editor/keep_screen_on", false, true);
529
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)
530
// Default unfocused usec sleep is for 10 FPS. Allow an unfocused FPS limit
531
// as low as 1 FPS for those who really need low power usage (but don't need
532
// to preview particles or shaders while the editor is unfocused). With very
533
// low FPS limits, the editor can take a small while to become usable after
534
// being focused again, so this should be used at the user's discretion.
535
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)
536
537
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/import_resources_when_unfocused", false, "")
538
539
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/editor/vsync_mode", 1, "Disabled,Enabled,Adaptive,Mailbox")
540
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/update_continuously", false, "")
541
542
bool is_android_editor = false;
543
#ifdef ANDROID_ENABLED
544
if (!OS::get_singleton()->has_feature("xr_editor")) {
545
is_android_editor = true;
546
}
547
#endif
548
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/editor/collapse_main_menu", is_android_editor, "")
549
550
_initial_set("interface/editors/show_scene_tree_root_selection", true);
551
_initial_set("interface/editors/derive_script_globals_by_name", true);
552
_initial_set("docks/scene_tree/ask_before_revoking_unique_name", true);
553
554
// Inspector
555
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "interface/inspector/max_array_dictionary_items_per_page", 20, "10,100,1")
556
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/show_low_level_opentype_features", false, "")
557
EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/inspector/float_drag_speed", 5.0, "0.1,100,0.01")
558
EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/inspector/integer_drag_speed", 0.5, "0.1,10,0.01")
559
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/inspector/nested_color_mode", 0, "Containers & Resources,Resources,External Resources")
560
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/delimitate_all_container_and_resources", true, "")
561
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);
562
// The lowest value is equal to the minimum float step for 32-bit floats.
563
// The step must be set manually, as changing this setting should not change the step here.
564
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_EDITOR_BASIC_SETTING);
565
EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/disable_folding", false, "", PROPERTY_USAGE_DEFAULT);
566
EDITOR_SETTING_USAGE(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/auto_unfold_foreign_scenes", true, "", PROPERTY_USAGE_DEFAULT)
567
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/horizontal_vector2_editing", false, "")
568
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/horizontal_vector_types_editing", true, "")
569
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/open_resources_in_current_inspector", true, "")
570
571
PackedStringArray open_in_new_inspector_defaults;
572
// Required for the script editor to work.
573
open_in_new_inspector_defaults.push_back("Script");
574
// Required for the GridMap editor to work.
575
open_in_new_inspector_defaults.push_back("MeshLibrary");
576
_initial_set("interface/inspector/resources_to_open_in_new_inspector", open_in_new_inspector_defaults);
577
578
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/accessibility/accessibility_support", 0, "Auto (When Screen Reader is Running),Always Active,Disabled")
579
set_restart_if_changed("interface/accessibility/accessibility_support", true);
580
581
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/inspector/default_color_picker_mode", (int32_t)ColorPicker::MODE_RGB, "RGB,HSV,RAW,OKHSL")
582
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,OK HS Rectangle:5,OK HL Rectangle") // `SHAPE_NONE` is 4.
583
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/inspector/color_picker_show_intensity", true, "");
584
585
// Theme
586
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_ENUM, "interface/theme/follow_system_theme", false, "")
587
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_ENUM, "interface/theme/style", "Modern", "Modern,Classic")
588
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_ENUM, "interface/theme/color_preset", "Default", "Default,Breeze Dark,Godot 2,Godot 3,Gray,Light,Solarized (Dark),Solarized (Light),Black (OLED),Custom")
589
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_ENUM, "interface/theme/spacing_preset", "Default", "Compact,Default,Spacious,Custom")
590
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/theme/icon_and_font_color", 0, "Auto,Dark,Light")
591
EDITOR_SETTING_BASIC(Variant::COLOR, PROPERTY_HINT_NONE, "interface/theme/base_color", Color(0.14, 0.14, 0.14), "")
592
EDITOR_SETTING_BASIC(Variant::COLOR, PROPERTY_HINT_NONE, "interface/theme/accent_color", Color(0.34, 0.62, 1.0), "")
593
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/theme/use_system_accent_color", false, "")
594
EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/theme/contrast", 0.3, "-1,1,0.01")
595
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/theme/draw_extra_borders", false, "")
596
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/theme/icon_saturation", 2.0, "0,2,0.01")
597
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/theme/draw_relationship_lines", (int32_t)EditorThemeManager::RELATIONSHIP_SELECTED_ONLY, "None,Selected Only,All")
598
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/theme/relationship_line_opacity", 0.1, "0.00,1,0.01")
599
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "interface/theme/border_size", 0, "0,2,1")
600
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "interface/theme/corner_radius", 4, "0,6,1")
601
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "interface/theme/base_spacing", 4, "0,8,1")
602
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "interface/theme/additional_spacing", 0, "0,8,1")
603
EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "interface/theme/custom_theme", "", "*.res,*.tres,*.theme", PROPERTY_USAGE_DEFAULT)
604
605
// Touchscreen
606
bool has_touchscreen_ui = DisplayServer::get_singleton()->is_touchscreen_available();
607
bool is_native_touchscreen = has_touchscreen_ui && !OS::get_singleton()->has_feature("xr_editor"); // Disable some touchscreen settings by default for the XR Editor.
608
609
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/touchscreen/enable_touch_optimizations", is_native_touchscreen, "")
610
set_restart_if_changed("interface/touchscreen/enable_touch_optimizations", true);
611
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/touchscreen/enable_long_press_as_right_click", is_native_touchscreen, "")
612
set_restart_if_changed("interface/touchscreen/enable_long_press_as_right_click", true);
613
614
EDITOR_SETTING(Variant::BOOL, PROPERTY_HINT_NONE, "interface/touchscreen/enable_pan_and_scale_gestures", has_touchscreen_ui, "")
615
set_restart_if_changed("interface/touchscreen/enable_pan_and_scale_gestures", true);
616
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "interface/touchscreen/scale_gizmo_handles", has_touchscreen_ui ? 2 : 1, "1,5,1")
617
set_restart_if_changed("interface/touchscreen/scale_gizmo_handles", true);
618
619
// Only available in the Android/XR editor.
620
String touch_actions_panel_hints = "Disabled:0,Embedded Panel:1,Floating Panel:2";
621
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "interface/touchscreen/touch_actions_panel", 1, touch_actions_panel_hints)
622
623
// Scene tabs
624
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "interface/scene_tabs/display_close_button", 1, "Never,If Tab Active,Always"); // TabBar::CloseButtonDisplayPolicy
625
_initial_set("interface/scene_tabs/show_thumbnail_on_hover", true);
626
EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "interface/scene_tabs/maximum_width", 350, "0,9999,1", PROPERTY_USAGE_DEFAULT)
627
_initial_set("interface/scene_tabs/show_script_button", false, true);
628
_initial_set("interface/scene_tabs/restore_scenes_on_load", true, true);
629
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/scene_tabs/auto_select_current_scene_file", false, "");
630
631
// Multi Window
632
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/multi_window/enable", true, "");
633
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/multi_window/restore_windows_on_load", true, "");
634
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "interface/multi_window/maximize_window", false, "");
635
set_restart_if_changed("interface/multi_window/enable", true);
636
637
/* Filesystem */
638
639
// External Programs
640
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/raster_image_editor", "", "")
641
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/vector_image_editor", "", "")
642
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/audio_editor", "", "")
643
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/3d_model_editor", "", "")
644
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/external_programs/terminal_emulator", "", "")
645
EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_PLACEHOLDER_TEXT, "filesystem/external_programs/terminal_emulator_flags", "", "Call flags with placeholder: {directory}.");
646
647
// Directories
648
EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_DIR, "filesystem/directories/autoscan_project_path", "", "")
649
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);
650
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_GLOBAL_DIR, "filesystem/directories/default_project_path", fs_dir_default_project_path, "")
651
652
// On save
653
_initial_set("filesystem/on_save/compress_binary_resources", true);
654
_initial_set("filesystem/on_save/safe_save_on_backup_then_rename", true);
655
_initial_set("filesystem/on_save/warn_on_saving_large_text_resources", true);
656
657
// EditorFileServer
658
_initial_set("filesystem/file_server/port", 6010);
659
_initial_set("filesystem/file_server/password", "");
660
661
// File dialog
662
_initial_set("filesystem/file_dialog/show_hidden_files", false);
663
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "filesystem/file_dialog/display_mode", 0, "Thumbnails,List")
664
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "filesystem/file_dialog/thumbnail_size", 64, "32,128,16")
665
666
// Quick Open dialog
667
EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "filesystem/quick_open_dialog/max_results", 100, "0,10000,1", PROPERTY_USAGE_DEFAULT)
668
_initial_set("filesystem/quick_open_dialog/instant_preview", false);
669
_initial_set("filesystem/quick_open_dialog/show_search_highlight", true);
670
_initial_set("filesystem/quick_open_dialog/enable_fuzzy_matching", true);
671
EDITOR_SETTING_USAGE(Variant::INT, PROPERTY_HINT_RANGE, "filesystem/quick_open_dialog/max_fuzzy_misses", 2, "0,10,1", PROPERTY_USAGE_DEFAULT)
672
_initial_set("filesystem/quick_open_dialog/include_addons", false);
673
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "filesystem/quick_open_dialog/default_display_mode", 0, "Adaptive,Last Used")
674
675
// Import (for glft module)
676
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)
677
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)
678
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)
679
EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "filesystem/import/fbx/fbx2gltf_path", "", "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
680
681
// Tools (denoise)
682
EDITOR_SETTING_USAGE(Variant::STRING, PROPERTY_HINT_GLOBAL_DIR, "filesystem/tools/oidn/oidn_denoise_path", "", "", PROPERTY_USAGE_DEFAULT)
683
684
/* Docks */
685
686
// SceneTree
687
_initial_set("docks/scene_tree/ask_before_deleting_related_animation_tracks", true);
688
_initial_set("docks/scene_tree/start_create_dialog_fully_expanded", false);
689
_initial_set("docks/scene_tree/auto_expand_to_selected", true);
690
_initial_set("docks/scene_tree/center_node_on_reparent", false);
691
_initial_set("docks/scene_tree/hide_filtered_out_parents", true);
692
_initial_set("docks/scene_tree/accessibility_warnings", false);
693
694
// FileSystem
695
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "docks/filesystem/thumbnail_size", 64, "32,128,16")
696
_initial_set("docks/filesystem/always_show_folders", true);
697
_initial_set("docks/filesystem/textfile_extensions", "txt,md,cfg,ini,log,json,yml,yaml,toml,xml");
698
_initial_set("docks/filesystem/other_file_extensions", "ico,icns");
699
_initial_set("docks/filesystem/automatically_open_created_scripts", true);
700
701
// Property editor
702
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.
703
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "docks/property_editor/subresource_hue_tint", 0.75, "0,1,0.01")
704
705
/* Text editor */
706
707
// Theme
708
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_ENUM, "text_editor/theme/color_theme", "Default", "Default,Godot 2,Custom")
709
710
// Theme: Highlighting
711
const LocalVector<StringName> basic_text_editor_settings = {
712
"text_editor/theme/highlighting/symbol_color",
713
"text_editor/theme/highlighting/keyword_color",
714
"text_editor/theme/highlighting/control_flow_keyword_color",
715
"text_editor/theme/highlighting/base_type_color",
716
"text_editor/theme/highlighting/engine_type_color",
717
"text_editor/theme/highlighting/user_type_color",
718
"text_editor/theme/highlighting/comment_color",
719
"text_editor/theme/highlighting/doc_comment_color",
720
"text_editor/theme/highlighting/string_color",
721
"text_editor/theme/highlighting/string_placeholder_color",
722
"text_editor/theme/highlighting/background_color",
723
"text_editor/theme/highlighting/text_color",
724
"text_editor/theme/highlighting/line_number_color",
725
"text_editor/theme/highlighting/safe_line_number_color",
726
"text_editor/theme/highlighting/caret_color",
727
"text_editor/theme/highlighting/caret_background_color",
728
"text_editor/theme/highlighting/text_selected_color",
729
"text_editor/theme/highlighting/selection_color",
730
"text_editor/theme/highlighting/brace_mismatch_color",
731
"text_editor/theme/highlighting/current_line_color",
732
"text_editor/theme/highlighting/line_length_guideline_color",
733
"text_editor/theme/highlighting/word_highlighted_color",
734
"text_editor/theme/highlighting/number_color",
735
"text_editor/theme/highlighting/function_color",
736
"text_editor/theme/highlighting/member_variable_color",
737
"text_editor/theme/highlighting/mark_color",
738
};
739
// These values will be overwritten by EditorThemeManager, but can still be seen in some edge cases.
740
const HashMap<StringName, Color> text_colors = get_godot2_text_editor_theme();
741
for (const KeyValue<StringName, Color> &text_color : text_colors) {
742
if (basic_text_editor_settings.has(text_color.key)) {
743
EDITOR_SETTING_BASIC(Variant::COLOR, PROPERTY_HINT_NONE, text_color.key, text_color.value, "")
744
} else {
745
EDITOR_SETTING(Variant::COLOR, PROPERTY_HINT_NONE, text_color.key, text_color.value, "")
746
}
747
}
748
749
// The list is based on <https://github.com/KDE/syntax-highlighting/blob/master/data/syntax/alert.xml>.
750
_initial_set("text_editor/theme/highlighting/comment_markers/critical_list", "ALERT,ATTENTION,CAUTION,CRITICAL,DANGER,SECURITY");
751
_initial_set("text_editor/theme/highlighting/comment_markers/warning_list", "BUG,DEPRECATED,FIXME,HACK,TASK,TBD,TODO,WARNING");
752
_initial_set("text_editor/theme/highlighting/comment_markers/notice_list", "INFO,NOTE,NOTICE,TEST,TESTING");
753
754
// Appearance
755
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "text_editor/appearance/enable_inline_color_picker", true, "");
756
757
// Appearance: Caret
758
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/appearance/caret/type", 0, "Line,Block")
759
_initial_set("text_editor/appearance/caret/caret_blink", true, true);
760
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "text_editor/appearance/caret/caret_blink_interval", 0.5, "0.1,10,0.01")
761
_initial_set("text_editor/appearance/caret/highlight_current_line", true, true);
762
_initial_set("text_editor/appearance/caret/highlight_all_occurrences", true, true);
763
764
// Appearance: Guidelines
765
_initial_set("text_editor/appearance/guidelines/show_line_length_guidelines", true, true);
766
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/appearance/guidelines/line_length_guideline_soft_column", 80, "20,160,1")
767
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/appearance/guidelines/line_length_guideline_hard_column", 100, "20,160,1")
768
769
// Appearance: Gutters
770
_initial_set("text_editor/appearance/gutters/show_line_numbers", true, true);
771
_initial_set("text_editor/appearance/gutters/line_numbers_zero_padded", false, true);
772
_initial_set("text_editor/appearance/gutters/highlight_type_safe_lines", true, true);
773
_initial_set("text_editor/appearance/gutters/show_info_gutter", true, true);
774
775
// Appearance: Minimap
776
_initial_set("text_editor/appearance/minimap/show_minimap", true, true);
777
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/appearance/minimap/minimap_width", 80, "50,250,1")
778
779
// Appearance: Lines
780
_initial_set("text_editor/appearance/lines/code_folding", true, true);
781
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/appearance/lines/word_wrap", 0, "None,Boundary")
782
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/appearance/lines/autowrap_mode", 3, "Arbitrary:1,Word:2,Word (Smart):3")
783
784
// Appearance: Whitespace
785
_initial_set("text_editor/appearance/whitespace/draw_tabs", true, true);
786
_initial_set("text_editor/appearance/whitespace/draw_spaces", false, true);
787
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/appearance/whitespace/line_spacing", 4, "0,50,1")
788
789
// Behavior
790
// Behavior: General
791
_initial_set("text_editor/behavior/general/empty_selection_clipboard", true);
792
793
// Behavior: Navigation
794
_initial_set("text_editor/behavior/navigation/move_caret_on_right_click", true, true);
795
_initial_set("text_editor/behavior/navigation/scroll_past_end_of_file", false, true);
796
_initial_set("text_editor/behavior/navigation/smooth_scrolling", true, true);
797
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/behavior/navigation/v_scroll_speed", 80, "1,10000,1")
798
_initial_set("text_editor/behavior/navigation/drag_and_drop_selection", true, true);
799
_initial_set("text_editor/behavior/navigation/stay_in_script_editor_on_node_selected", true, true);
800
_initial_set("text_editor/behavior/navigation/open_script_when_connecting_signal_to_existing_method", true, true);
801
_initial_set("text_editor/behavior/navigation/use_default_word_separators", true); // Includes ´`~$^=+|<> General punctuation and CJK punctuation.
802
_initial_set("text_editor/behavior/navigation/use_custom_word_separators", false);
803
_initial_set("text_editor/behavior/navigation/custom_word_separators", ""); // Custom word separators.
804
805
// Behavior: Indent
806
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/behavior/indent/type", 0, "Tabs,Spaces")
807
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/behavior/indent/size", 4, "1,64,1") // size of 0 crashes.
808
_initial_set("text_editor/behavior/indent/auto_indent", true);
809
_initial_set("text_editor/behavior/indent/indent_wrapped_lines", true);
810
811
// Behavior: Files
812
_initial_set("text_editor/behavior/files/trim_trailing_whitespace_on_save", false);
813
_initial_set("text_editor/behavior/files/trim_final_newlines_on_save", true);
814
_initial_set("text_editor/behavior/files/autosave_interval_secs", 0);
815
_initial_set("text_editor/behavior/files/restore_scripts_on_load", true);
816
_initial_set("text_editor/behavior/files/convert_indent_on_save", true);
817
_initial_set("text_editor/behavior/files/auto_reload_scripts_on_external_change", true);
818
_initial_set("text_editor/behavior/files/auto_reload_and_parse_scripts_on_save", true);
819
_initial_set("text_editor/behavior/files/open_dominant_script_on_scene_change", false, true);
820
_initial_set("text_editor/behavior/files/drop_preload_resources_as_uid", true, true);
821
822
// Behavior: Documentation
823
_initial_set("text_editor/behavior/documentation/enable_tooltips", true, true);
824
825
// Script list
826
_initial_set("text_editor/script_list/show_members_overview", true, true);
827
_initial_set("text_editor/script_list/sort_members_outline_alphabetically", false, true);
828
_initial_set("text_editor/script_list/script_temperature_enabled", true);
829
_initial_set("text_editor/script_list/script_temperature_history_size", 15);
830
_initial_set("text_editor/script_list/highlight_scene_scripts", true);
831
_initial_set("text_editor/script_list/group_help_pages", true);
832
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/script_list/sort_scripts_by", 0, "None:2,Name:0,Path:1");
833
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/script_list/list_script_names_as", 0, "Name,Parent Directory And Name,Full Path");
834
EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_GLOBAL_FILE, "text_editor/external/exec_path", "", "");
835
EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_PLACEHOLDER_TEXT, "text_editor/external/exec_flags", "{file}", "Call flags with placeholders: {project}, {file}, {col}, {line}.");
836
837
// Completion
838
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "text_editor/completion/idle_parse_delay", 1.5, "0.1,10,0.01")
839
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "text_editor/completion/idle_parse_delay_with_errors_found", 0.5, "0.1,5,0.01")
840
_initial_set("text_editor/completion/auto_brace_complete", true, true);
841
_initial_set("text_editor/completion/code_complete_enabled", true, true);
842
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "text_editor/completion/code_complete_delay", 0.3, "0.01,5,0.01,or_greater")
843
_initial_set("text_editor/completion/put_callhint_tooltip_below_current_line", true);
844
_initial_set("text_editor/completion/complete_file_paths", true);
845
_initial_set("text_editor/completion/add_type_hints", true, true);
846
_initial_set("text_editor/completion/add_string_name_literals", false, true);
847
_initial_set("text_editor/completion/add_node_path_literals", false, true);
848
_initial_set("text_editor/completion/use_single_quotes", false, true);
849
_initial_set("text_editor/completion/colorize_suggestions", true);
850
851
// External editor (ScriptEditorPlugin)
852
_initial_set("text_editor/external/use_external_editor", false, true);
853
_initial_set("text_editor/external/exec_path", "");
854
855
// Help
856
_initial_set("text_editor/help/show_help_index", true);
857
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/help/help_font_size", 16, "8,48,1")
858
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/help/help_source_font_size", 15, "8,48,1")
859
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "text_editor/help/help_title_font_size", 23, "8,64,1")
860
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "text_editor/help/class_reference_examples", 0, "GDScript,C#,GDScript and C#")
861
_initial_set("text_editor/help/sort_functions_alphabetically", true);
862
863
/* Editors */
864
865
// GridMap
866
// GridMapEditor
867
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/grid_map/pick_distance", 5000.0, "1,8192,0.1,or_greater");
868
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "editors/grid_map/preview_size", 64, "16,128,1")
869
870
// 3D
871
EDITOR_SETTING_BASIC(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d/primary_grid_color", Color(0.56, 0.56, 0.56, 0.5), "")
872
EDITOR_SETTING_BASIC(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d/secondary_grid_color", Color(0.38, 0.38, 0.38, 0.5), "")
873
874
// Use a similar color to the 2D editor selection.
875
EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d/selection_box_color", Color(1.0, 0.5, 0), "", PROPERTY_USAGE_DEFAULT)
876
EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d/active_selection_box_color", Color(1.5, 0.75, 0, 1.0), "", PROPERTY_USAGE_DEFAULT)
877
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)
878
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)
879
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)
880
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)
881
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)
882
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)
883
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)
884
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)
885
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)
886
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)
887
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)
888
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)
889
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)
890
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)
891
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)
892
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)
893
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)
894
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)
895
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)
896
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)
897
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)
898
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)
899
EDITOR_SETTING(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/gridmap_grid", Color(0.8, 0.5, 0.1), "")
900
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)
901
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)
902
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)
903
EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/ik_chain", Color(0.6, 0.9, 0.8), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
904
_initial_set("editors/3d_gizmos/gizmo_settings/bone_axis_length", (float)0.1);
905
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d_gizmos/gizmo_settings/bone_shape", 1, "Wire,Octahedron");
906
EDITOR_SETTING_USAGE(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size", 0.8, "0.01,4.0,0.001,or_greater", PROPERTY_USAGE_DEFAULT)
907
EDITOR_SETTING_USAGE(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d_gizmos/gizmo_settings/lightmap_gi_probe_size", 0.4, "0.0,1.0,0.001,or_greater", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
908
_initial_set("editors/3d_gizmos/gizmo_settings/show_collision_shapes_only_when_selected", false);
909
910
// If a line is a multiple of this, it uses the primary grid color.
911
// Use a power of 2 value by default as it's more common to use powers of 2 in level design.
912
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/primary_grid_steps", 8, "1,100,1")
913
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/grid_size", 200, "1,2000,1")
914
// Higher values produce graphical artifacts when far away unless View Z-Far
915
// is increased significantly more than it really should need to be.
916
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/grid_division_level_max", 2, "-1,3,1")
917
// Lower values produce graphical artifacts regardless of view clipping planes, so limit to -2 as a lower bound.
918
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/grid_division_level_min", 0, "-2,2,1")
919
// -0.2 seems like a sensible default. -1.0 gives Blender-like behavior, 0.5 gives huge grids.
920
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/grid_division_level_bias", -0.2, "-1.0,0.5,0.1")
921
922
_initial_set("editors/3d/grid_xz_plane", true);
923
_initial_set("editors/3d/grid_xy_plane", false);
924
_initial_set("editors/3d/grid_yz_plane", false);
925
926
// Use a lower default FOV for the 3D camera compared to the
927
// Camera3D node as the 3D viewport doesn't span the whole screen.
928
// This means it's technically viewed from a further distance, which warrants a narrower FOV.
929
EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/default_fov", 70.0, "1,179,0.1,degrees")
930
EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/default_z_near", 0.05, "0.01,10,0.01,or_greater,suffix:m")
931
EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/default_z_far", 4000.0, "0.1,4000,0.1,or_greater,suffix:m")
932
933
// 3D: Navigation
934
_initial_set("editors/3d/navigation/invert_x_axis", false, true);
935
_initial_set("editors/3d/navigation/invert_y_axis", false, true);
936
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")
937
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")
938
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")
939
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")
940
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d/navigation/zoom_style", 0, "Vertical,Horizontal")
941
942
_initial_set("editors/3d/navigation/emulate_numpad", true, true);
943
_initial_set("editors/3d/navigation/emulate_3_button_mouse", false, true);
944
_initial_set("editors/3d/navigation/warped_mouse_panning", true, true);
945
946
// 3D: Navigation feel
947
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/orbit_sensitivity", 0.25, "0.01,20,0.001")
948
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/translation_sensitivity", 1.0, "0.01,20,0.001")
949
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/orbit_inertia", 0.0, "0,1,0.001")
950
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/translation_inertia", 0.05, "0,1,0.001")
951
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/zoom_inertia", 0.05, "0,1,0.001")
952
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/navigation_feel/angle_snap_threshold", 10.0, "1,20,0.1,degrees")
953
_initial_set("editors/3d/navigation/show_viewport_rotation_gizmo", true);
954
_initial_set("editors/3d/navigation/show_viewport_navigation_gizmo", DisplayServer::get_singleton()->is_touchscreen_available());
955
956
// 3D: Freelook
957
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)")
958
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/freelook/freelook_sensitivity", 0.25, "0.01,2,0.001")
959
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/freelook/freelook_inertia", 0.0, "0,1,0.001")
960
EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/freelook/freelook_base_speed", 5.0, "0,10,0.01,or_greater")
961
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d/freelook/freelook_activation_modifier", 0, "None,Shift,Alt,Meta,Ctrl")
962
_initial_set("editors/3d/freelook/freelook_speed_zoom_link", false);
963
964
// 3D: Manipulator
965
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "editors/3d/manipulator_gizmo_size", 80, "16,160,1");
966
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/3d/manipulator_gizmo_opacity", 0.9, "0,1,0.01");
967
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_FLAGS, "editors/3d/show_gizmo_during_rotation", 2, "Global,Local");
968
969
// 2D
970
_initial_set("editors/2d/grid_color", Color(1.0, 1.0, 1.0, 0.07), true);
971
_initial_set("editors/2d/guides_color", Color(0.6, 0.0, 0.8), true);
972
_initial_set("editors/2d/smart_snapping_line_color", Color(0.9, 0.1, 0.1), true);
973
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/2d/bone_width", 5.0, "0.01,20,0.01,or_greater")
974
_initial_set("editors/2d/bone_color1", Color(1.0, 1.0, 1.0, 0.7));
975
_initial_set("editors/2d/bone_color2", Color(0.6, 0.6, 0.6, 0.7));
976
_initial_set("editors/2d/bone_selected_color", Color(0.9, 0.45, 0.45, 0.7));
977
_initial_set("editors/2d/bone_ik_color", Color(0.9, 0.9, 0.45, 0.7));
978
_initial_set("editors/2d/bone_outline_color", Color(0.35, 0.35, 0.35, 0.5));
979
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/2d/bone_outline_size", 2.0, "0.01,8,0.01,or_greater")
980
_initial_set("editors/2d/viewport_border_color", Color(0.4, 0.4, 1.0, 0.4), true);
981
_initial_set("editors/2d/use_integer_zoom_by_default", false, true);
982
EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/2d/zoom_speed_factor", 1.1, "1.01,2,0.01")
983
EDITOR_SETTING_BASIC(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/2d/ruler_width", 16.0, "12.0,30.0,1.0")
984
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/2d/auto_resample_delay", 0.3, "0.1,2,0.1")
985
986
// Bone mapper (BoneMapEditorPlugin)
987
_initial_set("editors/bone_mapper/handle_colors/unset", Color(0.3, 0.3, 0.3));
988
_initial_set("editors/bone_mapper/handle_colors/set", Color(0.1, 0.6, 0.25));
989
_initial_set("editors/bone_mapper/handle_colors/missing", Color(0.8, 0.2, 0.8));
990
_initial_set("editors/bone_mapper/handle_colors/error", Color(0.8, 0.2, 0.2));
991
992
// Panning
993
// Enum should be in sync with ControlScheme in ViewPanner.
994
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/panning/2d_editor_panning_scheme", 0, "Scroll Zooms,Scroll Pans");
995
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/panning/sub_editors_panning_scheme", 0, "Scroll Zooms,Scroll Pans");
996
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/panning/animation_editors_panning_scheme", 1, "Scroll Zooms,Scroll Pans");
997
_initial_set("editors/panning/simple_panning", false);
998
_initial_set("editors/panning/warped_mouse_panning", true);
999
_initial_set("editors/panning/2d_editor_pan_speed", 20, true);
1000
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "editors/panning/zoom_style", 0, "Vertical,Horizontal");
1001
1002
// Tiles editor
1003
_initial_set("editors/tiles_editor/display_grid", true);
1004
_initial_set("editors/tiles_editor/highlight_selected_layer", true);
1005
_initial_set("editors/tiles_editor/grid_color", Color(1.0, 0.5, 0.2, 0.5));
1006
1007
// Polygon editor
1008
_initial_set("editors/polygon_editor/point_grab_radius", has_touchscreen_ui ? 32 : 8);
1009
_initial_set("editors/polygon_editor/show_previous_outline", true);
1010
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/polygon_editor/auto_bake_delay", 1.5, "-1.0,10.0,0.01");
1011
1012
// Animation
1013
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/animation/default_animation_step", Animation::DEFAULT_STEP, "0.0,10.0,0.00000001");
1014
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "editors/animation/default_fps_mode", 0, "Seconds,FPS");
1015
_initial_set("editors/animation/default_fps_compatibility", true);
1016
_initial_set("editors/animation/autorename_animation_tracks", true);
1017
_initial_set("editors/animation/confirm_insert_track", true, true);
1018
_initial_set("editors/animation/default_create_bezier_tracks", false, true);
1019
_initial_set("editors/animation/default_create_reset_tracks", true, true);
1020
_initial_set("editors/animation/insert_at_current_time", false, true);
1021
_initial_set("editors/animation/onion_layers_past_color", Color(1, 0, 0));
1022
_initial_set("editors/animation/onion_layers_future_color", Color(0, 1, 0));
1023
1024
// Shader editor
1025
_initial_set("editors/shader_editor/behavior/files/restore_shaders_on_load", true, true);
1026
1027
// Visual editors
1028
EDITOR_SETTING(Variant::STRING, PROPERTY_HINT_ENUM, "editors/visual_editors/color_theme", "Default", "Default,Legacy,Custom")
1029
1030
_load_default_visual_shader_editor_theme();
1031
1032
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/visual_editors/minimap_opacity", 0.85, "0.0,1.0,0.01")
1033
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "editors/visual_editors/lines_curvature", 0.5, "0.0,1.0,0.01")
1034
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "editors/visual_editors/grid_pattern", 1, "Lines,Dots")
1035
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "editors/visual_editors/visual_shader/port_preview_size", 160, "100,400,0.01")
1036
1037
// Export (EditorExportPlugin)
1038
_initial_set("export/ssh/ssh", "");
1039
_initial_set("export/ssh/scp", "");
1040
1041
/* Run */
1042
1043
// Window placement
1044
#ifndef ANDROID_ENABLED
1045
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/window_placement/rect", 1, "Top Left,Centered,Custom Position,Force Maximized,Force Fullscreen")
1046
// Keep the enum values in sync with the `DisplayServer::SCREEN_` enum.
1047
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.
1048
for (int i = 0; i < DisplayServer::get_singleton()->get_screen_count(); i++) {
1049
screen_hints += ",Screen " + itos(i + 1) + ":" + itos(i);
1050
}
1051
_initial_set("run/window_placement/rect_custom_position", Vector2());
1052
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/window_placement/screen", -5, screen_hints)
1053
#endif
1054
// Should match the ANDROID_WINDOW_* constants in 'platform/android/java/editor/src/main/java/org/godotengine/editor/BaseGodotEditor.kt'.
1055
String android_window_hints = "Auto (based on screen size):0,Same as Editor:1,Side-by-side with Editor:2";
1056
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/window_placement/android_window", 0, android_window_hints)
1057
1058
String game_embed_mode_hints = "Disabled:-1,Use Per-Project Configuration:0,Embed Game:1,Make Game Workspace Floating:2";
1059
#ifdef ANDROID_ENABLED
1060
if (OS::get_singleton()->has_feature("xr_editor")) {
1061
game_embed_mode_hints = "Disabled:-1";
1062
} else {
1063
game_embed_mode_hints = "Disabled:-1,Auto (based on screen size):0,Enabled:1";
1064
}
1065
#endif
1066
int default_game_embed_mode = OS::get_singleton()->has_feature("xr_editor") ? -1 : 0;
1067
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "run/window_placement/game_embed_mode", default_game_embed_mode, game_embed_mode_hints);
1068
1069
// Auto save
1070
_initial_set("run/auto_save/save_before_running", true, true);
1071
1072
// Bottom panel
1073
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")
1074
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")
1075
1076
// Output
1077
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_RANGE, "run/output/font_size", 13, "8,48,1")
1078
_initial_set("run/output/always_clear_output_on_play", true, true);
1079
1080
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "run/output/max_lines", 10000, "100,100000,1")
1081
1082
// Platform
1083
_initial_set("run/platforms/linuxbsd/prefer_wayland", false, true);
1084
set_restart_if_changed("run/platforms/linuxbsd/prefer_wayland", true);
1085
1086
/* Network */
1087
1088
// General
1089
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "network/connection/network_mode", 0, "Offline,Online");
1090
1091
// HTTP Proxy
1092
_initial_set("network/http_proxy/host", "");
1093
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "network/http_proxy/port", 8080, "1,65535,1")
1094
1095
// SSL
1096
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);
1097
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "network/tls/enable_tls_v1.3", true, "")
1098
1099
// Debug
1100
_initial_set("network/debug/remote_host", "127.0.0.1"); // Hints provided in setup_network
1101
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "network/debug/remote_port", 6007, "1,65535,1")
1102
1103
/* Debugger/profiler */
1104
1105
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "debugger/auto_switch_to_remote_scene_tree", false, "")
1106
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "debugger/auto_switch_to_stack_trace", true, "")
1107
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "debugger/max_node_selection", 20, "1,100,1")
1108
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "debugger/profiler_frame_history_size", 3600, "60,10000,1")
1109
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "debugger/profiler_frame_max_functions", 64, "16,512,1")
1110
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_RANGE, "debugger/profiler_target_fps", 60, "1,1000,1")
1111
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "debugger/remote_scene_tree_refresh_interval", 1.0, "0.1,10,0.01,or_greater")
1112
EDITOR_SETTING(Variant::FLOAT, PROPERTY_HINT_RANGE, "debugger/remote_inspect_refresh_interval", 0.2, "0.02,10,0.01,or_greater")
1113
EDITOR_SETTING_BASIC(Variant::BOOL, PROPERTY_HINT_NONE, "debugger/profile_native_calls", false, "")
1114
1115
// Version control (VersionControlEditorPlugin)
1116
_initial_set("version_control/username", "", true);
1117
_initial_set("version_control/ssh_public_key_path", "");
1118
_initial_set("version_control/ssh_private_key_path", "");
1119
1120
/* Extra config */
1121
1122
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)
1123
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)
1124
1125
// TRANSLATORS: Project Manager here refers to the tool used to create/manage Godot projects.
1126
EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "project_manager/sorting_order", 0, "Last Edited,Name,Path")
1127
EDITOR_SETTING_BASIC(Variant::INT, PROPERTY_HINT_ENUM, "project_manager/directory_naming_convention", 1, "No Convention,kebab-case,snake_case,camelCase,PascalCase,Title Case")
1128
1129
#if defined(WEB_ENABLED)
1130
// Web platform only supports `gl_compatibility`.
1131
const String default_renderer = "gl_compatibility";
1132
#elif defined(ANDROID_ENABLED)
1133
// Use more suitable rendering method by default.
1134
const String default_renderer = "mobile";
1135
#else
1136
const String default_renderer = "forward_plus";
1137
#endif
1138
EDITOR_SETTING_BASIC(Variant::STRING, PROPERTY_HINT_ENUM, "project_manager/default_renderer", default_renderer, "forward_plus,mobile,gl_compatibility")
1139
1140
#undef EDITOR_SETTING
1141
#undef EDITOR_SETTING_BASIC
1142
#undef EDITOR_SETTING_USAGE
1143
1144
if (p_extra_config.is_valid()) {
1145
if (p_extra_config->has_section("init_projects") && p_extra_config->has_section_key("init_projects", "list")) {
1146
Vector<String> list = p_extra_config->get_value("init_projects", "list");
1147
for (int i = 0; i < list.size(); i++) {
1148
String proj_name = list[i].replace("/", "::");
1149
set("projects/" + proj_name, list[i]);
1150
}
1151
}
1152
1153
if (p_extra_config->has_section("presets")) {
1154
Vector<String> keys = p_extra_config->get_section_keys("presets");
1155
1156
for (const String &key : keys) {
1157
Variant val = p_extra_config->get_value("presets", key);
1158
set(key, val);
1159
}
1160
}
1161
}
1162
}
1163
1164
void EditorSettings::_load_default_visual_shader_editor_theme() {
1165
// Connection type colors
1166
_initial_set("editors/visual_editors/connection_colors/scalar_color", Color(0.55, 0.55, 0.55));
1167
_initial_set("editors/visual_editors/connection_colors/vector2_color", Color(0.44, 0.43, 0.64));
1168
_initial_set("editors/visual_editors/connection_colors/vector3_color", Color(0.337, 0.314, 0.71));
1169
_initial_set("editors/visual_editors/connection_colors/vector4_color", Color(0.7, 0.65, 0.147));
1170
_initial_set("editors/visual_editors/connection_colors/boolean_color", Color(0.243, 0.612, 0.349));
1171
_initial_set("editors/visual_editors/connection_colors/transform_color", Color(0.71, 0.357, 0.64));
1172
_initial_set("editors/visual_editors/connection_colors/sampler_color", Color(0.659, 0.4, 0.137));
1173
1174
// Node category colors (used for the node headers)
1175
_initial_set("editors/visual_editors/category_colors/output_color", Color(0.26, 0.10, 0.15));
1176
_initial_set("editors/visual_editors/category_colors/color_color", Color(0.5, 0.5, 0.1));
1177
_initial_set("editors/visual_editors/category_colors/conditional_color", Color(0.208, 0.522, 0.298));
1178
_initial_set("editors/visual_editors/category_colors/input_color", Color(0.502, 0.2, 0.204));
1179
_initial_set("editors/visual_editors/category_colors/scalar_color", Color(0.1, 0.5, 0.6));
1180
_initial_set("editors/visual_editors/category_colors/textures_color", Color(0.5, 0.3, 0.1));
1181
_initial_set("editors/visual_editors/category_colors/transform_color", Color(0.5, 0.3, 0.5));
1182
_initial_set("editors/visual_editors/category_colors/utility_color", Color(0.2, 0.2, 0.2));
1183
_initial_set("editors/visual_editors/category_colors/vector_color", Color(0.2, 0.2, 0.5));
1184
_initial_set("editors/visual_editors/category_colors/special_color", Color(0.098, 0.361, 0.294));
1185
_initial_set("editors/visual_editors/category_colors/particle_color", Color(0.12, 0.358, 0.8));
1186
}
1187
1188
String EditorSettings::_guess_exec_args_for_extenal_editor(const String &p_path) {
1189
Ref<RegEx> regex = RegEx::create_from_string(R"((?:jetbrains\s*)?rider(?:\s*(eap|\d{4}\.\d+|\d{4}\.\d+\s*dev)?)?|visual\s*studio\s*code|subl(ime\s*text)?|sublime_text|zed(it(or)?)?|(g)?vim|emacs|atom|geany|kate|code|(vs)?codium)");
1190
Ref<RegExMatch> editor_match = regex->search(p_path.to_lower().get_file().get_basename());
1191
1192
if (editor_match.is_null()) {
1193
return String();
1194
}
1195
1196
const String editor = editor_match->get_string(0).to_lower();
1197
String new_exec_flags = "{file}";
1198
1199
if (editor.begins_with("rider")) {
1200
new_exec_flags = "{project} --line {line} {file}";
1201
} else if (editor == "subl" || editor == "sublime text" || editor == "sublime_text" || editor == "zed" || editor == "zedit" || editor == "zeditor") {
1202
new_exec_flags = "{project} {file}:{line}:{col}";
1203
} else if (editor == "vim" || editor == "gvim") {
1204
new_exec_flags = "\"+call cursor({line}, {col})\" {file}";
1205
} else if (editor == "emacs") {
1206
new_exec_flags = "emacs +{line}:{col} {file}";
1207
} else if (editor == "atom") {
1208
new_exec_flags = "{file}:{line}";
1209
} else if (editor == "geany" || editor == "kate") {
1210
new_exec_flags = "{file} --line {line} --column {col}";
1211
} else if (editor == "code" || editor == "visual studio code" || editor == "codium" || editor == "vscodium") {
1212
new_exec_flags = "{project} --goto {file}:{line}:{col}";
1213
}
1214
1215
return new_exec_flags;
1216
}
1217
1218
const String EditorSettings::_get_project_metadata_path() const {
1219
return EditorPaths::get_singleton()->get_project_settings_dir().path_join("project_metadata.cfg");
1220
}
1221
1222
#ifndef DISABLE_DEPRECATED
1223
void EditorSettings::_remove_deprecated_settings() {
1224
erase("interface/theme/preset");
1225
erase("network/connection/engine_version_update_mode");
1226
erase("run/output/always_open_output_on_play");
1227
erase("run/output/always_close_output_on_stop");
1228
erase("text_editor/theme/line_spacing"); // See GH-106137.
1229
}
1230
#endif
1231
1232
// PUBLIC METHODS
1233
1234
EditorSettings *EditorSettings::get_singleton() {
1235
return singleton.ptr();
1236
}
1237
1238
String EditorSettings::get_existing_settings_path() {
1239
const String config_dir = EditorPaths::get_singleton()->get_config_dir();
1240
int minor = GODOT_VERSION_MINOR;
1241
String filename;
1242
1243
do {
1244
if (GODOT_VERSION_MAJOR == 4 && minor < 3) {
1245
// Minor version is used since 4.3, so special case to load older settings.
1246
filename = vformat("editor_settings-%d.tres", GODOT_VERSION_MAJOR);
1247
minor = -1;
1248
} else {
1249
filename = vformat("editor_settings-%d.%d.tres", GODOT_VERSION_MAJOR, minor);
1250
minor--;
1251
}
1252
} while (minor >= 0 && !FileAccess::exists(config_dir.path_join(filename)));
1253
return config_dir.path_join(filename);
1254
}
1255
1256
String EditorSettings::get_newest_settings_path() {
1257
const String config_file_name = vformat("editor_settings-%d.%d.tres", GODOT_VERSION_MAJOR, GODOT_VERSION_MINOR);
1258
return EditorPaths::get_singleton()->get_config_dir().path_join(config_file_name);
1259
}
1260
1261
void EditorSettings::create() {
1262
// IMPORTANT: create() *must* create a valid EditorSettings singleton,
1263
// as the rest of the engine code will assume it. As such, it should never
1264
// return (incl. via ERR_FAIL) without initializing the singleton member.
1265
1266
if (singleton.ptr()) {
1267
ERR_PRINT("Can't recreate EditorSettings as it already exists.");
1268
return;
1269
}
1270
1271
String config_file_path;
1272
Ref<ConfigFile> extra_config = memnew(ConfigFile);
1273
1274
if (!EditorPaths::get_singleton()) {
1275
ERR_PRINT("Bug (please report): EditorPaths haven't been initialized, EditorSettings cannot be created properly.");
1276
goto fail;
1277
}
1278
1279
if (EditorPaths::get_singleton()->is_self_contained()) {
1280
Error err = extra_config->load(EditorPaths::get_singleton()->get_self_contained_file());
1281
if (err != OK) {
1282
ERR_PRINT("Can't load extra config from path: " + EditorPaths::get_singleton()->get_self_contained_file());
1283
}
1284
}
1285
1286
if (EditorPaths::get_singleton()->are_paths_valid()) {
1287
// Validate editor config file.
1288
ERR_FAIL_COND(!DirAccess::dir_exists_absolute(EditorPaths::get_singleton()->get_config_dir()));
1289
1290
config_file_path = get_existing_settings_path();
1291
if (!FileAccess::exists(config_file_path)) {
1292
config_file_path = get_newest_settings_path();
1293
goto fail;
1294
}
1295
1296
singleton = ResourceLoader::load(config_file_path, "EditorSettings");
1297
if (singleton.is_null()) {
1298
ERR_PRINT("Could not load editor settings from path: " + config_file_path);
1299
config_file_path = get_newest_settings_path();
1300
goto fail;
1301
}
1302
1303
singleton->set_path(get_newest_settings_path()); // Settings can be loaded from older version file, so make sure it's newest.
1304
singleton->save_changed_setting = true;
1305
1306
print_verbose("EditorSettings: Load OK!");
1307
1308
singleton->setup_language(true);
1309
singleton->setup_network();
1310
singleton->load_favorites_and_recent_dirs();
1311
singleton->update_text_editor_themes_list();
1312
#ifndef DISABLE_DEPRECATED
1313
singleton->_remove_deprecated_settings();
1314
#endif
1315
1316
return;
1317
}
1318
1319
fail:
1320
// patch init projects
1321
String exe_path = OS::get_singleton()->get_executable_path().get_base_dir();
1322
1323
if (extra_config->has_section("init_projects")) {
1324
Vector<String> list = extra_config->get_value("init_projects", "list");
1325
for (int i = 0; i < list.size(); i++) {
1326
list.write[i] = exe_path.path_join(list[i]);
1327
}
1328
extra_config->set_value("init_projects", "list", list);
1329
}
1330
1331
singleton.instantiate();
1332
singleton->set_path(config_file_path, true);
1333
singleton->save_changed_setting = true;
1334
singleton->_load_defaults(extra_config);
1335
singleton->setup_language(true);
1336
singleton->setup_network();
1337
singleton->update_text_editor_themes_list();
1338
}
1339
1340
void EditorSettings::setup_language(bool p_initial_setup) {
1341
String lang = get_language();
1342
if (p_initial_setup) {
1343
String lang_ov = Main::get_locale_override();
1344
if (!lang_ov.is_empty()) {
1345
lang = lang_ov;
1346
}
1347
}
1348
1349
if (lang == "en") {
1350
TranslationServer::get_singleton()->set_locale(lang);
1351
return; // Default, nothing to do.
1352
}
1353
1354
load_editor_translations(lang);
1355
load_doc_translations(lang);
1356
1357
TranslationServer::get_singleton()->set_locale(lang);
1358
}
1359
1360
void EditorSettings::setup_network() {
1361
List<IPAddress> local_ip;
1362
IP::get_singleton()->get_local_addresses(&local_ip);
1363
String hint;
1364
String current = has_setting("network/debug/remote_host") ? get("network/debug/remote_host") : "";
1365
String selected = "127.0.0.1";
1366
1367
// Check that current remote_host is a valid interface address and populate hints.
1368
for (const IPAddress &ip : local_ip) {
1369
// link-local IPv6 addresses don't work, skipping them
1370
if (String(ip).begins_with("fe80:0:0:0:")) { // fe80::/64
1371
continue;
1372
}
1373
// Same goes for IPv4 link-local (APIPA) addresses.
1374
if (String(ip).begins_with("169.254.")) { // 169.254.0.0/16
1375
continue;
1376
}
1377
// Select current IP (found)
1378
if (ip == current) {
1379
selected = String(ip);
1380
}
1381
if (!hint.is_empty()) {
1382
hint += ",";
1383
}
1384
hint += String(ip);
1385
}
1386
1387
// Add hints with valid IP addresses to remote_host property.
1388
add_property_hint(PropertyInfo(Variant::STRING, "network/debug/remote_host", PROPERTY_HINT_ENUM, hint));
1389
// Fix potentially invalid remote_host due to network change.
1390
set("network/debug/remote_host", selected);
1391
}
1392
1393
void EditorSettings::save() {
1394
//_THREAD_SAFE_METHOD_
1395
1396
if (!singleton.ptr()) {
1397
return;
1398
}
1399
1400
Error err = ResourceSaver::save(singleton);
1401
1402
if (err != OK) {
1403
ERR_PRINT("Error saving editor settings to " + singleton->get_path());
1404
} else {
1405
singleton->changed_settings.clear();
1406
print_verbose("EditorSettings: Save OK!");
1407
}
1408
}
1409
1410
PackedStringArray EditorSettings::get_changed_settings() const {
1411
PackedStringArray arr;
1412
for (const String &setting : changed_settings) {
1413
arr.push_back(setting);
1414
}
1415
1416
return arr;
1417
}
1418
1419
bool EditorSettings::check_changed_settings_in_group(const String &p_setting_prefix) const {
1420
for (const String &setting : changed_settings) {
1421
if (setting.begins_with(p_setting_prefix)) {
1422
return true;
1423
}
1424
}
1425
1426
return false;
1427
}
1428
1429
void EditorSettings::mark_setting_changed(const String &p_setting) {
1430
changed_settings.insert(p_setting);
1431
}
1432
1433
void EditorSettings::destroy() {
1434
if (!singleton.ptr()) {
1435
return;
1436
}
1437
save();
1438
singleton = Ref<EditorSettings>();
1439
}
1440
1441
void EditorSettings::set_optimize_save(bool p_optimize) {
1442
optimize_save = p_optimize;
1443
}
1444
1445
// Properties
1446
1447
void EditorSettings::set_setting(const String &p_setting, const Variant &p_value) {
1448
_THREAD_SAFE_METHOD_
1449
set(p_setting, p_value);
1450
}
1451
1452
Variant EditorSettings::get_setting(const String &p_setting) const {
1453
_THREAD_SAFE_METHOD_
1454
if (ProjectSettings::get_singleton()->has_editor_setting_override(p_setting)) {
1455
return ProjectSettings::get_singleton()->get_editor_setting_override(p_setting);
1456
}
1457
return get(p_setting);
1458
}
1459
1460
bool EditorSettings::has_setting(const String &p_setting) const {
1461
_THREAD_SAFE_METHOD_
1462
1463
return props.has(p_setting);
1464
}
1465
1466
void EditorSettings::erase(const String &p_setting) {
1467
_THREAD_SAFE_METHOD_
1468
1469
props.erase(p_setting);
1470
}
1471
1472
void EditorSettings::raise_order(const String &p_setting) {
1473
_THREAD_SAFE_METHOD_
1474
1475
ERR_FAIL_COND(!props.has(p_setting));
1476
props[p_setting].order = ++last_order;
1477
}
1478
1479
void EditorSettings::set_restart_if_changed(const StringName &p_setting, bool p_restart) {
1480
_THREAD_SAFE_METHOD_
1481
1482
if (!props.has(p_setting)) {
1483
return;
1484
}
1485
props[p_setting].restart_if_changed = p_restart;
1486
}
1487
1488
void EditorSettings::set_basic(const StringName &p_setting, bool p_basic) {
1489
_THREAD_SAFE_METHOD_
1490
1491
if (!props.has(p_setting)) {
1492
return;
1493
}
1494
props[p_setting].basic = p_basic;
1495
}
1496
1497
void EditorSettings::set_initial_value(const StringName &p_setting, const Variant &p_value, bool p_update_current) {
1498
_THREAD_SAFE_METHOD_
1499
1500
if (!props.has(p_setting)) {
1501
return;
1502
}
1503
props[p_setting].initial = p_value;
1504
props[p_setting].has_default_value = true;
1505
if (p_update_current) {
1506
set(p_setting, p_value);
1507
}
1508
}
1509
1510
Variant _EDITOR_DEF(const String &p_setting, const Variant &p_default, bool p_restart_if_changed, bool p_basic) {
1511
ERR_FAIL_NULL_V_MSG(EditorSettings::get_singleton(), p_default, "EditorSettings not instantiated yet.");
1512
1513
Variant ret = p_default;
1514
if (EditorSettings::get_singleton()->has_setting(p_setting)) {
1515
ret = EDITOR_GET(p_setting);
1516
} else {
1517
EditorSettings::get_singleton()->set_manually(p_setting, p_default);
1518
}
1519
EditorSettings::get_singleton()->set_restart_if_changed(p_setting, p_restart_if_changed);
1520
EditorSettings::get_singleton()->set_basic(p_setting, p_basic);
1521
1522
if (!EditorSettings::get_singleton()->has_default_value(p_setting)) {
1523
EditorSettings::get_singleton()->set_initial_value(p_setting, p_default);
1524
}
1525
1526
return ret;
1527
}
1528
1529
Variant _EDITOR_GET(const String &p_setting) {
1530
ERR_FAIL_NULL_V_MSG(EditorSettings::get_singleton(), Variant(), vformat(R"(EditorSettings not instantiated yet when getting setting "%s".)", p_setting));
1531
ERR_FAIL_COND_V_MSG(!EditorSettings::get_singleton()->has_setting(p_setting), Variant(), vformat(R"(Editor setting "%s" does not exist.)", p_setting));
1532
return EditorSettings::get_singleton()->get_setting(p_setting);
1533
}
1534
1535
bool EditorSettings::_property_can_revert(const StringName &p_name) const {
1536
const VariantContainer *property = props.getptr(p_name);
1537
if (property) {
1538
return property->has_default_value;
1539
}
1540
return false;
1541
}
1542
1543
bool EditorSettings::_property_get_revert(const StringName &p_name, Variant &r_property) const {
1544
const VariantContainer *value = props.getptr(p_name);
1545
if (value && value->has_default_value) {
1546
r_property = value->initial;
1547
return true;
1548
}
1549
return false;
1550
}
1551
1552
void EditorSettings::add_property_hint(const PropertyInfo &p_hint) {
1553
_THREAD_SAFE_METHOD_
1554
1555
hints[p_hint.name] = p_hint;
1556
}
1557
1558
// Metadata
1559
1560
void EditorSettings::set_project_metadata(const String &p_section, const String &p_key, const Variant &p_data) {
1561
const String path = _get_project_metadata_path();
1562
1563
if (project_metadata.is_null()) {
1564
project_metadata.instantiate();
1565
1566
Error err = project_metadata->load(path);
1567
if (err != OK && err != ERR_FILE_NOT_FOUND) {
1568
ERR_PRINT("Cannot load project metadata from file '" + path + "'.");
1569
}
1570
}
1571
project_metadata->set_value(p_section, p_key, p_data);
1572
project_metadata_dirty = true;
1573
}
1574
1575
Variant EditorSettings::get_project_metadata(const String &p_section, const String &p_key, const Variant &p_default) const {
1576
if (project_metadata.is_null()) {
1577
project_metadata.instantiate();
1578
1579
const String path = _get_project_metadata_path();
1580
Error err = project_metadata->load(path);
1581
ERR_FAIL_COND_V_MSG(err != OK && err != ERR_FILE_NOT_FOUND, p_default, "Cannot load project metadata from file '" + path + "'.");
1582
}
1583
return project_metadata->get_value(p_section, p_key, p_default);
1584
}
1585
1586
void EditorSettings::save_project_metadata() {
1587
if (!project_metadata_dirty) {
1588
return;
1589
}
1590
const String path = _get_project_metadata_path();
1591
Error err = project_metadata->save(path);
1592
ERR_FAIL_COND_MSG(err != OK, "Cannot save project metadata to file '" + path + "'.");
1593
project_metadata_dirty = false;
1594
}
1595
1596
void EditorSettings::set_favorites(const Vector<String> &p_favorites, bool p_update_file_dialog) {
1597
set_favorites_bind(p_favorites);
1598
if (p_update_file_dialog) {
1599
FileDialog::set_favorite_list(get_favorite_folders());
1600
}
1601
emit_signal(SNAME("_favorites_changed"));
1602
}
1603
1604
void EditorSettings::set_favorites_bind(const Vector<String> &p_favorites) {
1605
favorites = p_favorites;
1606
String favorites_file;
1607
if (Engine::get_singleton()->is_project_manager_hint()) {
1608
favorites_file = EditorPaths::get_singleton()->get_config_dir().path_join("favorite_dirs");
1609
} else {
1610
favorites_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("favorites");
1611
}
1612
Ref<FileAccess> f = FileAccess::open(favorites_file, FileAccess::WRITE);
1613
if (f.is_valid()) {
1614
for (int i = 0; i < favorites.size(); i++) {
1615
f->store_line(favorites[i]);
1616
}
1617
}
1618
}
1619
1620
void EditorSettings::set_favorite_properties(const HashMap<String, PackedStringArray> &p_favorite_properties) {
1621
favorite_properties = p_favorite_properties;
1622
String favorite_properties_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("favorite_properties");
1623
1624
Ref<ConfigFile> cf;
1625
cf.instantiate();
1626
for (const KeyValue<String, PackedStringArray> &kv : p_favorite_properties) {
1627
cf->set_value(kv.key, "properties", kv.value);
1628
}
1629
cf->save(favorite_properties_file);
1630
}
1631
1632
Vector<String> EditorSettings::get_favorites() const {
1633
return favorites;
1634
}
1635
1636
Vector<String> EditorSettings::get_favorite_folders() const {
1637
Vector<String> folder_favorites;
1638
folder_favorites.resize(favorites.size());
1639
String *folder_write = folder_favorites.ptrw();
1640
1641
int i = 0;
1642
for (const String &fav : favorites) {
1643
if (fav.ends_with("/")) {
1644
folder_write[i] = fav;
1645
i++;
1646
}
1647
}
1648
folder_favorites.resize(i);
1649
return folder_favorites;
1650
}
1651
1652
HashMap<String, PackedStringArray> EditorSettings::get_favorite_properties() const {
1653
return HashMap<String, PackedStringArray>(favorite_properties);
1654
}
1655
1656
void EditorSettings::set_recent_dirs(const Vector<String> &p_recent_dirs, bool p_update_file_dialog) {
1657
if (p_update_file_dialog) {
1658
FileDialog::set_recent_list(p_recent_dirs);
1659
}
1660
set_recent_dirs_bind(p_recent_dirs);
1661
}
1662
1663
void EditorSettings::set_recent_dirs_bind(const Vector<String> &p_recent_dirs) {
1664
recent_dirs = p_recent_dirs;
1665
String recent_dirs_file;
1666
if (Engine::get_singleton()->is_project_manager_hint()) {
1667
recent_dirs_file = EditorPaths::get_singleton()->get_config_dir().path_join("recent_dirs");
1668
} else {
1669
recent_dirs_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("recent_dirs");
1670
}
1671
Ref<FileAccess> f = FileAccess::open(recent_dirs_file, FileAccess::WRITE);
1672
if (f.is_valid()) {
1673
for (int i = 0; i < recent_dirs.size(); i++) {
1674
f->store_line(recent_dirs[i]);
1675
}
1676
}
1677
}
1678
1679
Vector<String> EditorSettings::get_recent_dirs() const {
1680
return recent_dirs;
1681
}
1682
1683
void EditorSettings::load_favorites_and_recent_dirs() {
1684
String favorites_file;
1685
String favorite_properties_file;
1686
String recent_dirs_file;
1687
if (Engine::get_singleton()->is_project_manager_hint()) {
1688
favorites_file = EditorPaths::get_singleton()->get_config_dir().path_join("favorite_dirs");
1689
favorite_properties_file = EditorPaths::get_singleton()->get_config_dir().path_join("favorite_properties");
1690
recent_dirs_file = EditorPaths::get_singleton()->get_config_dir().path_join("recent_dirs");
1691
} else {
1692
favorites_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("favorites");
1693
favorite_properties_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("favorite_properties");
1694
recent_dirs_file = EditorPaths::get_singleton()->get_project_settings_dir().path_join("recent_dirs");
1695
}
1696
1697
/// File Favorites
1698
1699
Ref<FileAccess> f = FileAccess::open(favorites_file, FileAccess::READ);
1700
if (f.is_valid()) {
1701
String line = f->get_line().strip_edges();
1702
while (!line.is_empty()) {
1703
favorites.append(line);
1704
line = f->get_line().strip_edges();
1705
}
1706
}
1707
FileDialog::set_favorite_list(get_favorite_folders());
1708
1709
/// Inspector Favorites
1710
1711
Ref<ConfigFile> cf;
1712
cf.instantiate();
1713
if (cf->load(favorite_properties_file) == OK) {
1714
Vector<String> secs = cf->get_sections();
1715
1716
for (String &E : secs) {
1717
PackedStringArray properties = PackedStringArray(cf->get_value(E, "properties"));
1718
if (EditorNode::get_editor_data().is_type_recognized(E) || ResourceLoader::exists(E, "Script")) {
1719
for (const String &property : properties) {
1720
if (!favorite_properties[E].has(property)) {
1721
favorite_properties[E].push_back(property);
1722
}
1723
}
1724
}
1725
}
1726
}
1727
1728
/// Recent Directories
1729
1730
f = FileAccess::open(recent_dirs_file, FileAccess::READ);
1731
if (f.is_valid()) {
1732
String line = f->get_line().strip_edges();
1733
while (!line.is_empty()) {
1734
recent_dirs.push_back(line);
1735
line = f->get_line().strip_edges();
1736
}
1737
}
1738
FileDialog::set_recent_list(recent_dirs);
1739
}
1740
1741
HashMap<StringName, Color> EditorSettings::get_godot2_text_editor_theme() {
1742
// Godot 2 is only a dark theme; it doesn't have a light theme counterpart.
1743
HashMap<StringName, Color> colors;
1744
colors["text_editor/theme/highlighting/symbol_color"] = Color(0.73, 0.87, 1.0);
1745
colors["text_editor/theme/highlighting/keyword_color"] = Color(1.0, 1.0, 0.7);
1746
colors["text_editor/theme/highlighting/control_flow_keyword_color"] = Color(1.0, 0.85, 0.7);
1747
colors["text_editor/theme/highlighting/base_type_color"] = Color(0.64, 1.0, 0.83);
1748
colors["text_editor/theme/highlighting/engine_type_color"] = Color(0.51, 0.83, 1.0);
1749
colors["text_editor/theme/highlighting/user_type_color"] = Color(0.42, 0.67, 0.93);
1750
colors["text_editor/theme/highlighting/comment_color"] = Color(0.4, 0.4, 0.4);
1751
colors["text_editor/theme/highlighting/doc_comment_color"] = Color(0.5, 0.6, 0.7);
1752
colors["text_editor/theme/highlighting/string_color"] = Color(0.94, 0.43, 0.75);
1753
colors["text_editor/theme/highlighting/string_placeholder_color"] = Color(1, 0.75, 0.4);
1754
colors["text_editor/theme/highlighting/background_color"] = Color(0.13, 0.12, 0.15);
1755
colors["text_editor/theme/highlighting/completion_background_color"] = Color(0.17, 0.16, 0.2);
1756
colors["text_editor/theme/highlighting/completion_selected_color"] = Color(0.26, 0.26, 0.27);
1757
colors["text_editor/theme/highlighting/completion_existing_color"] = Color(0.87, 0.87, 0.87, 0.13);
1758
colors["text_editor/theme/highlighting/completion_scroll_color"] = Color(1, 1, 1, 0.29);
1759
colors["text_editor/theme/highlighting/completion_scroll_hovered_color"] = Color(1, 1, 1, 0.4);
1760
colors["text_editor/theme/highlighting/completion_font_color"] = Color(0.67, 0.67, 0.67);
1761
colors["text_editor/theme/highlighting/text_color"] = Color(0.67, 0.67, 0.67);
1762
colors["text_editor/theme/highlighting/line_number_color"] = Color(0.67, 0.67, 0.67, 0.4);
1763
colors["text_editor/theme/highlighting/safe_line_number_color"] = Color(0.67, 0.78, 0.67, 0.6);
1764
colors["text_editor/theme/highlighting/caret_color"] = Color(0.67, 0.67, 0.67);
1765
colors["text_editor/theme/highlighting/caret_background_color"] = Color(0, 0, 0);
1766
colors["text_editor/theme/highlighting/text_selected_color"] = Color(0, 0, 0, 0);
1767
colors["text_editor/theme/highlighting/selection_color"] = Color(0.41, 0.61, 0.91, 0.35);
1768
colors["text_editor/theme/highlighting/brace_mismatch_color"] = Color(1, 0.2, 0.2);
1769
colors["text_editor/theme/highlighting/current_line_color"] = Color(0.3, 0.5, 0.8, 0.15);
1770
colors["text_editor/theme/highlighting/line_length_guideline_color"] = Color(0.3, 0.5, 0.8, 0.1);
1771
colors["text_editor/theme/highlighting/word_highlighted_color"] = Color(0.8, 0.9, 0.9, 0.15);
1772
colors["text_editor/theme/highlighting/number_color"] = Color(0.92, 0.58, 0.2);
1773
colors["text_editor/theme/highlighting/function_color"] = Color(0.4, 0.64, 0.81);
1774
colors["text_editor/theme/highlighting/member_variable_color"] = Color(0.9, 0.31, 0.35);
1775
colors["text_editor/theme/highlighting/mark_color"] = Color(1.0, 0.4, 0.4, 0.4);
1776
colors["text_editor/theme/highlighting/warning_color"] = Color(1.0, 0.8, 0.4, 0.1);
1777
colors["text_editor/theme/highlighting/bookmark_color"] = Color(0.08, 0.49, 0.98);
1778
colors["text_editor/theme/highlighting/breakpoint_color"] = Color(0.9, 0.29, 0.3);
1779
colors["text_editor/theme/highlighting/executing_line_color"] = Color(0.98, 0.89, 0.27);
1780
colors["text_editor/theme/highlighting/code_folding_color"] = Color(0.8, 0.8, 0.8, 0.8);
1781
colors["text_editor/theme/highlighting/folded_code_region_color"] = Color(0.68, 0.46, 0.77, 0.2);
1782
colors["text_editor/theme/highlighting/search_result_color"] = Color(0.05, 0.25, 0.05, 1);
1783
colors["text_editor/theme/highlighting/search_result_border_color"] = Color(0.41, 0.61, 0.91, 0.38);
1784
colors["text_editor/theme/highlighting/gdscript/function_definition_color"] = Color(0.4, 0.9, 1.0);
1785
1786
colors["text_editor/theme/highlighting/gdscript/global_function_color"] = Color(0.64, 0.64, 0.96);
1787
colors["text_editor/theme/highlighting/gdscript/node_path_color"] = Color(0.72, 0.77, 0.49);
1788
colors["text_editor/theme/highlighting/gdscript/node_reference_color"] = Color(0.39, 0.76, 0.35);
1789
colors["text_editor/theme/highlighting/gdscript/annotation_color"] = Color(1.0, 0.7, 0.45);
1790
colors["text_editor/theme/highlighting/gdscript/string_name_color"] = Color(1.0, 0.76, 0.65);
1791
colors["text_editor/theme/highlighting/comment_markers/critical_color"] = Color(0.77, 0.35, 0.35);
1792
colors["text_editor/theme/highlighting/comment_markers/warning_color"] = Color(0.72, 0.61, 0.48);
1793
colors["text_editor/theme/highlighting/comment_markers/notice_color"] = Color(0.56, 0.67, 0.51);
1794
return colors;
1795
}
1796
1797
bool EditorSettings::is_default_text_editor_theme(const String &p_theme_name) {
1798
return p_theme_name == "default" || p_theme_name == "godot 2" || p_theme_name == "custom";
1799
}
1800
1801
void EditorSettings::update_text_editor_themes_list() {
1802
String themes = "Default,Godot 2,Custom";
1803
1804
Ref<DirAccess> d = DirAccess::open(EditorPaths::get_singleton()->get_text_editor_themes_dir());
1805
if (d.is_null()) {
1806
return;
1807
}
1808
1809
PackedStringArray custom_themes;
1810
d->list_dir_begin();
1811
String file = d->get_next();
1812
while (!file.is_empty()) {
1813
if (file.get_extension() == "tet" && !is_default_text_editor_theme(file.get_basename().to_lower())) {
1814
custom_themes.push_back(file.get_basename());
1815
}
1816
file = d->get_next();
1817
}
1818
d->list_dir_end();
1819
1820
if (!custom_themes.is_empty()) {
1821
custom_themes.sort();
1822
themes += "," + String(",").join(custom_themes);
1823
}
1824
add_property_hint(PropertyInfo(Variant::STRING, "text_editor/theme/color_theme", PROPERTY_HINT_ENUM, themes));
1825
}
1826
1827
Vector<String> EditorSettings::get_script_templates(const String &p_extension, const String &p_custom_path) {
1828
Vector<String> templates;
1829
String template_dir = EditorPaths::get_singleton()->get_script_templates_dir();
1830
if (!p_custom_path.is_empty()) {
1831
template_dir = p_custom_path;
1832
}
1833
Ref<DirAccess> d = DirAccess::open(template_dir);
1834
if (d.is_valid()) {
1835
d->list_dir_begin();
1836
String file = d->get_next();
1837
while (!file.is_empty()) {
1838
if (file.get_extension() == p_extension) {
1839
templates.push_back(file.get_basename());
1840
}
1841
file = d->get_next();
1842
}
1843
d->list_dir_end();
1844
}
1845
return templates;
1846
}
1847
1848
String EditorSettings::get_editor_layouts_config() const {
1849
return EditorPaths::get_singleton()->get_config_dir().path_join("editor_layouts.cfg");
1850
}
1851
1852
float EditorSettings::get_auto_display_scale() {
1853
#ifdef LINUXBSD_ENABLED
1854
if (DisplayServer::get_singleton()->get_name() == "Wayland") {
1855
float main_window_scale = DisplayServer::get_singleton()->screen_get_scale(DisplayServer::SCREEN_OF_MAIN_WINDOW);
1856
1857
if (DisplayServer::get_singleton()->get_screen_count() == 1 || Math::fract(main_window_scale) != 0) {
1858
// If we have a single screen or the screen of the window is fractional, all
1859
// bets are off. At this point, let's just return the current's window scale,
1860
// which is special-cased to the scale of `SCREEN_OF_MAIN_WINDOW`.
1861
return main_window_scale;
1862
}
1863
1864
// If the above branch didn't fire, fractional scaling isn't going to work
1865
// properly anyways (we're need the ability to change the UI scale at runtime).
1866
// At this point it's more convenient to "supersample" like we do with other
1867
// platforms, hoping that the user is only using integer-scaled screens.
1868
return DisplayServer::get_singleton()->screen_get_max_scale();
1869
}
1870
#endif
1871
1872
#if defined(MACOS_ENABLED) || defined(ANDROID_ENABLED)
1873
return DisplayServer::get_singleton()->screen_get_max_scale();
1874
#else
1875
const int screen = DisplayServer::get_singleton()->window_get_current_screen();
1876
1877
if (DisplayServer::get_singleton()->screen_get_size(screen) == Vector2i()) {
1878
// Invalid screen size, skip.
1879
return 1.0;
1880
}
1881
1882
#if defined(WINDOWS_ENABLED)
1883
return DisplayServer::get_singleton()->screen_get_dpi(screen) / 96.0;
1884
#else
1885
// Use the smallest dimension to use a correct display scale on portrait displays.
1886
const int smallest_dimension = MIN(DisplayServer::get_singleton()->screen_get_size(screen).x, DisplayServer::get_singleton()->screen_get_size(screen).y);
1887
if (DisplayServer::get_singleton()->screen_get_dpi(screen) >= 192 && smallest_dimension >= 1400) {
1888
// hiDPI display.
1889
return 2.0;
1890
} else if (smallest_dimension >= 1700) {
1891
// Likely a hiDPI display, but we aren't certain due to the returned DPI.
1892
// Use an intermediate scale to handle this situation.
1893
return 1.5;
1894
} else if (smallest_dimension <= 800) {
1895
// Small loDPI display. Use a smaller display scale so that editor elements fit more easily.
1896
// Icons won't look great, but this is better than having editor elements overflow from its window.
1897
return 0.75;
1898
}
1899
return 1.0;
1900
#endif // defined(WINDOWS_ENABLED)
1901
1902
#endif // defined(MACOS_ENABLED) || defined(ANDROID_ENABLED)
1903
}
1904
1905
String EditorSettings::get_language() const {
1906
const String language = has_setting("interface/editor/editor_language") ? get("interface/editor/editor_language") : "auto";
1907
if (language != "auto") {
1908
return language;
1909
}
1910
1911
if (auto_language.is_empty()) {
1912
// Skip locales which we can't render properly.
1913
const LocalVector<String> locales_to_skip = _get_skipped_locales();
1914
const String host_lang = OS::get_singleton()->get_locale();
1915
1916
String best = "en";
1917
int best_score = 0;
1918
for (const String &locale : get_editor_locales()) {
1919
// Test against language code without regional variants (e.g. ur_PK).
1920
String lang_code = locale.get_slicec('_', 0);
1921
if (locales_to_skip.has(lang_code)) {
1922
continue;
1923
}
1924
1925
int score = TranslationServer::get_singleton()->compare_locales(host_lang, locale);
1926
if (score > 0 && score >= best_score) {
1927
best = locale;
1928
best_score = score;
1929
}
1930
}
1931
auto_language = best;
1932
}
1933
return auto_language;
1934
}
1935
1936
// Shortcuts
1937
1938
void EditorSettings::_add_shortcut_default(const String &p_path, const Ref<Shortcut> &p_shortcut) {
1939
shortcuts[p_path] = p_shortcut;
1940
}
1941
1942
void EditorSettings::add_shortcut(const String &p_path, const Ref<Shortcut> &p_shortcut) {
1943
ERR_FAIL_COND_MSG(p_shortcut.is_null(), "Cannot add a null shortcut for path: " + p_path);
1944
1945
Array use_events = p_shortcut->get_events();
1946
if (shortcuts.has(p_path)) {
1947
Ref<Shortcut> existing = shortcuts.get(p_path);
1948
if (!existing->has_meta("original")) {
1949
// Loaded from editor settings, but plugin not loaded yet.
1950
// Keep the events from editor settings but still override the shortcut in the shortcuts map
1951
use_events = existing->get_events();
1952
} else if (!Shortcut::is_event_array_equal(existing->get_events(), existing->get_meta("original"))) {
1953
// Shortcut exists and is customized - don't override with default.
1954
return;
1955
}
1956
}
1957
1958
p_shortcut->set_meta("original", p_shortcut->get_events());
1959
p_shortcut->set_events(use_events);
1960
if (p_shortcut->get_name().is_empty()) {
1961
String shortcut_name = p_path.get_slicec('/', 1);
1962
if (shortcut_name.is_empty()) {
1963
shortcut_name = p_path;
1964
}
1965
p_shortcut->set_name(shortcut_name);
1966
}
1967
shortcuts[p_path] = p_shortcut;
1968
}
1969
1970
void EditorSettings::remove_shortcut(const String &p_path) {
1971
shortcuts.erase(p_path);
1972
}
1973
1974
bool EditorSettings::is_shortcut(const String &p_path, const Ref<InputEvent> &p_event) const {
1975
HashMap<String, Ref<Shortcut>>::ConstIterator E = shortcuts.find(p_path);
1976
ERR_FAIL_COND_V_MSG(!E, false, "Unknown Shortcut: " + p_path + ".");
1977
1978
return E->value->matches_event(p_event);
1979
}
1980
1981
bool EditorSettings::has_shortcut(const String &p_path) const {
1982
return get_shortcut(p_path).is_valid();
1983
}
1984
1985
Ref<Shortcut> EditorSettings::get_shortcut(const String &p_path) const {
1986
HashMap<String, Ref<Shortcut>>::ConstIterator SC = shortcuts.find(p_path);
1987
if (SC) {
1988
return SC->value;
1989
}
1990
1991
// If no shortcut with the provided name is found in the list, check the built-in shortcuts.
1992
// Use the first item in the action list for the shortcut event, since a shortcut can only have 1 linked event.
1993
1994
Ref<Shortcut> sc;
1995
HashMap<String, List<Ref<InputEvent>>>::ConstIterator builtin_override = builtin_action_overrides.find(p_path);
1996
if (builtin_override) {
1997
sc.instantiate();
1998
sc->set_events_list(&builtin_override->value);
1999
sc->set_name(InputMap::get_singleton()->get_builtin_display_name(p_path));
2000
}
2001
2002
// If there was no override, check the default builtins to see if it has an InputEvent for the provided name.
2003
if (sc.is_null()) {
2004
HashMap<String, List<Ref<InputEvent>>>::ConstIterator builtin_default = InputMap::get_singleton()->get_builtins_with_feature_overrides_applied().find(p_path);
2005
if (builtin_default) {
2006
sc.instantiate();
2007
sc->set_events_list(&builtin_default->value);
2008
sc->set_name(InputMap::get_singleton()->get_builtin_display_name(p_path));
2009
}
2010
}
2011
2012
if (sc.is_valid()) {
2013
// Add the shortcut to the list.
2014
shortcuts[p_path] = sc;
2015
return sc;
2016
}
2017
2018
return Ref<Shortcut>();
2019
}
2020
2021
Vector<String> EditorSettings::_get_shortcut_list() {
2022
List<String> shortcut_list;
2023
get_shortcut_list(&shortcut_list);
2024
Vector<String> ret;
2025
for (const String &shortcut : shortcut_list) {
2026
ret.push_back(shortcut);
2027
}
2028
return ret;
2029
}
2030
2031
void EditorSettings::get_shortcut_list(List<String> *r_shortcuts) {
2032
for (const KeyValue<String, Ref<Shortcut>> &E : shortcuts) {
2033
r_shortcuts->push_back(E.key);
2034
}
2035
}
2036
2037
Ref<Shortcut> ED_GET_SHORTCUT(const String &p_path) {
2038
ERR_FAIL_NULL_V_MSG(EditorSettings::get_singleton(), nullptr, "EditorSettings not instantiated yet.");
2039
2040
Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(p_path);
2041
2042
ERR_FAIL_COND_V_MSG(sc.is_null(), sc, "Used ED_GET_SHORTCUT with invalid shortcut: " + p_path);
2043
2044
return sc;
2045
}
2046
2047
void ED_SHORTCUT_OVERRIDE(const String &p_path, const String &p_feature, Key p_keycode, bool p_physical) {
2048
if (!EditorSettings::get_singleton()) {
2049
return;
2050
}
2051
2052
Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(p_path);
2053
ERR_FAIL_COND_MSG(sc.is_null(), "Used ED_SHORTCUT_OVERRIDE with invalid shortcut: " + p_path);
2054
2055
PackedInt32Array arr;
2056
arr.push_back((int32_t)p_keycode);
2057
2058
ED_SHORTCUT_OVERRIDE_ARRAY(p_path, p_feature, arr, p_physical);
2059
}
2060
2061
void ED_SHORTCUT_OVERRIDE_ARRAY(const String &p_path, const String &p_feature, const PackedInt32Array &p_keycodes, bool p_physical) {
2062
if (!EditorSettings::get_singleton()) {
2063
return;
2064
}
2065
2066
Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(p_path);
2067
ERR_FAIL_COND_MSG(sc.is_null(), "Used ED_SHORTCUT_OVERRIDE_ARRAY with invalid shortcut: " + p_path);
2068
2069
// Only add the override if the OS supports the provided feature.
2070
if (!OS::get_singleton()->has_feature(p_feature)) {
2071
if (!(p_feature == "macos" && (OS::get_singleton()->has_feature("web_macos") || OS::get_singleton()->has_feature("web_ios")))) {
2072
return;
2073
}
2074
}
2075
2076
Array events;
2077
2078
for (int i = 0; i < p_keycodes.size(); i++) {
2079
Key keycode = (Key)p_keycodes[i];
2080
2081
if (OS::prefer_meta_over_ctrl()) {
2082
// Use Cmd+Backspace as a general replacement for Delete shortcuts on macOS
2083
if (keycode == Key::KEY_DELETE) {
2084
keycode = KeyModifierMask::META | Key::BACKSPACE;
2085
}
2086
}
2087
2088
Ref<InputEventKey> ie;
2089
if (keycode != Key::NONE) {
2090
ie = InputEventKey::create_reference(keycode, p_physical);
2091
events.push_back(ie);
2092
}
2093
}
2094
2095
// Override the existing shortcut only if it wasn't customized by the user.
2096
if (Shortcut::is_event_array_equal(sc->get_events(), sc->get_meta("original"))) {
2097
sc->set_events(events);
2098
}
2099
2100
sc->set_meta("original", events.duplicate(true));
2101
}
2102
2103
Ref<Shortcut> ED_SHORTCUT(const String &p_path, const String &p_name, Key p_keycode, bool p_physical) {
2104
PackedInt32Array arr;
2105
arr.push_back((int32_t)p_keycode);
2106
return ED_SHORTCUT_ARRAY(p_path, p_name, arr, p_physical);
2107
}
2108
2109
Ref<Shortcut> ED_SHORTCUT_ARRAY(const String &p_path, const String &p_name, const PackedInt32Array &p_keycodes, bool p_physical) {
2110
Array events;
2111
2112
for (int i = 0; i < p_keycodes.size(); i++) {
2113
Key keycode = (Key)p_keycodes[i];
2114
2115
if (OS::prefer_meta_over_ctrl()) {
2116
// Use Cmd+Backspace as a general replacement for Delete shortcuts on macOS
2117
if (keycode == Key::KEY_DELETE) {
2118
keycode = KeyModifierMask::META | Key::BACKSPACE;
2119
}
2120
}
2121
2122
Ref<InputEventKey> ie;
2123
if (keycode != Key::NONE) {
2124
ie = InputEventKey::create_reference(keycode, p_physical);
2125
events.push_back(ie);
2126
}
2127
}
2128
2129
if (!EditorSettings::get_singleton()) {
2130
Ref<Shortcut> sc;
2131
sc.instantiate();
2132
sc->set_name(p_name);
2133
sc->set_events(events);
2134
sc->set_meta("original", events.duplicate(true));
2135
return sc;
2136
}
2137
2138
Ref<Shortcut> sc = EditorSettings::get_singleton()->get_shortcut(p_path);
2139
if (sc.is_valid()) {
2140
sc->set_name(p_name); //keep name (the ones that come from disk have no name)
2141
sc->set_meta("original", events.duplicate(true)); //to compare against changes
2142
return sc;
2143
}
2144
2145
sc.instantiate();
2146
sc->set_name(p_name);
2147
sc->set_events(events);
2148
sc->set_meta("original", events.duplicate(true)); //to compare against changes
2149
EditorSettings::get_singleton()->_add_shortcut_default(p_path, sc);
2150
2151
return sc;
2152
}
2153
2154
void EditorSettings::set_builtin_action_override(const String &p_name, const TypedArray<InputEvent> &p_events) {
2155
List<Ref<InputEvent>> event_list;
2156
2157
// Override the whole list, since events may have their order changed or be added, removed or edited.
2158
InputMap::get_singleton()->action_erase_events(p_name);
2159
for (int i = 0; i < p_events.size(); i++) {
2160
event_list.push_back(p_events[i]);
2161
InputMap::get_singleton()->action_add_event(p_name, p_events[i]);
2162
}
2163
2164
// Check if the provided event array is same as built-in. If it is, it does not need to be added to the overrides.
2165
// Note that event order must also be the same.
2166
bool same_as_builtin = true;
2167
HashMap<String, List<Ref<InputEvent>>>::ConstIterator builtin_default = InputMap::get_singleton()->get_builtins_with_feature_overrides_applied().find(p_name);
2168
if (builtin_default) {
2169
const List<Ref<InputEvent>> &builtin_events = builtin_default->value;
2170
2171
// In the editor we only care about key events.
2172
List<Ref<InputEventKey>> builtin_key_events;
2173
for (Ref<InputEventKey> iek : builtin_events) {
2174
if (iek.is_valid()) {
2175
builtin_key_events.push_back(iek);
2176
}
2177
}
2178
2179
if (p_events.size() == builtin_key_events.size()) {
2180
int event_idx = 0;
2181
2182
// Check equality of each event.
2183
for (const Ref<InputEventKey> &E : builtin_key_events) {
2184
if (!E->is_match(p_events[event_idx])) {
2185
same_as_builtin = false;
2186
break;
2187
}
2188
event_idx++;
2189
}
2190
} else {
2191
same_as_builtin = false;
2192
}
2193
}
2194
2195
if (same_as_builtin && builtin_action_overrides.has(p_name)) {
2196
builtin_action_overrides.erase(p_name);
2197
} else {
2198
builtin_action_overrides[p_name] = event_list;
2199
}
2200
2201
// Update the shortcut (if it is used somewhere in the editor) to be the first event of the new list.
2202
if (shortcuts.has(p_name)) {
2203
shortcuts[p_name]->set_events_list(&event_list);
2204
}
2205
}
2206
2207
const Array EditorSettings::get_builtin_action_overrides(const String &p_name) const {
2208
HashMap<String, List<Ref<InputEvent>>>::ConstIterator AO = builtin_action_overrides.find(p_name);
2209
if (AO) {
2210
Array event_array;
2211
2212
List<Ref<InputEvent>> events_list = AO->value;
2213
for (const Ref<InputEvent> &E : events_list) {
2214
event_array.push_back(E);
2215
}
2216
return event_array;
2217
}
2218
2219
return Array();
2220
}
2221
2222
void EditorSettings::notify_changes() {
2223
_THREAD_SAFE_METHOD_
2224
2225
SceneTree *sml = Object::cast_to<SceneTree>(OS::get_singleton()->get_main_loop());
2226
2227
if (!sml) {
2228
return;
2229
}
2230
2231
Node *root = sml->get_root()->get_child(0);
2232
2233
if (!root) {
2234
return;
2235
}
2236
root->propagate_notification(NOTIFICATION_EDITOR_SETTINGS_CHANGED);
2237
}
2238
2239
void EditorSettings::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
2240
const String pf = p_function;
2241
if (p_idx == 0) {
2242
if (pf == "has_setting" || pf == "set_setting" || pf == "get_setting" || pf == "erase" ||
2243
pf == "set_initial_value" || pf == "set_as_basic" || pf == "mark_setting_changed") {
2244
for (const KeyValue<String, VariantContainer> &E : props) {
2245
if (E.value.hide_from_editor) {
2246
continue;
2247
}
2248
2249
r_options->push_back(E.key.quote());
2250
}
2251
} else if (pf == "get_project_metadata" && project_metadata.is_valid()) {
2252
Vector<String> sections = project_metadata->get_sections();
2253
for (const String &section : sections) {
2254
r_options->push_back(section.quote());
2255
}
2256
} else if (pf == "set_builtin_action_override") {
2257
for (const Variant &action : InputMap::get_singleton()->get_actions()) {
2258
r_options->push_back(String(action).quote());
2259
}
2260
}
2261
}
2262
Object::get_argument_options(p_function, p_idx, r_options);
2263
}
2264
2265
void EditorSettings::_bind_methods() {
2266
ClassDB::bind_method(D_METHOD("has_setting", "name"), &EditorSettings::has_setting);
2267
ClassDB::bind_method(D_METHOD("set_setting", "name", "value"), &EditorSettings::set_setting);
2268
ClassDB::bind_method(D_METHOD("get_setting", "name"), &EditorSettings::get_setting);
2269
ClassDB::bind_method(D_METHOD("erase", "property"), &EditorSettings::erase);
2270
ClassDB::bind_method(D_METHOD("set_initial_value", "name", "value", "update_current"), &EditorSettings::set_initial_value);
2271
ClassDB::bind_method(D_METHOD("add_property_info", "info"), &EditorSettings::_add_property_info_bind);
2272
2273
ClassDB::bind_method(D_METHOD("set_project_metadata", "section", "key", "data"), &EditorSettings::set_project_metadata);
2274
ClassDB::bind_method(D_METHOD("get_project_metadata", "section", "key", "default"), &EditorSettings::get_project_metadata, DEFVAL(Variant()));
2275
2276
ClassDB::bind_method(D_METHOD("set_favorites", "dirs"), &EditorSettings::set_favorites_bind);
2277
ClassDB::bind_method(D_METHOD("get_favorites"), &EditorSettings::get_favorites);
2278
ClassDB::bind_method(D_METHOD("set_recent_dirs", "dirs"), &EditorSettings::set_recent_dirs_bind);
2279
ClassDB::bind_method(D_METHOD("get_recent_dirs"), &EditorSettings::get_recent_dirs);
2280
2281
ClassDB::bind_method(D_METHOD("set_builtin_action_override", "name", "actions_list"), &EditorSettings::set_builtin_action_override);
2282
2283
ClassDB::bind_method(D_METHOD("add_shortcut", "path", "shortcut"), &EditorSettings::add_shortcut);
2284
ClassDB::bind_method(D_METHOD("remove_shortcut", "path"), &EditorSettings::remove_shortcut);
2285
ClassDB::bind_method(D_METHOD("is_shortcut", "path", "event"), &EditorSettings::is_shortcut);
2286
ClassDB::bind_method(D_METHOD("has_shortcut", "path"), &EditorSettings::has_shortcut);
2287
ClassDB::bind_method(D_METHOD("get_shortcut", "path"), &EditorSettings::get_shortcut);
2288
ClassDB::bind_method(D_METHOD("get_shortcut_list"), &EditorSettings::_get_shortcut_list);
2289
2290
ClassDB::bind_method(D_METHOD("check_changed_settings_in_group", "setting_prefix"), &EditorSettings::check_changed_settings_in_group);
2291
ClassDB::bind_method(D_METHOD("get_changed_settings"), &EditorSettings::get_changed_settings);
2292
ClassDB::bind_method(D_METHOD("mark_setting_changed", "setting"), &EditorSettings::mark_setting_changed);
2293
2294
ADD_SIGNAL(MethodInfo("settings_changed"));
2295
ADD_SIGNAL(MethodInfo("_favorites_changed"));
2296
2297
BIND_CONSTANT(NOTIFICATION_EDITOR_SETTINGS_CHANGED);
2298
}
2299
2300
EditorSettings::EditorSettings() {
2301
last_order = 0;
2302
2303
_load_defaults();
2304
callable_mp(this, &EditorSettings::_set_initialized).call_deferred();
2305
}
2306
2307