summaryrefslogtreecommitdiff
path: root/doc/classes/EditorSettings.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/EditorSettings.xml')
-rw-r--r--doc/classes/EditorSettings.xml120
1 files changed, 37 insertions, 83 deletions
diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml
index 016d0128eb..ad63abafa6 100644
--- a/doc/classes/EditorSettings.xml
+++ b/doc/classes/EditorSettings.xml
@@ -31,10 +31,8 @@
</tutorials>
<methods>
<method name="add_property_info">
- <return type="void">
- </return>
- <argument index="0" name="info" type="Dictionary">
- </argument>
+ <return type="void" />
+ <argument index="0" name="info" type="Dictionary" />
<description>
Adds a custom property info to a property. The dictionary must contain:
- [code]name[/code]: [String] (the name of the property)
@@ -73,154 +71,110 @@
</description>
</method>
<method name="erase">
- <return type="void">
- </return>
- <argument index="0" name="property" type="String">
- </argument>
+ <return type="void" />
+ <argument index="0" name="property" type="String" />
<description>
Erases the setting whose name is specified by [code]property[/code].
</description>
</method>
<method name="get_favorites" qualifiers="const">
- <return type="PackedStringArray">
- </return>
+ <return type="PackedStringArray" />
<description>
Returns the list of favorite files and directories for this project.
</description>
</method>
<method name="get_project_metadata" qualifiers="const">
- <return type="Variant">
- </return>
- <argument index="0" name="section" type="String">
- </argument>
- <argument index="1" name="key" type="String">
- </argument>
- <argument index="2" name="default" type="Variant" default="null">
- </argument>
+ <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" />
<description>
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].
</description>
</method>
<method name="get_project_settings_dir" qualifiers="const">
- <return type="String">
- </return>
+ <return type="String" />
<description>
Returns the project-specific settings path. Projects all have a unique subdirectory inside the settings path where project-specific settings are saved.
</description>
</method>
<method name="get_recent_dirs" qualifiers="const">
- <return type="PackedStringArray">
- </return>
+ <return type="PackedStringArray" />
<description>
Returns the list of recently visited folders in the file dialog for this project.
</description>
</method>
<method name="get_setting" qualifiers="const">
- <return type="Variant">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
+ <return type="Variant" />
+ <argument index="0" name="name" type="String" />
<description>
Returns the value of the setting specified by [code]name[/code]. This is equivalent to using [method Object.get] on the EditorSettings instance.
</description>
</method>
- <method name="get_settings_dir" qualifiers="const">
- <return type="String">
- </return>
- <description>
- Gets the global settings path for the engine. Inside this path, you can find some standard paths such as:
- [code]settings/tmp[/code] - Used for temporary storage of files
- [code]settings/templates[/code] - Where export templates are located
- </description>
- </method>
<method name="has_setting" qualifiers="const">
- <return type="bool">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="name" type="String" />
<description>
Returns [code]true[/code] if the setting specified by [code]name[/code] exists, [code]false[/code] otherwise.
</description>
</method>
<method name="property_can_revert">
- <return type="bool">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
+ <return type="bool" />
+ <argument index="0" name="name" type="String" />
<description>
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.
</description>
</method>
<method name="property_get_revert">
- <return type="Variant">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
+ <return type="Variant" />
+ <argument index="0" name="name" type="String" />
<description>
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.
</description>
</method>
<method name="set_builtin_action_override">
- <return type="void">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
- <argument index="1" name="actions_list" type="Array">
- </argument>
+ <return type="void" />
+ <argument index="0" name="name" type="String" />
+ <argument index="1" name="actions_list" type="Array" />
<description>
</description>
</method>
<method name="set_favorites">
- <return type="void">
- </return>
- <argument index="0" name="dirs" type="PackedStringArray">
- </argument>
+ <return type="void" />
+ <argument index="0" name="dirs" type="PackedStringArray" />
<description>
Sets the list of favorite files and directories for this project.
</description>
</method>
<method name="set_initial_value">
- <return type="void">
- </return>
- <argument index="0" name="name" type="StringName">
- </argument>
- <argument index="1" name="value" type="Variant">
- </argument>
- <argument index="2" name="update_current" type="bool">
- </argument>
+ <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" />
<description>
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.
</description>
</method>
<method name="set_project_metadata">
- <return type="void">
- </return>
- <argument index="0" name="section" type="String">
- </argument>
- <argument index="1" name="key" type="String">
- </argument>
- <argument index="2" name="data" type="Variant">
- </argument>
+ <return type="void" />
+ <argument index="0" name="section" type="String" />
+ <argument index="1" name="key" type="String" />
+ <argument index="2" name="data" type="Variant" />
<description>
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].
</description>
</method>
<method name="set_recent_dirs">
- <return type="void">
- </return>
- <argument index="0" name="dirs" type="PackedStringArray">
- </argument>
+ <return type="void" />
+ <argument index="0" name="dirs" type="PackedStringArray" />
<description>
Sets the list of recently visited folders in the file dialog for this project.
</description>
</method>
<method name="set_setting">
- <return type="void">
- </return>
- <argument index="0" name="name" type="String">
- </argument>
- <argument index="1" name="value" type="Variant">
- </argument>
+ <return type="void" />
+ <argument index="0" name="name" type="String" />
+ <argument index="1" name="value" type="Variant" />
<description>
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.
</description>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-13 19:59:24 +0000