diff options
Diffstat (limited to 'doc/classes/ProjectSettings.xml')
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 246 |
1 files changed, 178 insertions, 68 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index c3ef9f2425..383049fb3e 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -16,10 +16,8 @@ </tutorials> <methods> <method name="add_property_info"> - <return type="void"> - </return> - <argument index="0" name="hint" type="Dictionary"> - </argument> + <return type="void" /> + <argument index="0" name="hint" type="Dictionary" /> <description> Adds a custom property info to a property. The dictionary must contain: - [code]name[/code]: [String] (the property's name) @@ -56,28 +54,22 @@ </description> </method> <method name="clear"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> + <return type="void" /> + <argument index="0" name="name" type="String" /> <description> Clears the whole configuration (not recommended, may break things). </description> </method> <method name="get_order" qualifiers="const"> - <return type="int"> - </return> - <argument index="0" name="name" type="String"> - </argument> + <return type="int" /> + <argument index="0" name="name" type="String" /> <description> Returns the order of a configuration value (influences when saved to the config file). </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 a setting. [b]Example:[/b] @@ -92,10 +84,8 @@ </description> </method> <method name="globalize_path" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="path" type="String"> - </argument> + <return type="String" /> + <argument index="0" name="path" type="String" /> <description> Returns the absolute, native OS path corresponding to the localized [code]path[/code] (starting with [code]res://[/code] or [code]user://[/code]). The returned path will vary depending on the operating system and user preferences. See [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]File paths in Godot projects[/url] to see what those paths convert to. See also [method localize_path]. [b]Note:[/b] [method globalize_path] with [code]res://[/code] will not work in an exported project. Instead, prepend the executable's base directory to the path when running from an exported project: @@ -115,23 +105,17 @@ </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 a configuration value is present. </description> </method> <method name="load_resource_pack"> - <return type="bool"> - </return> - <argument index="0" name="pack" type="String"> - </argument> - <argument index="1" name="replace_files" type="bool" default="true"> - </argument> - <argument index="2" name="offset" type="int" default="0"> - </argument> + <return type="bool" /> + <argument index="0" name="pack" type="String" /> + <argument index="1" name="replace_files" type="bool" default="true" /> + <argument index="2" name="offset" type="int" default="0" /> <description> Loads the contents of the .pck or .zip file specified by [code]pack[/code] into the resource filesystem ([code]res://[/code]). Returns [code]true[/code] on success. [b]Note:[/b] If a file from [code]pack[/code] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [code]pack[/code] unless [code]replace_files[/code] is set to [code]false[/code]. @@ -139,78 +123,60 @@ </description> </method> <method name="localize_path" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="path" type="String"> - </argument> + <return type="String" /> + <argument index="0" name="path" type="String" /> <description> Returns the localized path (starting with [code]res://[/code]) corresponding to the absolute, native OS [code]path[/code]. See also [method globalize_path]. </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 specified property exists and its initial value differs from the current value. </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 specified property's initial value. Returns [code]null[/code] if the property does not exist. </description> </method> <method name="save"> - <return type="int" enum="Error"> - </return> + <return type="int" enum="Error" /> <description> Saves the configuration to the [code]project.godot[/code] file. [b]Note:[/b] This method is intended to be used by editor plugins, as modified [ProjectSettings] can't be loaded back in the running app. If you want to change project settings in exported projects, use [method save_custom] to save [code]override.cfg[/code] file. </description> </method> <method name="save_custom"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="file" type="String"> - </argument> + <return type="int" enum="Error" /> + <argument index="0" name="file" type="String" /> <description> Saves the configuration to a custom file. The file extension must be [code].godot[/code] (to save in text-based [ConfigFile] format) or [code].binary[/code] (to save in binary format). You can also save [code]override.cfg[/code] file, which is also text, but can be used in exported projects unlike other formats. </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> + <return type="void" /> + <argument index="0" name="name" type="String" /> + <argument index="1" name="value" type="Variant" /> <description> Sets the specified property's initial value. This is the value the property reverts to. </description> </method> <method name="set_order"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <argument index="1" name="position" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="name" type="String" /> + <argument index="1" name="position" type="int" /> <description> Sets the order of a configuration value (influences when saved to the config file). </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 value of a setting. [b]Example:[/b] @@ -820,9 +786,45 @@ <member name="layer_names/2d_navigation/layer_2" type="String" setter="" getter="" default=""""> Optional name for the 2D navigation layer 2. If left empty, the layer will display as "Layer 2". </member> + <member name="layer_names/2d_navigation/layer_20" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 20. If left empty, the layer will display as "Layer 20". + </member> + <member name="layer_names/2d_navigation/layer_21" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 21. If left empty, the layer will display as "Layer 21". + </member> + <member name="layer_names/2d_navigation/layer_22" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 22. If left empty, the layer will display as "Layer 22". + </member> + <member name="layer_names/2d_navigation/layer_23" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 23. If left empty, the layer will display as "Layer 23". + </member> + <member name="layer_names/2d_navigation/layer_24" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 24. If left empty, the layer will display as "Layer 24". + </member> + <member name="layer_names/2d_navigation/layer_25" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 25. If left empty, the layer will display as "Layer 25". + </member> + <member name="layer_names/2d_navigation/layer_26" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 26. If left empty, the layer will display as "Layer 26". + </member> + <member name="layer_names/2d_navigation/layer_27" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 27. If left empty, the layer will display as "Layer 27". + </member> + <member name="layer_names/2d_navigation/layer_28" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 28. If left empty, the layer will display as "Layer 28". + </member> + <member name="layer_names/2d_navigation/layer_29" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 29. If left empty, the layer will display as "Layer 29". + </member> <member name="layer_names/2d_navigation/layer_3" type="String" setter="" getter="" default=""""> Optional name for the 2D navigation layer 3. If left empty, the layer will display as "Layer 3". </member> + <member name="layer_names/2d_navigation/layer_30" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 30. If left empty, the layer will display as "Layer 30". + </member> + <member name="layer_names/2d_navigation/layer_31" type="String" setter="" getter="" default=""""> + Optional name for the 2D navigation layer 31. If left empty, the layer will display as "Layer 31". + </member> <member name="layer_names/2d_navigation/layer_4" type="String" setter="" getter="" default=""""> Optional name for the 2D navigation layer 4. If left empty, the layer will display as "Layer 4". </member> @@ -880,9 +882,45 @@ <member name="layer_names/2d_physics/layer_2" type="String" setter="" getter="" default=""""> Optional name for the 2D physics layer 2. If left empty, the layer will display as "Layer 2". </member> + <member name="layer_names/2d_physics/layer_20" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 20. If left empty, the layer will display as "Layer 20". + </member> + <member name="layer_names/2d_physics/layer_21" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 21. If left empty, the layer will display as "Layer 21". + </member> + <member name="layer_names/2d_physics/layer_22" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 22. If left empty, the layer will display as "Layer 22". + </member> + <member name="layer_names/2d_physics/layer_23" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 23. If left empty, the layer will display as "Layer 23". + </member> + <member name="layer_names/2d_physics/layer_24" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 24. If left empty, the layer will display as "Layer 24". + </member> + <member name="layer_names/2d_physics/layer_25" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 25. If left empty, the layer will display as "Layer 25". + </member> + <member name="layer_names/2d_physics/layer_26" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 26. If left empty, the layer will display as "Layer 26". + </member> + <member name="layer_names/2d_physics/layer_27" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 27. If left empty, the layer will display as "Layer 27". + </member> + <member name="layer_names/2d_physics/layer_28" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 28. If left empty, the layer will display as "Layer 28". + </member> + <member name="layer_names/2d_physics/layer_29" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 29. If left empty, the layer will display as "Layer 29". + </member> <member name="layer_names/2d_physics/layer_3" type="String" setter="" getter="" default=""""> Optional name for the 2D physics layer 3. If left empty, the layer will display as "Layer 3". </member> + <member name="layer_names/2d_physics/layer_30" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 30. If left empty, the layer will display as "Layer 30". + </member> + <member name="layer_names/2d_physics/layer_31" type="String" setter="" getter="" default=""""> + Optional name for the 2D physics layer 31. If left empty, the layer will display as "Layer 31". + </member> <member name="layer_names/2d_physics/layer_4" type="String" setter="" getter="" default=""""> Optional name for the 2D physics layer 4. If left empty, the layer will display as "Layer 4". </member> @@ -1000,9 +1038,45 @@ <member name="layer_names/3d_navigation/layer_2" type="String" setter="" getter="" default=""""> Optional name for the 3D navigation layer 2. If left empty, the layer will display as "Layer 2". </member> + <member name="layer_names/3d_navigation/layer_20" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 20. If left empty, the layer will display as "Layer 20". + </member> + <member name="layer_names/3d_navigation/layer_21" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 21. If left empty, the layer will display as "Layer 21". + </member> + <member name="layer_names/3d_navigation/layer_22" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 22. If left empty, the layer will display as "Layer 22". + </member> + <member name="layer_names/3d_navigation/layer_23" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 23. If left empty, the layer will display as "Layer 23". + </member> + <member name="layer_names/3d_navigation/layer_24" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 24. If left empty, the layer will display as "Layer 24". + </member> + <member name="layer_names/3d_navigation/layer_25" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 25. If left empty, the layer will display as "Layer 25". + </member> + <member name="layer_names/3d_navigation/layer_26" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 26. If left empty, the layer will display as "Layer 26". + </member> + <member name="layer_names/3d_navigation/layer_27" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 27. If left empty, the layer will display as "Layer 27". + </member> + <member name="layer_names/3d_navigation/layer_28" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 28. If left empty, the layer will display as "Layer 28". + </member> + <member name="layer_names/3d_navigation/layer_29" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 29. If left empty, the layer will display as "Layer 29". + </member> <member name="layer_names/3d_navigation/layer_3" type="String" setter="" getter="" default=""""> Optional name for the 3D navigation layer 3. If left empty, the layer will display as "Layer 3". </member> + <member name="layer_names/3d_navigation/layer_30" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 30. If left empty, the layer will display as "Layer 30". + </member> + <member name="layer_names/3d_navigation/layer_31" type="String" setter="" getter="" default=""""> + Optional name for the 3D navigation layer 31. If left empty, the layer will display as "Layer 31". + </member> <member name="layer_names/3d_navigation/layer_4" type="String" setter="" getter="" default=""""> Optional name for the 3D navigation layer 4. If left empty, the layer will display as "Layer 4". </member> @@ -1060,9 +1134,45 @@ <member name="layer_names/3d_physics/layer_2" type="String" setter="" getter="" default=""""> Optional name for the 3D physics layer 2. If left empty, the layer will display as "Layer 2". </member> + <member name="layer_names/3d_physics/layer_20" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 20. If left empty, the layer will display as "Layer 20". + </member> + <member name="layer_names/3d_physics/layer_21" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 21. If left empty, the layer will display as "Layer 21". + </member> + <member name="layer_names/3d_physics/layer_22" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 22. If left empty, the layer will display as "Layer 22". + </member> + <member name="layer_names/3d_physics/layer_23" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 23. If left empty, the layer will display as "Layer 23". + </member> + <member name="layer_names/3d_physics/layer_24" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 24. If left empty, the layer will display as "Layer 24". + </member> + <member name="layer_names/3d_physics/layer_25" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 25. If left empty, the layer will display as "Layer 25". + </member> + <member name="layer_names/3d_physics/layer_26" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 26. If left empty, the layer will display as "Layer 26". + </member> + <member name="layer_names/3d_physics/layer_27" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 27. If left empty, the layer will display as "Layer 27". + </member> + <member name="layer_names/3d_physics/layer_28" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 28. If left empty, the layer will display as "Layer 28". + </member> + <member name="layer_names/3d_physics/layer_29" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 29. If left empty, the layer will display as "Layer 29". + </member> <member name="layer_names/3d_physics/layer_3" type="String" setter="" getter="" default=""""> Optional name for the 3D physics layer 3. If left empty, the layer will display as "Layer 3". </member> + <member name="layer_names/3d_physics/layer_30" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 30. If left empty, the layer will display as "Layer 30". + </member> + <member name="layer_names/3d_physics/layer_31" type="String" setter="" getter="" default=""""> + Optional name for the 3D physics layer 31. If left empty, the layer will display as "Layer 31". + </member> <member name="layer_names/3d_physics/layer_4" type="String" setter="" getter="" default=""""> Optional name for the 3D physics layer 4. If left empty, the layer will display as "Layer 4". </member> |