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