asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/EditorSettings.xml

658 lines
32 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 14:18:53 +01:00
<class name="EditorSettings" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
Object that holds the project-independent editor settings.
</brief_description>
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Object that holds the project-independent editor settings. These settings are generally visible in the [b]Editor &gt; Editor Settings[/b] menu.
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Property names use slash delimiters to distinguish sections. Setting values can be of any [Variant] type. It's recommended to use [code]snake_case[/code] for editor settings to be consistent with the Godot editor itself.
Accessing the settings can be done using the following methods, such as:
Port code examples to C# (D) Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-09-13 14:45:36 +02:00
[codeblocks]
[gdscript]
var settings = EditorInterface.get_editor_settings()
# `settings.set("some/property", 10)` also works as this class overrides `_set()` internally.
settings.set_setting("some/property", 10)
# `settings.get("some/property")` also works as this class overrides `_get()` internally.
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
settings.get_setting("some/property")
var list_of_settings = settings.get_property_list()
Port code examples to C# (D) Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-09-13 14:45:36 +02:00
[/gdscript]
[csharp]
EditorSettings settings = GetEditorInterface().GetEditorSettings();
// `settings.set("some/property", value)` also works as this class overrides `_set()` internally.
settings.SetSetting("some/property", Value);
// `settings.get("some/property", value)` also works as this class overrides `_get()` internally.
settings.GetSetting("some/property");
Godot.Collections.Array listOfSettings = settings.GetPropertyList();
[/csharp]
[/codeblocks]
Document how some editor classes should be accessed as singletons only This closes #37687.
2020-04-14 22:09:21 +02:00
[b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_editor_settings].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_property_info">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="info" type="Dictionary" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
Adds a custom property info to a property. The dictionary must contain:
- [code]name[/code]: [String] (the name of the property)
- [code]type[/code]: [int] (see [enum Variant.Type])
- optionally [code]hint[/code]: [int] (see [enum PropertyHint]) and [code]hint_string[/code]: [String]
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
[b]Example:[/b]
Port code examples to C# (D) Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-09-13 14:45:36 +02:00
[codeblocks]
[gdscript]
var settings = EditorInterface.get_editor_settings()
settings.set("category/property_name", 0)
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
var property_info = {
"name": "category/property_name",
"type": TYPE_INT,
"hint": PROPERTY_HINT_ENUM,
"hint_string": "one,two,three"
}
Port code examples to C# (D) Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-09-13 14:45:36 +02:00
settings.add_property_info(property_info)
[/gdscript]
[csharp]
var settings = GetEditorInterface().GetEditorSettings();
settings.Set("category/property_name", 0);
var propertyInfo = new Godot.Collections.Dictionary
{
{"name", "category/propertyName"},
{"type", Variant.Type.Int},
{"hint", PropertyHint.Enum},
{"hint_string", "one,two,three"}
};
settings.AddPropertyInfo(propertyInfo);
[/csharp]
[/codeblocks]
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Added ability to retrieve array of changed settings changed when it is saved.
2021-10-15 14:34:11 +02:00
<method name="check_changed_settings_in_group" qualifiers="const">
<return type="bool" />
<argument index="0" name="setting_prefix" type="String" />
<description>
Checks if any settings with the prefix [code]setting_prefix[/code] exist in the set of changed settings. See also [method get_changed_settings].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="erase">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="property" type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Erases the setting whose name is specified by [code]property[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Added ability to retrieve array of changed settings changed when it is saved.
2021-10-15 14:34:11 +02:00
<method name="get_changed_settings" qualifiers="const">
<return type="Array" />
<description>
Gets an array of the settings which have been changed since the last save. Note that internally [code]changed_settings[/code] is cleared after a successful save, so generally the most appropriate place to use this method is when processing [constant NOTIFICATION_EDITOR_SETTINGS_CHANGED]
</description>
</method>
Fixes favorites not updating and rename favorite_dirs to favorites
2018-09-18 14:02:59 +02:00
<method name="get_favorites" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedStringArray" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Returns the list of favorite files and directories for this project.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Exposed set/get_project_metadata in EditorSettings.
2018-05-16 17:23:20 +02:00
<method name="get_project_metadata" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="section" type="String" />
<argument index="1" name="key" type="String" />
<argument index="2" name="default" type="Variant" default="null" />
Exposed set/get_project_metadata in EditorSettings.
2018-05-16 17:23:20 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Returns project-specific metadata for the [code]section[/code] and [code]key[/code] specified. If the metadata doesn't exist, [code]default[/code] will be returned instead. See also [method set_project_metadata].
Exposed set/get_project_metadata in EditorSettings.
2018-05-16 17:23:20 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="get_recent_dirs" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="PackedStringArray" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Returns the list of recently visited folders in the file dialog for this project.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<method name="get_setting" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="name" type="String" />
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Returns the value of the setting specified by [code]name[/code]. This is equivalent to using [method Object.get] on the EditorSettings instance.
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
</description>
</method>
<method name="has_setting" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="name" type="String" />
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Returns [code]true[/code] if the setting specified by [code]name[/code] exists, [code]false[/code] otherwise.
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
</description>
</method>
Added ability to retrieve array of changed settings changed when it is saved.
2021-10-15 14:34:11 +02:00
<method name="mark_setting_changed">
<return type="void" />
<argument index="0" name="setting" type="String" />
<description>
Marks the passed editor setting as being changed, see [method get_changed_settings]. Only settings which exist (see [method has_setting]) will be accepted.
</description>
</method>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<method name="property_can_revert">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="name" type="String" />
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Returns [code]true[/code] if the setting specified by [code]name[/code] can have its value reverted to the default value, [code]false[/code] otherwise. When this method returns [code]true[/code], a Revert button will display next to the setting in the Editor Settings.
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
</description>
</method>
<method name="property_get_revert">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Variant" />
<argument index="0" name="name" type="String" />
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Returns the default value of the setting specified by [code]name[/code]. This is the value that would be applied when clicking the Revert button in the Editor Settings.
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
</description>
</method>
doc: Sync classref with current source And fix various bogus bindings following previous PRs.
2021-02-19 13:35:31 +01:00
<method name="set_builtin_action_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="name" type="String" />
<argument index="1" name="actions_list" type="Array" />
doc: Sync classref with current source And fix various bogus bindings following previous PRs.
2021-02-19 13:35:31 +01:00
<description>
</description>
</method>
Fixes favorites not updating and rename favorite_dirs to favorites
2018-09-18 14:02:59 +02:00
<method name="set_favorites">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="dirs" type="PackedStringArray" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets the list of favorite files and directories for this project.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<method name="set_initial_value">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="name" type="StringName" />
<argument index="1" name="value" type="Variant" />
<argument index="2" name="update_current" type="bool" />
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Sets the initial value of the setting specified by [code]name[/code] to [code]value[/code]. This is used to provide a value for the Revert button in the Editor Settings. If [code]update_current[/code] is true, the current value of the setting will be set to [code]value[/code] as well.
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
</description>
</method>
Exposed set/get_project_metadata in EditorSettings.
2018-05-16 17:23:20 +02:00
<method name="set_project_metadata">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="section" type="String" />
<argument index="1" name="key" type="String" />
<argument index="2" name="data" type="Variant" />
Exposed set/get_project_metadata in EditorSettings.
2018-05-16 17:23:20 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Sets project-specific metadata with the [code]section[/code], [code]key[/code] and [code]data[/code] specified. This metadata is stored outside the project folder and therefore won't be checked into version control. See also [method get_project_metadata].
Exposed set/get_project_metadata in EditorSettings.
2018-05-16 17:23:20 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="set_recent_dirs">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="dirs" type="PackedStringArray" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Sets the list of recently visited folders in the file dialog for this project.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<method name="set_setting">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="name" type="String" />
<argument index="1" name="value" type="Variant" />
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Sets the [code]value[/code] of the setting specified by [code]name[/code]. This is equivalent to using [method Object.set] on the EditorSettings instance.
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-11 23:54:43 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</methods>
Add support for documenting most editor settings in the class reference Settings defined in editor plugins are missing (about 100 of them), but all other settings (about 200 of them) can now be documented in the EditorSettings class. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2021-05-07 22:21:03 +02:00
<members>
<member name="debugger/profiler_frame_history_size" type="int" setter="" getter="">
</member>
<member name="docks/filesystem/always_show_folders" type="bool" setter="" getter="">
</member>
<member name="docks/filesystem/textfile_extensions" type="String" setter="" getter="">
</member>
<member name="docks/filesystem/thumbnail_size" type="int" setter="" getter="">
</member>
<member name="docks/property_editor/auto_refresh_interval" type="float" setter="" getter="">
</member>
<member name="docks/property_editor/subresource_hue_tint" type="float" setter="" getter="">
</member>
<member name="docks/scene_tree/auto_expand_to_selected" type="bool" setter="" getter="">
</member>
<member name="docks/scene_tree/start_create_dialog_fully_expanded" type="bool" setter="" getter="">
</member>
<member name="editors/2d/bone_color1" type="Color" setter="" getter="">
</member>
<member name="editors/2d/bone_color2" type="Color" setter="" getter="">
</member>
<member name="editors/2d/bone_ik_color" type="Color" setter="" getter="">
</member>
<member name="editors/2d/bone_outline_color" type="Color" setter="" getter="">
</member>
<member name="editors/2d/bone_outline_size" type="int" setter="" getter="">
</member>
<member name="editors/2d/bone_selected_color" type="Color" setter="" getter="">
</member>
<member name="editors/2d/bone_width" type="int" setter="" getter="">
</member>
<member name="editors/2d/constrain_editor_view" type="bool" setter="" getter="">
</member>
<member name="editors/2d/grid_color" type="Color" setter="" getter="">
</member>
<member name="editors/2d/guides_color" type="Color" setter="" getter="">
</member>
<member name="editors/2d/smart_snapping_line_color" type="Color" setter="" getter="">
</member>
<member name="editors/2d/viewport_border_color" type="Color" setter="" getter="">
</member>
<member name="editors/3d/default_fov" type="float" setter="" getter="">
</member>
<member name="editors/3d/default_z_far" type="float" setter="" getter="">
</member>
<member name="editors/3d/default_z_near" type="float" setter="" getter="">
</member>
<member name="editors/3d/freelook/freelook_activation_modifier" type="int" setter="" getter="">
</member>
<member name="editors/3d/freelook/freelook_base_speed" type="float" setter="" getter="">
</member>
<member name="editors/3d/freelook/freelook_inertia" type="float" setter="" getter="">
</member>
<member name="editors/3d/freelook/freelook_navigation_scheme" type="int" setter="" getter="">
</member>
<member name="editors/3d/freelook/freelook_sensitivity" type="float" setter="" getter="">
</member>
<member name="editors/3d/freelook/freelook_speed_zoom_link" type="bool" setter="" getter="">
</member>
<member name="editors/3d/grid_division_level_bias" type="float" setter="" getter="">
</member>
<member name="editors/3d/grid_division_level_max" type="int" setter="" getter="">
</member>
<member name="editors/3d/grid_division_level_min" type="int" setter="" getter="">
</member>
<member name="editors/3d/grid_size" type="int" setter="" getter="">
</member>
<member name="editors/3d/grid_xy_plane" type="bool" setter="" getter="">
</member>
<member name="editors/3d/grid_xz_plane" type="bool" setter="" getter="">
</member>
<member name="editors/3d/grid_yz_plane" type="bool" setter="" getter="">
</member>
<member name="editors/3d/navigation/emulate_3_button_mouse" type="bool" setter="" getter="">
</member>
<member name="editors/3d/navigation/emulate_numpad" type="bool" setter="" getter="">
</member>
<member name="editors/3d/navigation/invert_x_axis" type="bool" setter="" getter="">
</member>
<member name="editors/3d/navigation/invert_y_axis" type="bool" setter="" getter="">
</member>
<member name="editors/3d/navigation/navigation_scheme" type="int" setter="" getter="">
</member>
<member name="editors/3d/navigation/orbit_modifier" type="int" setter="" getter="">
</member>
<member name="editors/3d/navigation/pan_modifier" type="int" setter="" getter="">
</member>
<member name="editors/3d/navigation/warped_mouse_panning" type="bool" setter="" getter="">
</member>
<member name="editors/3d/navigation/zoom_modifier" type="int" setter="" getter="">
</member>
<member name="editors/3d/navigation/zoom_style" type="int" setter="" getter="">
</member>
<member name="editors/3d/navigation_feel/orbit_inertia" type="float" setter="" getter="">
</member>
<member name="editors/3d/navigation_feel/orbit_sensitivity" type="float" setter="" getter="">
</member>
<member name="editors/3d/navigation_feel/translation_inertia" type="float" setter="" getter="">
</member>
<member name="editors/3d/navigation_feel/zoom_inertia" type="float" setter="" getter="">
</member>
<member name="editors/3d/primary_grid_color" type="Color" setter="" getter="">
</member>
<member name="editors/3d/primary_grid_steps" type="int" setter="" getter="">
</member>
<member name="editors/3d/secondary_grid_color" type="Color" setter="" getter="">
</member>
<member name="editors/3d/selection_box_color" type="Color" setter="" getter="">
</member>
<member name="editors/3d_gizmos/gizmo_colors/instantiated" type="Color" setter="" getter="">
</member>
<member name="editors/3d_gizmos/gizmo_colors/joint" type="Color" setter="" getter="">
</member>
<member name="editors/3d_gizmos/gizmo_colors/shape" type="Color" setter="" getter="">
</member>
<member name="editors/animation/autorename_animation_tracks" type="bool" setter="" getter="">
</member>
<member name="editors/animation/confirm_insert_track" type="bool" setter="" getter="">
</member>
<member name="editors/animation/default_create_bezier_tracks" type="bool" setter="" getter="">
</member>
<member name="editors/animation/default_create_reset_tracks" type="bool" setter="" getter="">
</member>
<member name="editors/animation/onion_layers_future_color" type="Color" setter="" getter="">
</member>
<member name="editors/animation/onion_layers_past_color" type="Color" setter="" getter="">
</member>
<member name="editors/grid_map/pick_distance" type="float" setter="" getter="">
</member>
<member name="editors/panning/2d_editor_pan_speed" type="int" setter="" getter="">
</member>
<member name="editors/panning/2d_editor_panning_scheme" type="int" setter="" getter="">
</member>
<member name="editors/panning/animation_editors_panning_scheme" type="int" setter="" getter="">
</member>
<member name="editors/panning/simple_panning" type="bool" setter="" getter="">
</member>
<member name="editors/panning/sub_editors_panning_scheme" type="int" setter="" getter="">
</member>
<member name="editors/panning/warped_mouse_panning" type="bool" setter="" getter="">
</member>
<member name="editors/polygon_editor/point_grab_radius" type="int" setter="" getter="">
</member>
<member name="editors/polygon_editor/show_previous_outline" type="bool" setter="" getter="">
</member>
<member name="editors/tiles_editor/display_grid" type="bool" setter="" getter="">
</member>
<member name="editors/tiles_editor/grid_color" type="Color" setter="" getter="">
</member>
<member name="editors/visual_editors/lines_curvature" type="float" setter="" getter="">
</member>
<member name="editors/visual_editors/minimap_opacity" type="float" setter="" getter="">
</member>
<member name="editors/visual_editors/visualshader/port_preview_size" type="int" setter="" getter="">
</member>
<member name="filesystem/directories/autoscan_project_path" type="String" setter="" getter="">
</member>
<member name="filesystem/directories/default_project_path" type="String" setter="" getter="">
</member>
<member name="filesystem/file_dialog/display_mode" type="int" setter="" getter="">
</member>
<member name="filesystem/file_dialog/show_hidden_files" type="bool" setter="" getter="">
</member>
<member name="filesystem/file_dialog/thumbnail_size" type="int" setter="" getter="">
</member>
<member name="filesystem/on_save/compress_binary_resources" type="bool" setter="" getter="">
</member>
<member name="filesystem/on_save/safe_save_on_backup_then_rename" type="bool" setter="" getter="">
</member>
<member name="interface/editor/automatically_open_screenshots" type="bool" setter="" getter="">
</member>
<member name="interface/editor/code_font" type="String" setter="" getter="">
</member>
<member name="interface/editor/code_font_contextual_ligatures" type="int" setter="" getter="">
</member>
<member name="interface/editor/code_font_custom_opentype_features" type="String" setter="" getter="">
</member>
<member name="interface/editor/code_font_custom_variations" type="String" setter="" getter="">
</member>
<member name="interface/editor/code_font_size" type="int" setter="" getter="">
</member>
<member name="interface/editor/custom_display_scale" type="float" setter="" getter="">
</member>
<member name="interface/editor/debug/enable_pseudolocalization" type="bool" setter="" getter="">
</member>
<member name="interface/editor/display_scale" type="int" setter="" getter="">
</member>
<member name="interface/editor/editor_language" type="String" setter="" getter="">
</member>
<member name="interface/editor/font_antialiased" type="bool" setter="" getter="">
</member>
<member name="interface/editor/font_hinting" type="int" setter="" getter="">
</member>
<member name="interface/editor/font_subpixel_positioning" type="int" setter="" getter="">
</member>
<member name="interface/editor/low_processor_mode_sleep_usec" type="float" setter="" getter="">
</member>
<member name="interface/editor/main_font" type="String" setter="" getter="">
</member>
<member name="interface/editor/main_font_bold" type="String" setter="" getter="">
</member>
<member name="interface/editor/main_font_size" type="int" setter="" getter="">
</member>
<member name="interface/editor/mouse_extra_buttons_navigate_history" type="bool" setter="" getter="">
</member>
<member name="interface/editor/save_each_scene_on_quit" type="bool" setter="" getter="">
</member>
<member name="interface/editor/separate_distraction_mode" type="bool" setter="" getter="">
</member>
<member name="interface/editor/show_internal_errors_in_toast_notifications" type="int" setter="" getter="">
</member>
<member name="interface/editor/single_window_mode" type="bool" setter="" getter="">
</member>
<member name="interface/editor/unfocused_low_processor_mode_sleep_usec" type="float" setter="" getter="">
</member>
<member name="interface/inspector/max_array_dictionary_items_per_page" type="int" setter="" getter="">
</member>
<member name="interface/inspector/show_low_level_opentype_features" type="bool" setter="" getter="">
</member>
<member name="interface/scene_tabs/display_close_button" type="int" setter="" getter="">
</member>
<member name="interface/scene_tabs/maximum_width" type="int" setter="" getter="">
</member>
<member name="interface/scene_tabs/show_script_button" type="bool" setter="" getter="">
</member>
<member name="interface/scene_tabs/show_thumbnail_on_hover" type="bool" setter="" getter="">
</member>
<member name="interface/theme/accent_color" type="Color" setter="" getter="">
</member>
<member name="interface/theme/additional_spacing" type="float" setter="" getter="">
</member>
<member name="interface/theme/base_color" type="Color" setter="" getter="">
</member>
<member name="interface/theme/border_size" type="int" setter="" getter="">
</member>
<member name="interface/theme/contrast" type="float" setter="" getter="">
</member>
<member name="interface/theme/corner_radius" type="int" setter="" getter="">
</member>
<member name="interface/theme/custom_theme" type="String" setter="" getter="">
</member>
<member name="interface/theme/icon_and_font_color" type="int" setter="" getter="">
</member>
<member name="interface/theme/icon_saturation" type="float" setter="" getter="">
</member>
<member name="interface/theme/preset" type="String" setter="" getter="">
</member>
<member name="interface/theme/relationship_line_opacity" type="float" setter="" getter="">
</member>
<member name="network/debug/remote_host" type="String" setter="" getter="">
</member>
<member name="network/debug/remote_port" type="int" setter="" getter="">
</member>
<member name="network/http_proxy/host" type="String" setter="" getter="">
</member>
<member name="network/http_proxy/port" type="int" setter="" getter="">
</member>
<member name="network/ssl/editor_ssl_certificates" type="String" setter="" getter="">
</member>
<member name="project_manager/sorting_order" type="int" setter="" getter="">
</member>
<member name="run/auto_save/save_before_running" type="bool" setter="" getter="">
</member>
<member name="run/output/always_clear_output_on_play" type="bool" setter="" getter="">
</member>
<member name="run/output/always_close_output_on_stop" type="bool" setter="" getter="">
</member>
<member name="run/output/always_open_output_on_play" type="bool" setter="" getter="">
</member>
<member name="run/output/font_size" type="int" setter="" getter="">
</member>
<member name="run/window_placement/rect" type="int" setter="" getter="">
</member>
<member name="run/window_placement/rect_custom_position" type="Vector2" setter="" getter="">
</member>
<member name="run/window_placement/screen" type="int" setter="" getter="">
</member>
<member name="text_editor/appearance/caret/caret_blink" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/caret/caret_blink_speed" type="float" setter="" getter="">
</member>
<member name="text_editor/appearance/caret/highlight_all_occurrences" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/caret/highlight_current_line" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/caret/type" type="int" setter="" getter="">
</member>
<member name="text_editor/appearance/guidelines/line_length_guideline_hard_column" type="int" setter="" getter="">
</member>
<member name="text_editor/appearance/guidelines/line_length_guideline_soft_column" type="int" setter="" getter="">
</member>
<member name="text_editor/appearance/guidelines/show_line_length_guidelines" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/gutters/highlight_type_safe_lines" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/gutters/line_numbers_zero_padded" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/gutters/show_bookmark_gutter" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/gutters/show_info_gutter" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/gutters/show_line_numbers" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/lines/code_folding" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/lines/word_wrap" type="int" setter="" getter="">
</member>
<member name="text_editor/appearance/minimap/minimap_width" type="int" setter="" getter="">
</member>
<member name="text_editor/appearance/minimap/show_minimap" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/whitespace/draw_spaces" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/whitespace/draw_tabs" type="bool" setter="" getter="">
</member>
<member name="text_editor/appearance/whitespace/line_spacing" type="int" setter="" getter="">
</member>
<member name="text_editor/behavior/files/auto_reload_scripts_on_external_change" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/files/autosave_interval_secs" type="int" setter="" getter="">
</member>
<member name="text_editor/behavior/files/convert_indent_on_save" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/files/restore_scripts_on_load" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/files/trim_trailing_whitespace_on_save" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/indent/auto_indent" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/indent/size" type="int" setter="" getter="">
</member>
<member name="text_editor/behavior/indent/type" type="int" setter="" getter="">
</member>
<member name="text_editor/behavior/navigation/drag_and_drop_selection" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/navigation/move_caret_on_right_click" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/navigation/scroll_past_end_of_file" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/navigation/smooth_scrolling" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/navigation/stay_in_script_editor_on_node_selected" type="bool" setter="" getter="">
</member>
<member name="text_editor/behavior/navigation/v_scroll_speed" type="int" setter="" getter="">
</member>
<member name="text_editor/completion/add_type_hints" type="bool" setter="" getter="">
</member>
<member name="text_editor/completion/auto_brace_complete" type="bool" setter="" getter="">
</member>
<member name="text_editor/completion/code_complete_delay" type="float" setter="" getter="">
</member>
<member name="text_editor/completion/complete_file_paths" type="bool" setter="" getter="">
</member>
<member name="text_editor/completion/idle_parse_delay" type="float" setter="" getter="">
</member>
<member name="text_editor/completion/put_callhint_tooltip_below_current_line" type="bool" setter="" getter="">
</member>
<member name="text_editor/completion/use_single_quotes" type="bool" setter="" getter="">
</member>
<member name="text_editor/help/class_reference_examples" type="int" setter="" getter="">
</member>
<member name="text_editor/help/help_font_size" type="int" setter="" getter="">
</member>
<member name="text_editor/help/help_source_font_size" type="int" setter="" getter="">
</member>
<member name="text_editor/help/help_title_font_size" type="int" setter="" getter="">
</member>
<member name="text_editor/help/show_help_index" type="bool" setter="" getter="">
</member>
<member name="text_editor/script_list/show_members_overview" type="bool" setter="" getter="">
</member>
<member name="text_editor/script_list/sort_members_outline_alphabetically" type="bool" setter="" getter="">
</member>
<member name="text_editor/theme/color_theme" type="String" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/background_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/base_type_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/bookmark_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/brace_mismatch_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/breakpoint_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/caret_background_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/caret_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/code_folding_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/comment_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/completion_background_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/completion_existing_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/completion_font_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/completion_scroll_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/completion_scroll_hovered_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/completion_selected_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/control_flow_keyword_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/current_line_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/engine_type_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/executing_line_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/function_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/keyword_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/line_length_guideline_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/line_number_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/mark_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/member_variable_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/number_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/safe_line_number_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/search_result_border_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/search_result_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/selection_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/string_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/symbol_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/text_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/text_selected_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/user_type_color" type="Color" setter="" getter="">
</member>
<member name="text_editor/theme/highlighting/word_highlighted_color" type="Color" setter="" getter="">
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<signals>
<signal name="settings_changed">
<description>
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Emitted after any editor setting has changed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</signal>
</signals>
<constants>
doc: Sync classref with current source
2019-07-05 10:28:59 +02:00
<constant name="NOTIFICATION_EDITOR_SETTINGS_CHANGED" value="10000">
Complete the EditorSettings class documentation EditorSettings is now 100% documented.
2020-07-17 11:34:18 +02:00
Emitted after any editor setting has changed. It's used by various editor plugins to update their visuals on theme changes or logic on configuration changes.
doc: Sync classref with current source
2019-07-05 10:28:59 +02:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</constants>
</class>
Reference in a new issue Copy permalink