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

1211 lines
86 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" ?>
Update docs to version 4.0
2020-02-01 02:03:48 +01:00
<class name="ProjectSettings" inherits="Object" version="4.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
<brief_description>
Contains global variables accessible from everywhere.
</brief_description>
<description>
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Contains global variables accessible from everywhere. Use [method get_setting], [method set_setting] or [method has_setting] to access them. Variables stored in [code]project.godot[/code] are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options.
Improve documentation of ProjectSettings class
2019-09-27 08:32:35 +02:00
When naming a Project Settings property, use the full path to the setting including the category. For example, [code]"application/config/name"[/code] for the project name. Category and property names can be viewed in the Project Settings dialog.
Document `override.cfg` behavior in the ProjectSettings class
2019-10-25 21:48:35 +02:00
[b]Overriding:[/b] Any project setting can be overridden by creating a file named [code]override.cfg[/code] in the project's root directory. This can also be used in exported projects by placing this file in the same directory as the project binary.
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">
<return type="void">
</return>
<argument index="0" name="hint" type="Dictionary">
</argument>
<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 property's name)
- [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]
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
[codeblock]
ProjectSettings.set("category/property_name", 0)
var property_info = {
"name": "category/property_name",
"type": TYPE_INT,
"hint": PROPERTY_HINT_ENUM,
"hint_string": "one,two,three"
}
ProjectSettings.add_property_info(property_info)
[/codeblock]
</description>
</method>
<method name="clear">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Clears the whole configuration (not recommended, may break things).
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>
<method name="get_order" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Returns the order of a configuration value (influences when saved to the config file).
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">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Improve documentation of ProjectSettings class
2019-09-27 08:32:35 +02:00
Returns the value of a setting.
[b]Example:[/b]
[codeblock]
print(ProjectSettings.get_setting("application/config/name"))
[/codeblock]
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
<method name="globalize_path" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Converts a localized path ([code]res://[/code]) to a full native OS path.
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="has_setting" qualifiers="const">
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
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Returns [code]true[/code] if a configuration value is present.
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>
<method name="load_resource_pack">
<return type="bool">
</return>
<argument index="0" name="pack" type="String">
</argument>
Add flag to control the replacement of files by ProjectSettings.load_resource_pack
2019-09-23 22:41:25 +02:00
<argument index="1" name="replace_files" type="bool" default="true">
</argument>
added load resource pack with offset feature updated variables to use size_t removed line break to make code style more consistent added conditional check to return an error if offset field is used when loading a ZIP package fixed typo formatted file added commit regarding self contained exe files handled error loging for load zip file with offset spelling tweak updated conditional statement for magic check udpated error message when load Zip file with offset is called fix CI Trying to fix CI fix CI done Added error message for loading self-contained exe with offset. Updated documentation. Fix indent final fix indent Updated documentation. fix indents Updated doc based on suggestion Final fix fixed format
2020-07-13 18:22:06 +02:00
<argument index="2" name="offset" type="int" default="0">
</argument>
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>
Revert "Made possible to specify where to dump the contents when loading a ".pck" file" This reverts commit 3c261e0dfa19d9c661ad6ca908a3b8ccee050016. This was not so useful as is due to the way dependency paths are stored in scenes and resources.
2020-04-20 10:56:27 +02:00
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.
Add flag to control the replacement of files by ProjectSettings.load_resource_pack
2019-09-23 22:41:25 +02:00
[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].
added load resource pack with offset feature updated variables to use size_t removed line break to make code style more consistent added conditional check to return an error if offset field is used when loading a ZIP package fixed typo formatted file added commit regarding self contained exe files handled error loging for load zip file with offset spelling tweak updated conditional statement for magic check udpated error message when load Zip file with offset is called fix CI Trying to fix CI fix CI done Added error message for loading self-contained exe with offset. Updated documentation. Fix indent final fix indent Updated documentation. fix indents Updated doc based on suggestion Final fix fixed format
2020-07-13 18:22:06 +02:00
[b]Note:[/b] The optional [code]offset[/code] parameter can be used to specify the offset in bytes to the start of the resource pack. This is only supported for .pck files.
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>
<method name="localize_path" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Convert a path to a localized path ([code]res://[/code] path).
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>
<method name="property_can_revert">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Consistently wrap booleans in [code]
2019-04-17 13:42:56 +02:00
Returns [code]true[/code] if the specified property exists and its initial value differs from the current value.
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>
<method name="property_get_revert">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Returns the specified property's initial value. Returns [code]null[/code] if the property does not exist.
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>
<method name="save">
<return type="int" enum="Error">
</return>
<description>
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Saves the configuration to the [code]project.godot[/code] file.
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>
<method name="save_custom">
<return type="int" enum="Error">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
Fix ProjectSettings.save_custom documentation
2020-05-24 14:58:17 +02:00
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).
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>
<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>
<description>
Add descriptions to set_initial_value and set_setting.
2019-10-31 07:39:24 +01:00
Sets the specified property's initial value. This is the value the property reverts to.
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>
<method name="set_order">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 15:37:49 +02:00
<argument index="1" name="position" type="int">
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
</argument>
<description>
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Sets the order of a configuration value (influences when saved to the config file).
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">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<description>
Add descriptions to set_initial_value and set_setting.
2019-10-31 07:39:24 +01:00
Sets the value of a setting.
[b]Example:[/b]
[codeblock]
ProjectSettings.set_setting("application/config/name", "Example")
[/codeblock]
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>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
<members>
TreeItem: Rename new button disable method to set_button_disabled Follow-up to #30408. Also sync classref with current source.
2019-07-09 09:13:00 +02:00
<member name="application/boot_splash/bg_color" type="Color" setter="" getter="" default="Color( 0.14, 0.14, 0.14, 1 )">
Define android/modules globally so it appears in Project Settings Until now people had to add it manually to project.godot to load custom modules.
2019-03-07 10:40:44 +01:00
Background color for the boot splash.
doc: Sync classref with current source
2018-09-15 03:13:47 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/boot_splash/fullsize" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], scale the boot splash image to the full window length when engine starts. If [code]false[/code], the engine will leave it at the default pixel size.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/boot_splash/image" type="String" setter="" getter="" default="&quot;&quot;">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Path to an image used as the boot splash.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/boot_splash/use_filter" type="bool" setter="" getter="" default="true">
doc: Sync classref with current source, fix formatting issues
2019-06-16 11:22:38 +02:00
If [code]true[/code], applies linear filtering when scaling the image (recommended for high resolution artwork). If [code]false[/code], uses nearest-neighbor interpolation (recommended for pixel art).
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/config/custom_user_dir_name" type="String" setter="" getter="" default="&quot;&quot;">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
This user directory is used for storing persistent data ([code]user://[/code] filesystem). If left empty, [code]user://[/code] resolves to a project-specific folder in Godot's own configuration folder (see [method OS.get_user_data_dir]). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]).
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 11:46:26 +01:00
The [member application/config/use_custom_user_dir] setting must be enabled for this to take effect.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add a project description setting The description is displayed as a tooltip when hovering the project in the Project Manager. It can span multiple lines. This partially addresses #8167.
2019-08-17 18:20:17 +02:00
<member name="application/config/description" type="String" setter="" getter="" default="&quot;&quot;">
The project's description, displayed as a tooltip in the Project Manager when hovering the project.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/config/icon" type="String" setter="" getter="" default="&quot;&quot;">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Icon used for the project, set when project loads. Exporters will also use this icon when possible.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/config/macos_native_icon" type="String" setter="" getter="" default="&quot;&quot;">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
Icon set in [code].icns[/code] format used on macOS to set the game's icon. This is done automatically on start by calling [method DisplayServer.set_native_icon].
doc: Sync classref with current source
2019-05-28 18:08:13 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/config/name" type="String" setter="" getter="" default="&quot;&quot;">
Document how renaming the project affects the user data path
2020-09-01 19:18:45 +02:00
The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. The window title will be set to match the project name automatically on startup.
[b]Note:[/b] Changing this value will also change the user data folder's path if [member application/config/use_custom_user_dir] is [code]false[/code]. After renaming the project, you will no longer be able to access existing data in [code]user://[/code] unless you rename the old folder to match the new project name. See [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]Data paths[/url] in the documentation for more information.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/config/project_settings_override" type="String" setter="" getter="" default="&quot;&quot;">
doc: Sync classref with current source
2018-12-15 01:39:02 +01:00
Specifies a file to override project settings. For example: [code]user://custom_settings.cfg[/code].
Document `override.cfg` behavior in the ProjectSettings class
2019-10-25 21:48:35 +02:00
[b]Note:[/b] Regardless of this setting's value, [code]res://override.cfg[/code] will still be read to override the project settings (see this class' description at the top).
doc: Sync classref with current source
2018-12-15 01:39:02 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/config/use_custom_user_dir" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], the project will save user data to its own user directory (see [member application/config/custom_user_dir_name]). This setting is only effective on desktop platforms. A name must be set in the [member application/config/custom_user_dir_name] setting for this to take effect. If [code]false[/code], the project will save user data to [code](OS user data directory)/Godot/app_userdata/(project name)[/code].
Add application/config/project_settings_override option to override project settings
2018-11-18 14:56:21 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/config/windows_native_icon" type="String" setter="" getter="" default="&quot;&quot;">
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
Icon set in [code].ico[/code] format used on Windows to set the game's icon. This is done automatically on start by calling [method DisplayServer.set_native_icon].
doc: Sync classref with current source
2019-05-28 18:08:13 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/run/disable_stderr" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], disables printing to standard error in an exported build.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/run/disable_stdout" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], disables printing to standard output in an exported build.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/run/frame_delay_msec" type="int" setter="" getter="" default="0">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Forces a delay between frames in the main loop (in milliseconds). This may be useful if you plan to disable vertical synchronization.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/run/low_processor_mode" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables low-processor usage mode. This setting only works on desktop platforms. The screen is not redrawn if nothing changes visually. This is meant for writing applications and editors, but is pretty useless (and can hurt performance) in most games.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/run/low_processor_mode_sleep_usec" type="int" setter="" getter="" default="6900">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="application/run/main_scene" type="String" setter="" getter="" default="&quot;&quot;">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Path to the main scene file that will be loaded when the project runs.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="audio/channel_disable_threshold_db" type="float" setter="" getter="" default="-60.0">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="audio/channel_disable_time" type="float" setter="" getter="" default="2.0">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Audio buses will disable automatically when sound goes below a given dB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="audio/default_bus_layout" type="String" setter="" getter="" default="&quot;res://default_bus_layout.tres&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [AudioBusLayout] resource file to use in the project, unless overridden by the scene.
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
</member>
Docs: Ignore OS specific values (constants, project settings, properties).
2020-05-20 21:49:39 +02:00
<member name="audio/driver" type="String" setter="" getter="">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Specifies the audio driver to use. This setting is platform-dependent as each platform supports different audio drivers. If left empty, the default audio driver will be used.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="audio/enable_audio_input" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], microphone input will be allowed. This requires appropriate permissions to be set when exporting to Android or iOS.
Request mic access only when is needed
2018-12-13 16:35:01 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="audio/mix_rate" type="int" setter="" getter="" default="44100">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Mixing rate used for audio. In general, it's better to not touch this and leave it to the host operating system.
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="audio/output_latency" type="int" setter="" getter="" default="15">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Output latency in milliseconds for audio. Lower values will result in lower audio latency at the cost of increased CPU usage. Low values may result in audible cracking on slower hardware.
doc: Sync with current source
2018-10-25 15:14:36 +02:00
</member>
doc: Sync classref with current source
2020-07-03 16:09:12 +02:00
<member name="audio/output_latency.web" type="int" setter="" getter="" default="50">
Safer override for [member audio/output_latency] in the Web platform, to avoid audio issues especially on mobile devices.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="audio/video_delay_compensation_ms" type="int" setter="" getter="" default="0">
Misc. typos Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
2018-09-13 03:38:39 +02:00
Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="compression/formats/gzip/compression_level" type="int" setter="" getter="" default="-1">
Improve the compression project settings documentation
2020-04-27 09:55:15 +02:00
The default compression level for gzip. Affects compressed scenes and resources. Higher levels result in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression level. [code]-1[/code] uses the default gzip compression level, which is identical to [code]6[/code] but could change in the future due to underlying zlib updates.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="compression/formats/zlib/compression_level" type="int" setter="" getter="" default="-1">
Improve the compression project settings documentation
2020-04-27 09:55:15 +02:00
The default compression level for Zlib. Affects compressed scenes and resources. Higher levels result in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression level. [code]-1[/code] uses the default gzip compression level, which is identical to [code]6[/code] but could change in the future due to underlying zlib updates.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="compression/formats/zstd/compression_level" type="int" setter="" getter="" default="3">
Improve the compression project settings documentation
2020-04-27 09:55:15 +02:00
The default compression level for Zstandard. Affects compressed scenes and resources. Higher levels result in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression level.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="compression/formats/zstd/long_distance_matching" type="bool" setter="" getter="" default="false">
Improve the compression project settings documentation
2020-04-27 09:55:15 +02:00
Enables [url=https://github.com/facebook/zstd/releases/tag/v1.3.2]long-distance matching[/url] in Zstandard.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="compression/formats/zstd/window_log_size" type="int" setter="" getter="" default="27">
Improve the compression project settings documentation
2020-04-27 09:55:15 +02:00
Largest size limit (in power of 2) allowed when compressing using long-distance matching with Zstandard. Higher values can result in better compression, but will require more memory when compressing and decompressing.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/completion/autocomplete_setters_and_getters" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], displays getters and setters in autocompletion results in the script editor. This setting is meant to be used when porting old projects (Godot 2), as using member variables is the preferred style from Godot 3 onwards.
doc: Sync with current source
2018-10-25 15:14:36 +02:00
</member>
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
<member name="debug/gdscript/warnings/assert_always_false" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/gdscript/warnings/assert_always_true" type="bool" setter="" getter="" default="true">
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/constant_used_as_function" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when a constant is used as a function.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/deprecated_keyword" type="bool" setter="" getter="" default="true">
Remove deprecated sync and slave networking keywords Those keywords were deprecated for 3.1 in #22087. Also fix token name for `TK_REMOTE`, should be "remote" like the keyword.
2020-02-12 12:01:30 +01:00
If [code]true[/code], enables warnings when deprecated keywords are used.
doc: Sync classref with current source
2018-09-15 03:13:47 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/enable" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables specific GDScript warnings (see [code]debug/gdscript/warnings/*[/code] settings). If [code]false[/code], disables all GDScript warnings.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Sync classref with current source Fix incomplete binding.
2019-11-08 16:00:01 +01:00
<member name="debug/gdscript/warnings/exclude_addons" type="bool" setter="" getter="" default="true">
If [code]true[/code], scripts in the [code]res://addons[/code] folder will not generate warnings.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/function_used_as_property" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when using a function as if it was a property.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/incompatible_ternary" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when a ternary operator may emit values with incompatible types.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/integer_division" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when dividing an integer by another integer (the decimal part will be discarded).
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/narrowing_conversion" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when passing a floating-point value to a function that expects an integer (it will be converted and lose precision).
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/property_used_as_function" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when using a property as if it was a function.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
<member name="debug/gdscript/warnings/redundant_await" type="bool" setter="" getter="" default="true">
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter="" default="true">
doc: Fix issues found by the parser
2019-05-15 13:00:45 +02:00
If [code]true[/code], enables warnings when calling a function without using its return value (by assigning it to a variable or using it as a function argument). Such return values are sometimes used to denote possible errors using the [enum Error] enum.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/shadowed_variable" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when defining a local or subclass member variable that would shadow a variable at an upper level (such as a member variable).
doc: Sync classref with current source
2019-04-19 11:21:09 +02:00
</member>
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
<member name="debug/gdscript/warnings/shadowed_variable_base_class" type="bool" setter="" getter="" default="true">
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when calling an expression that has no effect on the surrounding code, such as writing [code]2 + 2[/code] as a statement.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Sync classref with current source
2020-01-12 14:30:21 +01:00
<member name="debug/gdscript/warnings/standalone_ternary" type="bool" setter="" getter="" default="true">
If [code]true[/code], enables warnings when calling a ternary expression that has no effect on the surrounding code, such as writing [code]42 if active else 0[/code] as a statement.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/treat_warnings_as_errors" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], all warnings will be reported as if they were errors.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/unassigned_variable" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when using a variable that wasn't previously assigned.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/unassigned_variable_op_assign" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when assigning a variable using an assignment operator like [code]+=[/code] if the variable wasn't previously assigned.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/unreachable_code" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when unreachable code is detected (such as after a [code]return[/code] statement that will always be executed).
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
<member name="debug/gdscript/warnings/unreachable_pattern" type="bool" setter="" getter="" default="true">
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/unsafe_call_argument" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when using an expression whose type may not be compatible with the function parameter expected.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/unsafe_cast" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when performing an unsafe cast.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/unsafe_method_access" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when calling a method whose presence is not guaranteed at compile-time in the class.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/unsafe_property_access" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when accessing a property whose presence is not guaranteed at compile-time in the class.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
<member name="debug/gdscript/warnings/unused_local_constant" type="bool" setter="" getter="" default="true">
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Sync classref with current source
2020-07-28 01:08:44 +02:00
<member name="debug/gdscript/warnings/unused_parameter" type="bool" setter="" getter="" default="true">
</member>
<member name="debug/gdscript/warnings/unused_private_class_variable" type="bool" setter="" getter="" default="true">
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/unused_signal" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when a signal is unused.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/unused_variable" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when a local variable is unused.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/gdscript/warnings/void_assignment" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables warnings when assigning the result of a function that returns [code]void[/code] to a variable.
doc: Sync classref with current source
2018-08-21 00:35:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/settings/crash_handler/message" type="String" setter="" getter="" default="&quot;Please include this when reporting the bug on https://github.com/godotengine/godot/issues&quot;">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Message to be displayed before the backtrace when the engine crashes.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/settings/fps/force_fps" type="int" setter="" getter="" default="0">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Maximum number of frames per second allowed. The actual number of frames per second may still be below this value if the game is lagging.
If [member display/window/vsync/use_vsync] is enabled, it takes precedence and the forced FPS number cannot exceed the monitor's refresh rate.
This setting is therefore mostly relevant for lowering the maximum FPS below VSync, e.g. to perform non real-time rendering of static frames, or test the project under lag conditions.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/settings/gdscript/max_call_stack" type="int" setter="" getter="" default="1024">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Maximum call stack allowed for debugging GDScript.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/settings/profiler/max_functions" type="int" setter="" getter="" default="16384">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Maximum amount of functions per frame allowed when profiling.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/settings/stdout/print_fps" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Print frames per second to standard output every second.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/settings/stdout/verbose_stdout" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Print more information to standard output when running. It displays information such as memory leaks, which scenes and resources are being loaded, etc.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="debug/settings/visual_script/max_call_stack" type="int" setter="" getter="" default="1024">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Maximum call stack in visual scripting, to avoid infinite recursion.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="debug/shapes/collision/contact_color" type="Color" setter="" getter="" default="Color( 1, 0.2, 0.1, 0.8 )">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Color of the contact points between collision shapes, visible when "Visible Collision Shapes" is enabled in the Debug menu.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="debug/shapes/collision/max_contacts_displayed" type="int" setter="" getter="" default="10000">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Maximum number of contact points between collision shapes to display when "Visible Collision Shapes" is enabled in the Debug menu.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="debug/shapes/collision/shape_color" type="Color" setter="" getter="" default="Color( 0, 0.6, 0.7, 0.5 )">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Color of the collision shapes, visible when "Visible Collision Shapes" is enabled in the Debug menu.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="debug/shapes/navigation/disabled_geometry_color" type="Color" setter="" getter="" default="Color( 1, 0.7, 0.1, 0.4 )">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Color of the disabled navigation geometry, visible when "Visible Navigation" is enabled in the Debug menu.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="debug/shapes/navigation/geometry_color" type="Color" setter="" getter="" default="Color( 0.1, 1, 0.7, 0.4 )">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Color of the navigation geometry, visible when "Visible Navigation" is enabled in the Debug menu.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/mouse_cursor/custom_image" type="String" setter="" getter="" default="&quot;&quot;">
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
Custom image for the mouse cursor (limited to 256×256).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/mouse_cursor/custom_image_hotspot" type="Vector2" setter="" getter="" default="Vector2( 0, 0 )">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Hotspot for the custom mouse cursor image.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/mouse_cursor/tooltip_position_offset" type="Vector2" setter="" getter="" default="Vector2( 10, 10 )">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Position offset for tooltips, relative to the mouse cursor's hotspot.
Made the tooltip position offset configurable
2019-03-02 12:11:42 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/dpi/allow_hidpi" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], allows HiDPI display on Windows and macOS. This setting has no effect on desktop Linux, as DPI-awareness fallbacks are not supported there.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/energy_saving/keep_screen_on" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], keeps the screen on (even in case of inactivity), so the screensaver does not take over. Works on desktop and mobile platforms.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/handheld/orientation" type="String" setter="" getter="" default="&quot;landscape&quot;">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Default orientation on mobile devices.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source
2019-12-17 11:43:07 +01:00
<member name="display/window/ios/hide_home_indicator" type="bool" setter="" getter="" default="true">
If [code]true[/code], the home indicator is hidden automatically. This only affects iOS devices without a physical home button.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/size/always_on_top" type="bool" setter="" getter="" default="false">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Force the window to be always on top.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/size/borderless" type="bool" setter="" getter="" default="false">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Force the window to be borderless.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/size/fullscreen" type="bool" setter="" getter="" default="false">
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 window to full screen when it starts.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/size/height" type="int" setter="" getter="" default="600">
Fix silly mistake in ProjectSettings docs
2019-10-04 21:13:15 +02:00
Sets the game's main viewport height. On desktop platforms, this is the default window size. Stretch mode settings also use this as a reference when enabled.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/size/resizable" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Allows the window to be resizable by default.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/size/test_height" type="int" setter="" getter="" default="0">
Improve ProjectSettings window docs
2019-10-03 21:59:20 +02:00
If greater than zero, overrides the window height when running the game. Useful for testing stretch modes.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/size/test_width" type="int" setter="" getter="" default="0">
Improve ProjectSettings window docs
2019-10-03 21:59:20 +02:00
If greater than zero, overrides the window width when running the game. Useful for testing stretch modes.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/size/width" type="int" setter="" getter="" default="1024">
Improve ProjectSettings window docs
2019-10-03 21:59:20 +02:00
Sets the game's main viewport width. On desktop platforms, this is the default window size. Stretch mode settings also use this as a reference when enabled.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Docs: Ignore OS specific values (constants, project settings, properties).
2020-05-20 21:49:39 +02:00
<member name="display/window/tablet_driver" type="String" setter="" getter="">
[Windows] Add tablet driver selection.
2020-05-19 22:34:26 +02:00
Specifies the tablet driver to use. If left empty, the default driver will be used.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="display/window/vsync/use_vsync" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], enables vertical synchronization. This eliminates tearing that may appear in moving scenes, at the cost of higher input latency and stuttering at lower framerates. If [code]false[/code], vertical synchronization will be disabled, however, many platforms will enforce it regardless (such as mobile platforms and HTML5).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Revert "Enable Vsync via Compositor by default" This reverts commit 9600fd5dde1f85b7dd2dd8558d52ff86b18651e7. Add comment warning about possible implications of using this option. Fixes #35038.
2020-01-13 09:27:06 +01:00
<member name="display/window/vsync/vsync_via_compositor" type="bool" setter="" getter="" default="false">
Added support for vertical syncing via the Windows OS compositor (DWM.)
2019-11-07 03:18:55 +01:00
If [code]Use Vsync[/code] is enabled and this setting is [code]true[/code], enables vertical synchronization via the operating system's window compositor when in windowed mode and the compositor is enabled. This will prevent stutter in certain situations. (Windows only.)
Revert "Enable Vsync via Compositor by default" This reverts commit 9600fd5dde1f85b7dd2dd8558d52ff86b18651e7. Add comment warning about possible implications of using this option. Fixes #35038.
2020-01-13 09:27:06 +01:00
[b]Note:[/b] This option is experimental and meant to alleviate stutter experienced by some users. However, some users have experienced a Vsync framerate halving (e.g. from 60 FPS to 30 FPS) when using it.
Added support for vertical syncing via the Windows OS compositor (DWM.)
2019-11-07 03:18:55 +01:00
</member>
doc: Sync classref with current source
2019-08-29 15:33:52 +02:00
<member name="editor/script_templates_search_path" type="String" setter="" getter="" default="&quot;res://script_templates&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Search path for project-specific script templates. Script templates will be search both in the editor-specific path and in this project-specific path.
doc: Sync classref with current source
2019-08-29 15:33:52 +02:00
</member>
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 13:59:24 +01:00
<member name="editor/search_in_file_extensions" type="PackedStringArray" setter="" getter="" default="PackedStringArray( &quot;gd&quot;, &quot;shader&quot; )">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Text-based file extensions to include in the script editor's "Find in Files" feature. You can add e.g. [code]tscn[/code] if you wish to also parse your scene files, especially if you use built-in scripts which are serialized in the scene files.
doc: Sync classref with current source
2019-06-01 12:34:29 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="gui/common/default_scroll_deadzone" type="int" setter="" getter="" default="0">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default value for [member ScrollContainer.scroll_deadzone], which will be used for all [ScrollContainer]s unless overridden.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Docs: Ignore OS specific values (constants, project settings, properties).
2020-05-20 21:49:39 +02:00
<member name="gui/common/swap_cancel_ok" type="bool" setter="" getter="">
Fix cancel/OK button order on macOS The macOS platform convention regarding button order is cancel on left, OK on right.
2020-07-09 01:02:38 +02:00
If [code]true[/code], swaps Cancel and OK buttons in dialogs on Windows and UWP to follow interface conventions.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source
2020-05-01 12:46:05 +02:00
<member name="gui/common/text_edit_undo_stack_max_size" type="int" setter="" getter="" default="1024">
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="gui/theme/custom" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Path to a custom [Theme] resource file to use for the project ([code]theme[/code] or generic [code]tres[/code]/[code]res[/code] extension).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="gui/theme/custom_font" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Path to a custom [Font] resource to use as default for all GUI elements of the project.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="gui/theme/use_hidpi" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], makes sure the theme used works with HiDPI.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="gui/timers/incremental_search_max_interval_msec" type="int" setter="" getter="" default="2000">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Timer setting for incremental search in [Tree], [ItemList], etc. controls (in milliseconds).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="gui/timers/text_edit_idle_detect_sec" type="float" setter="" getter="" default="3">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Timer for detecting idle in [TextEdit] (in seconds).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="gui/timers/tooltip_delay_sec" type="float" setter="" getter="" default="0.5">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default delay for tooltips (in seconds).
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_accept" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to confirm a focused button, menu or list item, or validate input.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_cancel" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to discard a modal or pending input.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_down" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to move down in the UI.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_end" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to go to the end position of a [Control] (e.g. last item in an [ItemList] or a [Tree]), matching the behavior of [constant KEY_END] on typical desktop UI systems.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_focus_next" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to focus the next [Control] in the scene. The focus behavior can be configured via [member Control.focus_next].
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_focus_prev" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to focus the previous [Control] in the scene. The focus behavior can be configured via [member Control.focus_previous].
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_home" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to go to the start position of a [Control] (e.g. first item in an [ItemList] or a [Tree]), matching the behavior of [constant KEY_HOME] on typical desktop UI systems.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_left" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to move left in the UI.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_page_down" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to go down a page in a [Control] (e.g. in an [ItemList] or a [Tree]), matching the behavior of [constant KEY_PAGEDOWN] on typical desktop UI systems.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_page_up" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to go up a page in a [Control] (e.g. in an [ItemList] or a [Tree]), matching the behavior of [constant KEY_PAGEUP] on typical desktop UI systems.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_right" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to move right in the UI.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_select" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to select an item in a [Control] (e.g. in an [ItemList] or a [Tree]).
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
</member>
Get real default values for project settings in documentation Also, ignore custom project settings and values for input/ entries Fixes #34154
2020-01-22 14:22:21 +01:00
<member name="input/ui_up" type="Dictionary" setter="" getter="">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Default [InputEventAction] to move up in the UI.
[b]Note:[/b] Default [code]ui_*[/code] actions cannot be removed as they are necessary for the internal logic of several [Control]s. The events assigned to the action can however be modified.
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
</member>
<member name="input_devices/pointing/emulate_mouse_from_touch" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], sends mouse input events when tapping or swiping on the touchscreen.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="input_devices/pointing/emulate_touch_from_mouse" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], sends touch input events when clicking or dragging the mouse.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
iOS: move touch delay to settings
2020-09-28 21:24:35 +02:00
<member name="input_devices/pointing/ios/touch_delay" type="float" setter="" getter="" default="0.150">
Default delay for touch events. This only affects iOS devices.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_1" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 1.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_10" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 10.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_11" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 11.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_12" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 12.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_13" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 13.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_14" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 14.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_15" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 15.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_16" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 16.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_17" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 17.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_18" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 18.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_19" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 19.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_2" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 2.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_20" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 20.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_3" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 3.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_4" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 4.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_5" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 5.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_6" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 6.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_7" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 7.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_8" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 8.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_physics/layer_9" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D physics layer 9.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_1" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 1.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_10" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 10.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_11" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 11.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_12" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 12.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_13" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 13.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_14" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 14.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_15" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 15.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_16" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 16.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_17" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 17.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_18" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 18.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_19" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 19.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_2" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 2.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_20" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 20.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_3" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 3.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_4" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 4.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_5" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 5.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_6" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 6.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_7" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 7.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_8" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 8.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/2d_render/layer_9" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 2D render layer 9.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_1" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 1.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_10" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 10.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_11" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 11.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_12" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 12.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_13" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 13.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_14" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 14.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_15" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 15.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_16" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 16.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_17" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 17.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_18" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 18.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_19" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 19.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_2" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 2.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_20" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 20.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_3" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 3.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_4" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 4.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_5" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 5.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_6" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 6.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_7" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 7.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_8" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 8.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_physics/layer_9" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D physics layer 9.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_1" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 1.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_10" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 10.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_11" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 11.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_12" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 12.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_13" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 13.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_14" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 14
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_15" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 15.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_16" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 16.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_17" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 17.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_18" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 18.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_19" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 19.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_2" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 2.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_20" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 20.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_3" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 3.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_4" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 4.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_5" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 5.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_6" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 6.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_7" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 7.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_8" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 8.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="layer_names/3d_render/layer_9" type="String" setter="" getter="" default="&quot;&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Optional name for the 3D render layer 9.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="locale/fallback" type="String" setter="" getter="" default="&quot;en&quot;">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
The locale to fall back to if a translation isn't available in a given language. If left empty, [code]en[/code] (English) will be used.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="locale/test" type="String" setter="" getter="" default="&quot;&quot;">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If non-empty, this locale will be used when running the project from the editor.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="logging/file_logging/enable_file_logging" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], logs all output to files.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Enable file logging by default on desktops to help with troubleshooting - Use the `.log` file extension (recognized on Windows out of the box) to better hint that generated files are logs. Some editors provide dedicated syntax highlighting for those files. - Use an underscore to separate the basename from the date and the date from the time in log filenames. This makes the filename easier to read. - Keep only 5 log files by default to decrease disk usage in case messages are spammed.
2020-07-04 16:59:49 +02:00
<member name="logging/file_logging/enable_file_logging.pc" type="bool" setter="" getter="" default="true">
</member>
<member name="logging/file_logging/log_path" type="String" setter="" getter="" default="&quot;user://logs/godot.log&quot;">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Path to logs within the project. Using an [code]user://[/code] path is recommended.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Enable file logging by default on desktops to help with troubleshooting - Use the `.log` file extension (recognized on Windows out of the box) to better hint that generated files are logs. Some editors provide dedicated syntax highlighting for those files. - Use an underscore to separate the basename from the date and the date from the time in log filenames. This makes the filename easier to read. - Keep only 5 log files by default to decrease disk usage in case messages are spammed.
2020-07-04 16:59:49 +02:00
<member name="logging/file_logging/max_log_files" type="int" setter="" getter="" default="5">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Specifies the maximum amount of log files allowed (used for rotation).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter="" default="1024">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Godot uses a message queue to defer some function calls. If you run out of space on it (you will see an error), you can increase the size here.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Fix parsing typed arrays in makerst.py `Type[]` typed arrays will link to `Type`, as it's likely the most interesting information for the user. And sync classref with current source.
2020-04-24 17:43:10 +02:00
<member name="mono/debugger_agent/port" type="int" setter="" getter="" default="23685">
</member>
<member name="mono/debugger_agent/wait_for_debugger" type="bool" setter="" getter="" default="false">
</member>
<member name="mono/debugger_agent/wait_timeout" type="int" setter="" getter="" default="3000">
</member>
<member name="mono/profiler/args" type="String" setter="" getter="" default="&quot;log:calls,alloc,sample,output=output.mlpd&quot;">
</member>
<member name="mono/profiler/enabled" type="bool" setter="" getter="" default="false">
</member>
Mono: Always define options in main.cpp to keep them in docs Otherwise generating docs with non-Mono builds removes them, which is not so convenient for the documentation work.
2020-06-18 12:05:44 +02:00
<member name="mono/project/auto_update_project" type="bool" setter="" getter="" default="true">
</member>
doc: Fix parsing typed arrays in makerst.py `Type[]` typed arrays will link to `Type`, as it's likely the most interesting information for the user. And sync classref with current source.
2020-04-24 17:43:10 +02:00
<member name="mono/unhandled_exception_policy" type="int" setter="" getter="" default="0">
</member>
doc: Sync classref with current source
2020-03-13 17:16:44 +01:00
<member name="network/limits/debugger/max_chars_per_second" type="int" setter="" getter="" default="32768">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source
2020-03-13 17:16:44 +01:00
<member name="network/limits/debugger/max_errors_per_second" type="int" setter="" getter="" default="400">
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 03:30:20 +01:00
Maximum number of errors allowed to be sent from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source
2020-03-13 17:16:44 +01:00
<member name="network/limits/debugger/max_queued_messages" type="int" setter="" getter="" default="2048">
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 03:30:20 +01:00
Maximum amount of messages in the debugger queue. Over this value, content is dropped. This helps to limit the debugger memory usage.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source
2020-03-13 17:16:44 +01:00
<member name="network/limits/debugger/max_warnings_per_second" type="int" setter="" getter="" default="400">
Refactor ScriptDebugger. EngineDebugger is the new interface to access the debugger. It tries to be as agnostic as possible on the data that various subsystems can expose. It allows 2 types of interactions: - Profilers: A subsystem can register a profiler, assigning it a unique name. That name can be used to activate the profiler or add data to it. The registered profiler can be composed of up to 3 functions: - Toggle: called when the profiler is activated/deactivated. - Add: called whenever data is added to the debugger (via `EngineDebugger::profiler_add_frame_data`) - Tick: called every frame (during idle), receives frame times. - Captures: (Only relevant in remote debugger for now) A subsystem can register a capture, assigning it a unique name. When receiving a message, the remote debugger will check if it starts with `[prefix]:` and call the associated capture with name `prefix`. Port MultiplayerAPI, Servers, Scripts, Visual, Performance to the new profiler system. Port SceneDebugger and RemoteDebugger to the new capture system. The LocalDebugger also uses the new profiler system for scripts profiling.
2020-02-27 03:30:20 +01:00
Maximum number of warnings allowed to be sent from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
Cap the number of warnings/errors per second rather than per frame This reproduces the behavior used for printing when using the remote debugger. The default limit is 100 errors and 100 warnings per second, which makes it possible to display much more GDScript warnings before overflowing. This also adds a "Too many warnings" message, so that warnings don't look like errors when overflowing anymore. This closes #21896.
2019-07-31 17:24:53 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="network/limits/packet_peer_stream/max_buffer_po2" type="int" setter="" getter="" default="16">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Default size of packet peer stream for deserializing Godot data. Over this size, data is dropped.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
TreeItem: Rename new button disable method to set_button_disabled Follow-up to #30408. Also sync classref with current source.
2019-07-09 09:13:00 +02:00
<member name="network/limits/tcp/connect_timeout_seconds" type="int" setter="" getter="" default="30">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Timeout (in seconds) for connection attempts using TCP.
TreeItem: Rename new button disable method to set_button_disabled Follow-up to #30408. Also sync classref with current source.
2019-07-09 09:13:00 +02:00
</member>
doc: Sync classref with current source Fix wrong hyperlinks in Control and Tree.
2019-08-22 14:49:30 +02:00
<member name="network/limits/webrtc/max_channel_in_buffer_kb" type="int" setter="" getter="" default="64">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Maximum size (in kiB) for the [WebRTCDataChannel] input buffer.
doc: Sync classref with current source Fix wrong hyperlinks in Control and Tree.
2019-08-22 14:49:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="network/remote_fs/page_read_ahead" type="int" setter="" getter="" default="4">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Amount of read ahead used by remote filesystem. Higher values decrease the effects of latency at the cost of higher bandwidth usage.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="network/remote_fs/page_size" type="int" setter="" getter="" default="65536">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Page size used by remote filesystem (in bytes).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Rename SSL certificate bundle setting to clarify the "overriding" aspect This closes https://github.com/godotengine/godot-docs/issues/2531.
2020-05-12 10:10:54 +02:00
<member name="network/ssl/certificate_bundle_override" type="String" setter="" getter="" default="&quot;&quot;">
The CA certificates bundle to use for SSL connections. If this is set to a non-empty value, this will [i]override[/i] Godot's default [url=https://github.com/godotengine/godot/blob/master/thirdparty/certs/ca-certificates.crt]Mozilla certificate bundle[/url]. If left empty, the default certificate bundle will be used.
If in doubt, leave this setting empty.
doc: Sync classref with current source Fix wrong hyperlinks in Control and Tree.
2019-08-22 14:49:30 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="node/name_casing" type="int" setter="" getter="" default="0">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
When creating node names automatically, set the type of casing in this project. This is mostly an editor setting.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="node/name_num_separator" type="int" setter="" getter="" default="0">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
What to use to separate node name from number. This is mostly an editor setting.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="physics/2d/bp_hash_table_size" type="int" setter="" getter="" default="4096">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Size of the hash table used for the broad-phase 2D hash grid algorithm.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="physics/2d/cell_size" type="int" setter="" getter="" default="128">
Clarify that 2D cell sizes are defined in pixels See https://github.com/godotengine/godot/issues/40577#issuecomment-662329021.
2020-09-15 14:06:42 +02:00
Cell size used for the broad-phase 2D hash grid algorithm (in pixels).
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="physics/2d/default_angular_damp" type="float" setter="" getter="" default="1.0">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
The default angular damp in 2D.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="physics/2d/default_gravity" type="int" setter="" getter="" default="98">
Document how to change the default gravity at runtime Changing the default gravity at runtime isn't exactly obvious, so it makes sense to add a code sample.
2020-01-24 22:14:22 +01:00
The default gravity strength in 2D.
[b]Note:[/b] This property is only read when the project starts. To change the default gravity at runtime, use the following code sample:
[codeblock]
# Set the default gravity strength to 98.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
PhysicsServer2D.area_set_param(get_viewport().find_world_2d().get_space(), PhysicsServer2D.AREA_PARAM_GRAVITY, 98)
Document how to change the default gravity at runtime Changing the default gravity at runtime isn't exactly obvious, so it makes sense to add a code sample.
2020-01-24 22:14:22 +01:00
[/codeblock]
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="physics/2d/default_gravity_vector" type="Vector2" setter="" getter="" default="Vector2( 0, 1 )">
Document how to change the default gravity at runtime Changing the default gravity at runtime isn't exactly obvious, so it makes sense to add a code sample.
2020-01-24 22:14:22 +01:00
The default gravity direction in 2D.
[b]Note:[/b] This property is only read when the project starts. To change the default gravity vector at runtime, use the following code sample:
[codeblock]
# Set the default gravity direction to `Vector2(0, 1)`.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
PhysicsServer2D.area_set_param(get_viewport().find_world_2d().get_space(), PhysicsServer2D.AREA_PARAM_GRAVITY_VECTOR, Vector2(0, 1))
Document how to change the default gravity at runtime Changing the default gravity at runtime isn't exactly obvious, so it makes sense to add a code sample.
2020-01-24 22:14:22 +01:00
[/codeblock]
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="physics/2d/default_linear_damp" type="float" setter="" getter="" default="0.1">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
The default linear damp in 2D.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="physics/2d/large_object_surface_threshold_in_cells" type="int" setter="" getter="" default="512">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Threshold defining the surface size that constitutes a large object with regard to cells in the broad-phase 2D hash grid algorithm.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="physics/2d/physics_engine" type="String" setter="" getter="" default="&quot;DEFAULT&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Sets which physics engine to use for 2D physics.
Rename "GodotPhysics" to "GodotPhysics{2D,3D}"
2020-03-28 13:33:24 +01:00
"DEFAULT" and "GodotPhysics2D" are the same, as there is currently no alternative 2D physics server implemented.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="physics/2d/sleep_threshold_angular" type="float" setter="" getter="" default="0.139626">
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Threshold angular velocity under which a 2D physics body will be considered inactive. See [constant PhysicsServer2D.SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD].
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="physics/2d/sleep_threshold_linear" type="float" setter="" getter="" default="2.0">
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Threshold linear velocity under which a 2D physics body will be considered inactive. See [constant PhysicsServer2D.SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD].
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="physics/2d/thread_model" type="int" setter="" getter="" default="1">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Sets whether physics is run on the main thread or a separate one. Running the server on a thread increases performance, but restricts API access to only physics process.
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
[b]Warning:[/b] As of Godot 3.2, there are mixed reports about the use of a Multi-Threaded thread model for physics. Be sure to assess whether it does give you extra performance and no regressions when using it.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="physics/2d/time_before_sleep" type="float" setter="" getter="" default="0.5">
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Time (in seconds) of inactivity before which a 2D physics body will put to sleep. See [constant PhysicsServer2D.SPACE_PARAM_BODY_TIME_TO_SLEEP].
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="physics/3d/active_soft_world" type="bool" setter="" getter="" default="true">
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Sets whether the 3D physics world will be created with support for [SoftBody3D] physics. Only applies to the Bullet physics engine.
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="physics/3d/default_angular_damp" type="float" setter="" getter="" default="0.1">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
The default angular damp in 3D.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="physics/3d/default_gravity" type="float" setter="" getter="" default="9.8">
Document how to change the default gravity at runtime Changing the default gravity at runtime isn't exactly obvious, so it makes sense to add a code sample.
2020-01-24 22:14:22 +01:00
The default gravity strength in 3D.
[b]Note:[/b] This property is only read when the project starts. To change the default gravity at runtime, use the following code sample:
[codeblock]
# Set the default gravity strength to 9.8.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
PhysicsServer3D.area_set_param(get_viewport().find_world().get_space(), PhysicsServer3D.AREA_PARAM_GRAVITY, 9.8)
Document how to change the default gravity at runtime Changing the default gravity at runtime isn't exactly obvious, so it makes sense to add a code sample.
2020-01-24 22:14:22 +01:00
[/codeblock]
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="physics/3d/default_gravity_vector" type="Vector3" setter="" getter="" default="Vector3( 0, -1, 0 )">
Document how to change the default gravity at runtime Changing the default gravity at runtime isn't exactly obvious, so it makes sense to add a code sample.
2020-01-24 22:14:22 +01:00
The default gravity direction in 3D.
[b]Note:[/b] This property is only read when the project starts. To change the default gravity vector at runtime, use the following code sample:
[codeblock]
# Set the default gravity direction to `Vector3(0, -1, 0)`.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
PhysicsServer3D.area_set_param(get_viewport().find_world().get_space(), PhysicsServer3D.AREA_PARAM_GRAVITY_VECTOR, Vector3(0, -1, 0))
Document how to change the default gravity at runtime Changing the default gravity at runtime isn't exactly obvious, so it makes sense to add a code sample.
2020-01-24 22:14:22 +01:00
[/codeblock]
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
<member name="physics/3d/default_linear_damp" type="float" setter="" getter="" default="0.1">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
The default linear damp in 3D.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="physics/3d/physics_engine" type="String" setter="" getter="" default="&quot;DEFAULT&quot;">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Sets which physics engine to use for 3D physics.
Rename "GodotPhysics" to "GodotPhysics{2D,3D}"
2020-03-28 13:33:24 +01:00
"DEFAULT" is currently the [url=https://bulletphysics.org]Bullet[/url] physics engine. The "GodotPhysics3D" engine is still supported as an alternative.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="physics/common/enable_object_picking" type="bool" setter="" getter="" default="true">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Enables [member Viewport.physics_object_picking] on the root viewport.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="physics/common/physics_fps" type="int" setter="" getter="" default="60">
Improve documentation related to fixed physics processing
2020-02-27 22:19:57 +01:00
The number of fixed iterations per second. This controls how often physics simulation and [method Node._physics_process] methods are run.
[b]Note:[/b] This property is only read when the project starts. To change the physics FPS at runtime, set [member Engine.iterations_per_second] instead.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="physics/common/physics_jitter_fix" type="float" setter="" getter="" default="0.5">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Fix to improve physics jitter, specially on monitors where refresh rate is different than the physics FPS.
Improve documentation related to fixed physics processing
2020-02-27 22:19:57 +01:00
[b]Note:[/b] This property is only read when the project starts. To change the physics FPS at runtime, set [member Engine.physics_jitter_fix] instead.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/environment/default_clear_color" type="Color" setter="" getter="" default="Color( 0.3, 0.3, 0.3, 1 )">
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Default background clear color. Overridable per [Viewport] using its [Environment]. See [member Environment.background_mode] and [member Environment.background_color] in particular. To change this default color programmatically, use [method RenderingServer.set_default_clear_color].
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
<member name="rendering/environment/default_environment" type="String" setter="" getter="" default="&quot;&quot;">
Finish documenting CSG* and *probes
2020-01-23 07:12:52 +01:00
[Environment] that will be used as a fallback environment in case a scene does not specify its own environment. The default environment is loaded in at scene load time regardless of whether you have set an environment or not. If you do not rely on the fallback environment, it is best to delete [code]default_env.tres[/code], or to specify a different default environment here.
Add settings from SceneTree in the documentation Fixes #35439
2020-01-22 21:37:56 +01:00
</member>
doc: Sync classref with current source Adds API changes from the new GPU lightmapper.
2020-05-12 10:10:34 +02:00
<member name="rendering/gpu_lightmapper/performance/max_rays_per_pass" type="int" setter="" getter="" default="32">
</member>
<member name="rendering/gpu_lightmapper/performance/max_rays_per_probe_pass" type="int" setter="" getter="" default="64">
</member>
<member name="rendering/gpu_lightmapper/performance/region_size" type="int" setter="" getter="" default="512">
</member>
<member name="rendering/gpu_lightmapper/quality/high_quality_probe_ray_count" type="int" setter="" getter="" default="512">
</member>
<member name="rendering/gpu_lightmapper/quality/high_quality_ray_count" type="int" setter="" getter="" default="256">
</member>
<member name="rendering/gpu_lightmapper/quality/low_quality_probe_ray_count" type="int" setter="" getter="" default="64">
</member>
<member name="rendering/gpu_lightmapper/quality/low_quality_ray_count" type="int" setter="" getter="" default="16">
</member>
<member name="rendering/gpu_lightmapper/quality/medium_quality_probe_ray_count" type="int" setter="" getter="" default="256">
</member>
<member name="rendering/gpu_lightmapper/quality/medium_quality_ray_count" type="int" setter="" getter="" default="64">
</member>
<member name="rendering/gpu_lightmapper/quality/ultra_quality_probe_ray_count" type="int" setter="" getter="" default="2048">
</member>
<member name="rendering/gpu_lightmapper/quality/ultra_quality_ray_count" type="int" setter="" getter="" default="1024">
</member>
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 11:48:00 +02:00
<member name="rendering/high_end/global_shader_variables_buffer_size" type="int" setter="" getter="" default="65536">
</member>
doc: Sync classref with current source Adds API changes from the new GPU lightmapper.
2020-05-12 10:10:34 +02:00
<member name="rendering/lightmapper/probe_capture_update_speed" type="float" setter="" getter="" default="15">
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="rendering/limits/rendering/max_renderable_elements" type="int" setter="" getter="" default="128000">
doc: Sync classref with current source
2019-07-29 21:12:57 +02:00
Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves.
</member>
doc: Sync classref with current source
2020-05-01 12:46:05 +02:00
<member name="rendering/limits/time/time_rollover_secs" type="float" setter="" getter="" default="3600">
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/2d/use_pixel_snap" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], forces snapping of polygons to pixels in 2D rendering. May help in some pixel art styles.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
<member name="rendering/quality/depth_of_field/depth_of_field_bokeh_quality" type="int" setter="" getter="" default="2">
Sets the quality of the depth of field effect. Higher quality takes more samples, which is slower but looks smoother.
</member>
<member name="rendering/quality/depth_of_field/depth_of_field_bokeh_shape" type="int" setter="" getter="" default="1">
Sets the depth of field shape. Can be Box, Hexagon, or Circle. Box is the fastest. Circle is the most realistic, but also the most expensive to compute.
</member>
<member name="rendering/quality/depth_of_field/depth_of_field_use_jitter" type="bool" setter="" getter="" default="false">
If [code]true[/code], jitters DOF samples to make effect slightly blurrier and hide lines created from low sample rates. This can result in a slightly grainy appearance when used with a low number of samples.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/depth_prepass/disable_for_vendors" type="String" setter="" getter="" default="&quot;PowerVR,Mali,Adreno,Apple&quot;">
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
Disables depth pre-pass for some GPU vendors (usually mobile), as their architecture already does this.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/depth_prepass/enable" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/directional_shadow/size" type="int" setter="" getter="" default="4096">
Improve documentation pertaining to shadow atlas sizes This partially addresses #27650.
2019-09-04 23:32:46 +02:00
The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. The value will be rounded up to the nearest power of 2.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/directional_shadow/size.mobile" type="int" setter="" getter="" default="2048">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Lower-end override for [member rendering/quality/directional_shadow/size] on mobile devices, due to performance concerns or driver support.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add proper quality settings to soft shadows
2020-04-10 11:30:36 +02:00
<member name="rendering/quality/directional_shadow/soft_shadow_quality" type="int" setter="" getter="" default="2">
Quality setting for shadows cast by [DirectionalLight3D]s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy.
</member>
<member name="rendering/quality/directional_shadow/soft_shadow_quality.mobile" type="int" setter="" getter="" default="0">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Lower-end override for [member rendering/quality/directional_shadow/soft_shadow_quality] on mobile devices, due to performance concerns or driver support.
Add proper quality settings to soft shadows
2020-04-10 11:30:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="rendering/quality/driver/driver_name" type="String" setter="" getter="" default="&quot;Vulkan&quot;">
Remove obsolete GLES3 backend Due to the port to Vulkan and complete redesign of the rendering backend, the `drivers/gles3` code is no longer usable in this state and is not planned to be ported to the new architecture. The GLES2 backend is kept (while still disabled and non-working) as it will eventually be ported to serve as the low-end renderer for Godot 4.0. Some GLES3 features might be selectively ported to the updated GLES2 backend if there's a need for them, and extensions we can use for that. So long, OpenGL driver bugs!
2020-02-13 10:08:52 +01:00
The video driver to use ("GLES2" or "Vulkan").
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
[b]Note:[/b] The backend in use can be overridden at runtime via the [code]--rendering-driver[/code] command line argument.
[b]FIXME:[/b] No longer valid after DisplayServer split:
In such cases, this property is not updated, so use [code]OS.get_current_video_driver[/code] to query it at run-time.
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="rendering/quality/gi_probes/anisotropic" type="bool" setter="" getter="" default="false">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
If [code]true[/code], take additional samples when rendering objects affected by a [GIProbe] to reduce artifacts from only sampling in one direction.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</member>
<member name="rendering/quality/gi_probes/quality" type="int" setter="" getter="" default="1">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Sets the number of cone samples taken when rendering objects affected by [GIProbe]s.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</member>
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
<member name="rendering/quality/glow/upscale_mode" type="int" setter="" getter="" default="1">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Sets how the glow effect is upscaled before being copied onto the screen. Linear is faster, but looks blocky. Bicubic is slower but looks smooth.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
</member>
<member name="rendering/quality/glow/upscale_mode.mobile" type="int" setter="" getter="" default="0">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Lower-end override for [member rendering/quality/glow/upscale_mode] on mobile devices, due to performance concerns or driver support.
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
</member>
Add high quality glow mode
2020-09-01 08:04:45 +02:00
<member name="rendering/quality/glow/use_high_quality" type="bool" setter="" getter="" default="false">
Takes more samples during downsample pass of glow. This ensures that single pixels are captured by glow which makes the glow look smoother and more stable during movement. However, it is very expensive and makes the glow post process take twice as long.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/intended_usage/framebuffer_allocation" type="int" setter="" getter="" default="2">
Finish documenting CSG* and *probes
2020-01-23 07:12:52 +01:00
Strategy used for framebuffer allocation. The simpler it is, the less resources it uses (but the less features it supports). If set to "2D Without Sampling" or "3D Without Effects", sample buffers will not be allocated. This means [code]SCREEN_TEXTURE[/code] and [code]DEPTH_TEXTURE[/code] will not be available in shaders and post-processing effects will not be available in the [Environment].
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/intended_usage/framebuffer_allocation.mobile" type="int" setter="" getter="" default="3">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Lower-end override for [member rendering/quality/intended_usage/framebuffer_allocation] on mobile devices, due to performance concerns or driver support.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="rendering/quality/reflection_atlas/reflection_count" type="int" setter="" getter="" default="64">
Basic fast filtering implementation
2020-02-21 00:27:34 +01:00
Number of cubemaps to store in the reflection atlas. The number of [ReflectionProbe]s in a scene will be limited by this amount. A higher number requires more VRAM.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</member>
Working sky shader implementation
2020-03-20 01:32:19 +01:00
<member name="rendering/quality/reflection_atlas/reflection_size" type="int" setter="" getter="" default="256">
Basic fast filtering implementation
2020-02-21 00:27:34 +01:00
Size of cubemap faces for [ReflectionProbe]s. A higher number requires more VRAM and may make reflection probe updating slower.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</member>
<member name="rendering/quality/reflection_atlas/reflection_size.mobile" type="int" setter="" getter="" default="128">
Basic fast filtering implementation
2020-02-21 00:27:34 +01:00
Lower-end override for [member rendering/quality/reflection_atlas/reflection_size] on mobile devices, due to performance concerns or driver support.
</member>
<member name="rendering/quality/reflections/fast_filter_high_quality" type="bool" setter="" getter="" default="false">
Use a higher quality variant of the fast filtering algorithm. Significantly slower than using default quality, but results in smoother reflections. Should only be used when the scene is especially detailed.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</member>
<member name="rendering/quality/reflections/ggx_samples" type="int" setter="" getter="" default="1024">
Basic fast filtering implementation
2020-02-21 00:27:34 +01:00
Sets the number of samples to take when using importance sampling for [Sky]s and [ReflectionProbe]s. A higher value will result in smoother, higher quality reflections, but increases time to calculate radiance maps. In general, fewer samples are needed for simpler, low dynamic range environments while more samples are needed for HDR environments and environments with a high level of detail.
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
</member>
<member name="rendering/quality/reflections/ggx_samples.mobile" type="int" setter="" getter="" default="128">
Basic fast filtering implementation
2020-02-21 00:27:34 +01:00
Lower-end override for [member rendering/quality/reflections/ggx_samples] on mobile devices, due to performance concerns or driver support.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Working sky shader implementation
2020-03-20 01:32:19 +01:00
<member name="rendering/quality/reflections/roughness_layers" type="int" setter="" getter="" default="8">
Basic fast filtering implementation
2020-02-21 00:27:34 +01:00
Limits the number of layers to use in radiance maps when using importance sampling. A lower number will be slightly faster and take up less VRAM.
Add project setting for max irradiance size
2020-01-25 20:50:05 +01:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/reflections/texture_array_reflections" type="bool" setter="" getter="" default="true">
Basic fast filtering implementation
2020-02-21 00:27:34 +01:00
If [code]true[/code], uses texture arrays instead of mipmaps for reflection probes and panorama backgrounds (sky). This reduces jitter noise and upscaling artifacts on reflections, but is significantly slower to compute and uses [member rendering/quality/reflections/roughness_layers] times more memory.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/reflections/texture_array_reflections.mobile" type="bool" setter="" getter="" default="false">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Lower-end override for [member rendering/quality/reflections/texture_array_reflections] on mobile devices, due to performance concerns or driver support.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
<member name="rendering/quality/screen_filters/msaa" type="int" setter="" getter="" default="0">
Turn the anisotropic filtering setting into an enum Since it only accepts power-of-two values, exposing it as an enum makes more sense. This also allows for adding property hints to indicate the performance cost of each value. This also improves property hints for MSAA and FXAA.
2020-05-08 12:03:23 +02:00
Sets the number of MSAA samples to use (as a power of two). MSAA is used to reduce aliasing around the edges of polygons. A higher MSAA value results in smoother edges but can be significantly slower on some hardware.
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
[b]Note:[/b] MSAA is not available on HTML5 export using the GLES2 backend.
</member>
<member name="rendering/quality/screen_filters/screen_space_aa" type="int" setter="" getter="" default="0">
Sets the screen-space antialiasing mode for the default screen [Viewport]. Screen-space antialiasing works by selectively blurring edges in a post-process shader. It differs from MSAA which takes multiple coverage samples while rendering objects. Screen-space AA methods are typically faster than MSAA and will smooth out specular aliasing, but tend to make scenes appear blurry.
Environment: Refactor code for readability + more - Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:18:13 +02:00
Another way to combat specular aliasing is to enable [member rendering/quality/screen_filters/screen_space_roughness_limiter_enabled].
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
</member>
Environment: Refactor code for readability + more - Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:18:13 +02:00
<member name="rendering/quality/screen_filters/screen_space_roughness_limiter_amount" type="float" setter="" getter="" default="0.25">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
</member>
Environment: Refactor code for readability + more - Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:18:13 +02:00
<member name="rendering/quality/screen_filters/screen_space_roughness_limiter_enabled" type="bool" setter="" getter="" default="true">
</member>
<member name="rendering/quality/screen_filters/screen_space_roughness_limiter_limit" type="float" setter="" getter="" default="0.18">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
</member>
doc: Sync classref with current source
2020-04-03 10:11:23 +02:00
<member name="rendering/quality/screen_space_reflection/roughness_quality" type="int" setter="" getter="" default="1">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Sets the quality for rough screen-space reflections. Turning off will make all screen space reflections sharp, while higher values make rough reflections look better.
doc: Sync classref with current source
2020-04-03 10:11:23 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shading/force_blinn_over_ggx" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], uses faster but lower-quality Blinn model to generate blurred reflections instead of the GGX model.
Update class documentation xml
2018-10-07 15:52:07 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shading/force_blinn_over_ggx.mobile" type="bool" setter="" getter="" default="true">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Lower-end override for [member rendering/quality/shading/force_blinn_over_ggx] on mobile devices, due to performance concerns or driver support.
Update class documentation xml
2018-10-07 15:52:07 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shading/force_lambert_over_burley" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], uses faster but lower-quality Lambert material lighting model instead of Burley.
Update class documentation xml
2018-10-07 15:52:07 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shading/force_lambert_over_burley.mobile" type="bool" setter="" getter="" default="true">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Lower-end override for [member rendering/quality/shading/force_lambert_over_burley] on mobile devices, due to performance concerns or driver support.
Update class documentation xml
2018-10-07 15:52:07 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shading/force_vertex_shading" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], forces vertex shading for all rendering. This can increase performance a lot, but also reduces quality immensely. Can be used to optimize performance on low-end mobile devices.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shading/force_vertex_shading.mobile" type="bool" setter="" getter="" default="true">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Lower-end override for [member rendering/quality/shading/force_vertex_shading] on mobile devices, due to performance concerns or driver support.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shadow_atlas/quadrant_0_subdiv" type="int" setter="" getter="" default="1">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Subdivision quadrant size for shadow mapping. See shadow mapping documentation.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shadow_atlas/quadrant_1_subdiv" type="int" setter="" getter="" default="2">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Subdivision quadrant size for shadow mapping. See shadow mapping documentation.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shadow_atlas/quadrant_2_subdiv" type="int" setter="" getter="" default="3">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Subdivision quadrant size for shadow mapping. See shadow mapping documentation.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shadow_atlas/quadrant_3_subdiv" type="int" setter="" getter="" default="4">
Style fixes for commit d5bb6faa
2018-06-13 14:42:55 +02:00
Subdivision quadrant size for shadow mapping. See shadow mapping documentation.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shadow_atlas/size" type="int" setter="" getter="" default="4096">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Size for shadow atlas (used for OmniLights and SpotLights). See documentation.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/quality/shadow_atlas/size.mobile" type="int" setter="" getter="" default="2048">
doc: Document all remaining ProjectSettings
2020-01-26 13:37:13 +01:00
Lower-end override for [member rendering/quality/shadow_atlas/size] on mobile devices, due to performance concerns or driver support.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add proper quality settings to soft shadows
2020-04-10 11:30:36 +02:00
<member name="rendering/quality/shadows/soft_shadow_quality" type="int" setter="" getter="" default="2">
Quality setting for shadows cast by [OmniLight3D]s and [SpotLight3D]s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
Add proper quality settings to soft shadows
2020-04-10 11:30:36 +02:00
<member name="rendering/quality/shadows/soft_shadow_quality.mobile" type="int" setter="" getter="" default="0">
Lower-end override for [member rendering/quality/shadows/soft_shadow_quality] on mobile devices, due to performance concerns or driver support.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="rendering/quality/ssao/half_size" type="bool" setter="" getter="" default="false">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
If [code]true[/code], screen-space ambient occlusion will be rendered at half size and then upscaled before being added to the scene. This is significantly faster but may miss small details.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="rendering/quality/ssao/quality" type="int" setter="" getter="" default="1">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Sets the quality of the screen-space ambient occlusion effect. Higher values take more samples and so will result in better quality, at the cost of performance.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
i18n: Sync translate template for class reference Adds initial fr.po translation for initialization on Weblate.
2020-04-07 09:56:01 +02:00
<member name="rendering/quality/subsurface_scattering/subsurface_scattering_depth_scale" type="float" setter="" getter="" default="0.01">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Scales the depth over which the subsurface scattering effect is applied. A high value may allow light to scatter into a part of the mesh or another mesh that is close in screen space but far in depth.
i18n: Sync translate template for class reference Adds initial fr.po translation for initialization on Weblate.
2020-04-07 09:56:01 +02:00
</member>
<member name="rendering/quality/subsurface_scattering/subsurface_scattering_quality" type="int" setter="" getter="" default="1">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Sets the quality of the subsurface scattering effect. Higher values are slower but look nicer.
i18n: Sync translate template for class reference Adds initial fr.po translation for initialization on Weblate.
2020-04-07 09:56:01 +02:00
</member>
<member name="rendering/quality/subsurface_scattering/subsurface_scattering_scale" type="float" setter="" getter="" default="0.05">
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
Scales the distance over which samples are taken for subsurface scattering effect. Changing this does not impact performance, but higher values will result in significant artifacts as the samples will become obviously spread out. A lower value results in a smaller spread of scattered light.
</member>
Turn the anisotropic filtering setting into an enum Since it only accepts power-of-two values, exposing it as an enum makes more sense. This also allows for adding property hints to indicate the performance cost of each value. This also improves property hints for MSAA and FXAA.
2020-05-08 12:03:23 +02:00
<member name="rendering/quality/texture_filters/anisotropic_filtering_level" type="int" setter="" getter="" default="2">
Sets the maximum number of samples to take when using anisotropic filtering on textures (as a power of two). A higher sample count will result in sharper textures at oblique angles, but is more expensive to compute. A value of [code]0[/code] forcibly disables anisotropic filtering, even on materials where it is enabled.
Update many docs with recent rendering changes
2020-04-17 01:05:25 +02:00
</member>
<member name="rendering/quality/texture_filters/use_nearest_mipmap_filter" type="bool" setter="" getter="" default="false">
If [code]true[/code], uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If [code]false[/code], linear mipmap filtering (also called "trilinear filtering") is used.
i18n: Sync translate template for class reference Adds initial fr.po translation for initialization on Weblate.
2020-04-07 09:56:01 +02:00
</member>
Environment: Refactor code for readability + more - Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:18:13 +02:00
<member name="rendering/sdfgi/frames_to_converge" type="int" setter="" getter="" default="1">
</member>
<member name="rendering/sdfgi/probe_ray_count" type="int" setter="" getter="" default="2">
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/threads/thread_model" type="int" setter="" getter="" default="1">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source
2020-08-31 11:25:11 +02:00
<member name="rendering/volumetric_fog/directional_shadow_shrink" type="int" setter="" getter="" default="512">
</member>
<member name="rendering/volumetric_fog/positional_shadow_shrink" type="int" setter="" getter="" default="512">
</member>
<member name="rendering/volumetric_fog/use_filter" type="int" setter="" getter="" default="0">
</member>
<member name="rendering/volumetric_fog/volume_depth" type="int" setter="" getter="" default="128">
</member>
<member name="rendering/volumetric_fog/volume_size" type="int" setter="" getter="" default="64">
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/vram_compression/import_bptc" type="bool" setter="" getter="" default="false">
Remove obsolete GLES3 backend Due to the port to Vulkan and complete redesign of the rendering backend, the `drivers/gles3` code is no longer usable in this state and is not planned to be ported to the new architecture. The GLES2 backend is kept (while still disabled and non-working) as it will eventually be ported to serve as the low-end renderer for Godot 4.0. Some GLES3 features might be selectively ported to the updated GLES2 backend if there's a need for them, and extensions we can use for that. So long, OpenGL driver bugs!
2020-02-13 10:08:52 +01:00
If [code]true[/code], the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the Vulkan renderer.
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/vram_compression/import_etc" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression algorithm. This algorithm doesn't support alpha channels in textures.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/vram_compression/import_etc2" type="bool" setter="" getter="" default="true">
Remove obsolete GLES3 backend Due to the port to Vulkan and complete redesign of the rendering backend, the `drivers/gles3` code is no longer usable in this state and is not planned to be ported to the new architecture. The GLES2 backend is kept (while still disabled and non-working) as it will eventually be ported to serve as the low-end renderer for Godot 4.0. Some GLES3 features might be selectively ported to the updated GLES2 backend if there's a need for them, and extensions we can use for that. So long, OpenGL driver bugs!
2020-02-13 10:08:52 +01:00
If [code]true[/code], the texture importer will import VRAM-compressed textures using the Ericsson Texture Compression 2 algorithm. This texture compression algorithm is only supported when using the Vulkan renderer.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/vram_compression/import_pvrtc" type="bool" setter="" getter="" default="false">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], the texture importer will import VRAM-compressed textures using the PowerVR Texture Compression algorithm. This texture compression algorithm is only supported on iOS.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="rendering/vram_compression/import_s3tc" type="bool" setter="" getter="" default="true">
Improve the ProjectSettings documentation
2019-04-11 15:56:40 +02:00
If [code]true[/code], the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm. This algorithm is only supported on desktop platforms and consoles.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="rendering/vulkan/descriptor_pools/max_descriptors_per_pool" type="int" setter="" getter="" default="64">
</member>
<member name="rendering/vulkan/staging_buffer/block_size_kb" type="int" setter="" getter="" default="256">
</member>
<member name="rendering/vulkan/staging_buffer/max_size_mb" type="int" setter="" getter="" default="128">
</member>
<member name="rendering/vulkan/staging_buffer/texture_upload_region_size_px" type="int" setter="" getter="" default="64">
</member>
Expose the cell_size affecting VisibilityNotifier2D precision Refs: #4803
2020-04-28 09:25:07 +02:00
<member name="world/2d/cell_size" type="int" setter="" getter="" default="100">
Clarify that 2D cell sizes are defined in pixels See https://github.com/godotengine/godot/issues/40577#issuecomment-662329021.
2020-09-15 14:06:42 +02:00
Cell size used for the 2D hash grid that [VisibilityNotifier2D] uses (in pixels).
Expose the cell_size affecting VisibilityNotifier2D precision Refs: #4803
2020-04-28 09:25:07 +02:00
</member>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-11 18:41:16 +02:00
</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
<constants>
</constants>
</class>
Reference in a new issue Copy permalink