diff options
Diffstat (limited to 'doc/classes/EditorSettings.xml')
| -rw-r--r-- | doc/classes/EditorSettings.xml | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 9d48669a6b..5395a8fcb0 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="EditorSettings" inherits="Resource" category="Core" version="3.1"> +<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 Editor Settings menu. + Object that holds the project-independent editor settings. These settings are generally visible in the [b]Editor > Editor Settings[/b] menu. Accessing the settings is done by using the regular [Object] API, such as: [codeblock] settings.set(prop,value) @@ -14,8 +14,6 @@ </description> <tutorials> </tutorials> - <demos> - </demos> <methods> <method name="add_property_info"> <return type="void"> @@ -23,8 +21,8 @@ <argument index="0" name="info" type="Dictionary"> </argument> <description> - Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String]. - Example: + Adds a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see [code]TYPE_*[/code] in [@GlobalScope]), and optionally hint:[int](see [code]PROPERTY_HINT_*[/code] in [@GlobalScope]), hint_string:[String]. + [b]Example:[/b] [codeblock] editor_settings.set("category/property_name", 0) @@ -52,7 +50,7 @@ <return type="PoolStringArray"> </return> <description> - Get the list of favorite files and directories for this project. + Gets the list of favorite files and directories for this project. </description> </method> <method name="get_project_metadata" qualifiers="const"> @@ -71,14 +69,14 @@ <return type="String"> </return> <description> - Get the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved. + 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> - Get the list of recently visited folders in the file dialog for this project. + Gets the list of recently visited folders in the file dialog for this project. </description> </method> <method name="get_setting" qualifiers="const"> @@ -93,9 +91,9 @@ <return type="String"> </return> <description> - Get the global settings path for the engine. Inside this path you can find some standard paths such as: - settings/tmp - used for temporary storage of files - settings/templates - where export templates are located + 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"> @@ -128,7 +126,7 @@ <argument index="0" name="dirs" type="PoolStringArray"> </argument> <description> - Set the list of favorite files and directories for this project. + Sets the list of favorite files and directories for this project. </description> </method> <method name="set_initial_value"> @@ -161,7 +159,7 @@ <argument index="0" name="dirs" type="PoolStringArray"> </argument> <description> - Set the list of recently visited folders in the file dialog for this project. + Sets the list of recently visited folders in the file dialog for this project. </description> </method> <method name="set_setting"> @@ -178,9 +176,13 @@ <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> |