godot/doc/classes/EditorSettings.xml
2019-12-06 23:09:20 +01:00

192 lines
5.7 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorSettings" inherits="Resource" category="Core" version="3.2">
<brief_description>
Object that holds the project-independent editor settings.
</brief_description>
<description>
Object that holds the project-independent editor settings. These settings are generally visible in the [b]Editor &gt; Editor Settings[/b] menu.
Accessing the settings is done by using the regular [Object] API, such as:
[codeblock]
settings.set(prop,value)
settings.get(prop)
list_of_settings = settings.get_property_list()
[/codeblock]
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_property_info">
<return type="void">
</return>
<argument index="0" name="info" type="Dictionary">
</argument>
<description>
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]
[b]Example:[/b]
[codeblock]
editor_settings.set("category/property_name", 0)
var property_info = {
"name": "category/property_name",
"type": TYPE_INT,
"hint": PROPERTY_HINT_ENUM,
"hint_string": "one,two,three"
}
editor_settings.add_property_info(property_info)
[/codeblock]
</description>
</method>
<method name="erase">
<return type="void">
</return>
<argument index="0" name="property" type="String">
</argument>
<description>
Erase a given setting (pass full property path).
</description>
</method>
<method name="get_favorites" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
Gets 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>
<description>
</description>
</method>
<method name="get_project_settings_dir" qualifiers="const">
<return type="String">
</return>
<description>
Gets the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved.
</description>
</method>
<method name="get_recent_dirs" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
Gets 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>
<description>
</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>
<description>
</description>
</method>
<method name="property_can_revert">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="property_get_revert">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set_favorites">
<return type="void">
</return>
<argument index="0" name="dirs" type="PoolStringArray">
</argument>
<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="String">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<argument index="2" name="update_current" type="bool">
</argument>
<description>
</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>
<description>
</description>
</method>
<method name="set_recent_dirs">
<return type="void">
</return>
<argument index="0" name="dirs" type="PoolStringArray">
</argument>
<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>
<description>
</description>
</method>
</methods>
<signals>
<signal name="settings_changed">
<description>
Emitted when editor settings change.
</description>
</signal>
</signals>
<constants>
<constant name="NOTIFICATION_EDITOR_SETTINGS_CHANGED" value="10000">
Emitted when editor settings change. It used by various editor plugins to update their visuals on theme changes or logic on configuration changes.
</constant>
</constants>
</class>