mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-09 10:09:20 +08:00
Code Issues Packages Projects Releases Wiki Activity
4d228e66b4
godot/doc/classes/ProjectSettings.xml

757 lines
38 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-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Remove status from hardcoded version string It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 20:40:43 +08:00
<class name="ProjectSettings" inherits="Object" category="Core" version="3.1">
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-13 04:42:36 +08:00
<brief_description>
Contains global variables accessible from everywhere.
</brief_description>
<description>
Update ProjectSettings description to correct usage Fix #16078
2018-01-26 16:17:53 +08:00
Contains global variables accessible from everywhere. Use "ProjectSettings.get_setting(variable)", "ProjectSettings.set_setting(variable,value)" or "ProjectSettings.has_setting(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options.
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-13 04:42:36 +08:00
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="add_property_info">
<return type="void">
</return>
<argument index="0" name="hint" type="Dictionary">
</argument>
<description>
doc: Rename "@Global Scope" to "@GlobalScope" Spaces in filenames are evil.
2017-11-16 01:45:34 +08:00
Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String].
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-13 04:42:36 +08:00
Example:
[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>
Clear the whole configuration (not recommended, may break things).
</description>
</method>
<method name="get_order" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Return the order of a configuration value (influences when saved to the config file).
</description>
</method>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-12 05:54:43 +08:00
<method name="get_setting" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</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-13 04:42:36 +08:00
<method name="globalize_path" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Convert a localized path (res://) to a full native OS path.
</description>
</method>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-12 05:54:43 +08: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-13 04:42:36 +08:00
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Return true if a configuration value is present.
</description>
</method>
<method name="load_resource_pack">
<return type="bool">
</return>
<argument index="0" name="pack" type="String">
</argument>
<description>
</description>
</method>
<method name="localize_path" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Convert a path to a localized path (res:// path).
</description>
</method>
<method name="property_can_revert">
<return type="bool">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="property_get_revert">
<return type="Variant">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="save">
<return type="int" enum="Error">
</return>
<description>
</description>
</method>
<method name="save_custom">
<return type="int" enum="Error">
</return>
<argument index="0" name="file" type="String">
</argument>
<description>
</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>
</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 21:37:49 +08: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-13 04:42:36 +08:00
</argument>
<description>
Set the order of a configuration value (influences when saved to the config file).
</description>
</method>
doc: Sync classref with current source Ensure that s/fixed_process/physics_process/ is handled properly. [ci skip]
2017-10-12 05:54:43 +08: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>
</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-13 04:42:36 +08:00
</methods>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
<members>
<member name="application/boot_splash/fullsize" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Scale the boot splash image to the full window length when engine starts (will leave it as default pixel size otherwise).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="application/boot_splash/image" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Path to an image used for boot splash.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="application/config/custom_user_dir_name" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
This directory is used for storing persistent data (user:// filesystem). If a custom name is set, then system paths will be used to store this on Desktop (AppData on Windows, user ~/.config on Unixes, etc), else the Godot config folder is used. This name needs to be unique, and it's recommended to set it to something before publishing.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
the "use_custom_user_dir" setting must be enabled for this to take effect.
</member>
<member name="application/config/icon" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Icon used for the project, set when project loads. Exporters will use this icon when possible to.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="application/config/name" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Name of the project. It is used from both project manager and by the exporters. Overriding this as name.locale allows setting it in multiple languages.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="application/config/use_custom_user_dir" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Allow the project to save to it's own custom user dir (in AppData on windows or ~/.config on unixes). This setting only works for desktop exporters. A name must be set in the "custom_user_dir_name" setting 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-12 00:41:16 +08:00
</member>
<member name="application/run/disable_stderr" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Disable printing to stderr on exported build.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="application/run/disable_stdout" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Disable printing to stdout on exported build.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="application/run/frame_delay_msec" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Force a delay between frames in the main loop. This may be useful if you plan to disable vsync.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="application/run/low_processor_mode" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Turn on low processor mode. This setting only works on desktops. 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) on games.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="application/run/low_processor_mode_sleep_usec" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Amount of sleeping between frames when the low_processor_mode is enabled. This effectively reduces CPU usage when this mode is enabled.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="application/run/main_scene" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="audio/channel_disable_threshold_db" type="float" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="audio/channel_disable_time" type="float" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="audio/driver" type="String" setter="" getter="">
</member>
<member name="audio/mix_rate" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Mix rate used for audio. In general, it's better to not touch this and leave it to the host operating system.
</member>
<member name="audio/output_latency" type="int" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="audio/video_delay_compensation_ms" type="int" setter="" getter="">
Misc. typos Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
2018-09-13 09:38:39 +08: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-12 00:41:16 +08:00
</member>
<member name="compression/formats/gzip/compression_level" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Default compression level for gzip. Affects compressed scenes and resources.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="compression/formats/zlib/compression_level" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Default compression level for zlib. Affects compressed scenes and resources.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="compression/formats/zstd/compression_level" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Default compression level for zstd. Affects compressed scenes and resources.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="compression/formats/zstd/long_distance_matching" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Enable long distance matching in zstd.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="compression/formats/zstd/window_log_size" type="int" setter="" getter="">
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="debug/gdscript/warnings/constant_used_as_function" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/enable" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/function_conflicts_constant" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/function_conflicts_variable" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/function_may_yield" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/function_used_as_property" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/incompatible_ternary" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/integer_division" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/narrowing_conversion" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/property_used_as_function" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/treat_warnings_as_errors" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unassigned_variable" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unassigned_variable_op_assign" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unreachable_code" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unsafe_call_argument" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unsafe_cast" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unsafe_method_access" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unsafe_property_access" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unused_argument" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unused_class_variable" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unused_signal" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/unused_variable" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/variable_conflicts_function" type="bool" setter="" getter="">
</member>
<member name="debug/gdscript/warnings/void_assignment" type="bool" setter="" getter="">
</member>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
<member name="debug/settings/crash_handler/message" type="String" setter="" getter="">
</member>
<member name="debug/settings/fps/force_fps" type="int" setter="" getter="">
</member>
<member name="debug/settings/gdscript/max_call_stack" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="debug/settings/profiler/max_functions" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="debug/settings/stdout/print_fps" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Print frames per second to stdout. Not very useful in general.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="debug/settings/stdout/verbose_stdout" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Print more information to stdout when running. It shows info 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-12 00:41:16 +08:00
</member>
<member name="debug/settings/visual_script/max_call_stack" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="display/mouse_cursor/custom_image" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Custom image for the mouse cursor.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="display/mouse_cursor/custom_image_hotspot" type="Vector2" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="display/window/allow_per_pixel_transparency" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Allow per pixel transparency in a Desktop window. This affects performance if not needed, so leave it off.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="display/window/dpi/allow_hidpi" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Allow HiDPI display on Windows and OSX. On Desktop Linux, this can't be enabled or disabled.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="display/window/energy_saving/keep_screen_on" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Force keep the screen on, so the screensaver does not take over. Works on Desktop and Mobile.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="display/window/handheld/orientation" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Default orientation for cell phone or tablet.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="display/window/per_pixel_transparency" type="bool" setter="" getter="">
</member>
<member name="display/window/per_pixel_transparency_splash" type="bool" setter="" getter="">
</member>
<member name="display/window/size/always_on_top" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="display/window/size/borderless" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="display/window/size/fullscreen" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Set 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-12 00:41:16 +08:00
</member>
<member name="display/window/size/height" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Set the main window height. On desktop, this is the default window size. Stretch mode settings use this also 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-12 00:41:16 +08:00
</member>
<member name="display/window/size/resizable" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Allow 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-12 00:41:16 +08:00
</member>
<member name="display/window/size/test_height" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Test a different height for the window. The main use for this is to test with stretch modes.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="display/window/size/test_width" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Test a different width for the window. The main use for this is to test with stretch modes.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="display/window/size/width" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Set the main window width. On desktop, this is the default window size. Stretch mode settings use this also 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-12 00:41:16 +08:00
</member>
<member name="display/window/vsync/use_vsync" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Use VSync. Don't be stupid, don't turn this off.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="editor/active" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Internal editor setting, don't touch.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="gui/common/default_scroll_deadzone" type="int" setter="" getter="">
</member>
<member name="gui/common/swap_ok_cancel" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Enable swap OK and Cancel buttons on dialogs. This is because Windows/MacOS/Desktop Linux may use them in different order, so the GUI swaps them depending on the host OS. Disable this behavior by turning this setting off.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="gui/theme/custom" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Use a custom theme resource, set a path to it here.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="gui/theme/custom_font" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
USe a custom default font resource, set a path to it here.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="gui/theme/use_hidpi" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Make 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-12 00:41:16 +08:00
</member>
<member name="gui/timers/incremental_search_max_interval_msec" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Timer setting for incremental search in Tree, IntemList, etc. controls.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="gui/timers/text_edit_idle_detect_sec" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Timer for detecting idle in the editor.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_accept" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_cancel" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_down" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_end" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_focus_next" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_focus_prev" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_home" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_left" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_page_down" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_page_up" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_right" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_select" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<member name="input/ui_up" type="Dictionary" setter="" getter="">
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="input_devices/pointing/emulate_mouse_from_touch" type="bool" setter="" getter="">
</member>
<member name="input_devices/pointing/emulate_touch_from_mouse" type="bool" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_1" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_10" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_11" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_12" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_13" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_14" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_15" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_16" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_17" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_18" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_19" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_2" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_20" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_3" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_4" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_5" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_6" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_7" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_8" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_physics/layer_9" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_1" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_10" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_11" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_12" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_13" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_14" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_15" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_16" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_17" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_18" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_19" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_2" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_20" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_3" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_4" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_5" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_6" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_7" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_8" type="String" setter="" getter="">
</member>
<member name="layer_names/2d_render/layer_9" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_1" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_10" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_11" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_12" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_13" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_14" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_15" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_16" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_17" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_18" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_19" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_2" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_20" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_3" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_4" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_5" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_6" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_7" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_8" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_physics/layer_9" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_1" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_10" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_11" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_12" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_13" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_14" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_15" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_16" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_17" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_18" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_19" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_2" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_20" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_3" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_4" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_5" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_6" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_7" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_8" type="String" setter="" getter="">
</member>
<member name="layer_names/3d_render/layer_9" type="String" setter="" getter="">
</member>
<member name="locale/fallback" type="String" setter="" getter="">
</member>
<member name="locale/test" type="String" setter="" getter="">
</member>
<member name="logging/file_logging/enable_file_logging" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Log all output to a file.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="logging/file_logging/log_path" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Path to logs withint he project. Using an user:// based 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-12 00:41:16 +08:00
</member>
<member name="logging/file_logging/max_log_files" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Amount of log files (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-12 00:41:16 +08:00
</member>
<member name="memory/limits/message_queue/max_size_kb" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
update class docs
2018-09-01 03:12:35 +08:00
<member name="mono/debugger_agent/port" type="int" setter="" getter="">
</member>
<member name="mono/debugger_agent/wait_for_debugger" type="bool" setter="" getter="">
</member>
<member name="mono/debugger_agent/wait_timeout" type="int" setter="" getter="">
</member>
<member name="mono/export/include_scripts_content" type="bool" setter="" getter="">
</member>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
<member name="network/limits/debugger_stdout/max_chars_per_second" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="network/limits/debugger_stdout/max_errors_per_frame" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Maximum amount of errors 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-12 00:41:16 +08:00
</member>
<member name="network/limits/debugger_stdout/max_messages_per_frame" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Maximum amount of messages 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-12 00:41:16 +08:00
</member>
<member name="network/limits/packet_peer_stream/max_buffer_po2" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="network/remote_fs/max_pages" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Maximum amount of pages used for remote filesystem (used by debugging).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="network/remote_fs/page_read_ahead" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Amount of read ahead used by remote filesystem. Improves latency.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="network/remote_fs/page_size" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Page size used by remote filesystem.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="network/ssl/certificates" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
If your game or application uses HTTPS, a certificates file is needed. It must be set here.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="node/name_casing" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
When creating nodes 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-12 00:41:16 +08:00
</member>
<member name="node/name_num_separator" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="physics/2d/physics_engine" type="String" setter="" getter="">
</member>
<member name="physics/2d/thread_model" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Set 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.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 17:56:21 +08:00
<member name="physics/3d/active_soft_world" type="bool" setter="" getter="">
</member>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
<member name="physics/3d/physics_engine" type="String" setter="" getter="">
</member>
<member name="physics/common/physics_fps" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Frames per second used in the physics. Physics always needs a fixed amount of frames per second.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="physics/common/physics_jitter_fix" type="float" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Fix to improve physics jitter, specially on monitors where refresh rate is different than physics FPS.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/environment/default_clear_color" type="Color" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Default background clear color.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/limits/buffers/blend_shape_max_buffer_size_kb" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Max buffer size for blend shapes. Any blend shape bigger than this will not work.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/limits/buffers/canvas_polygon_buffer_size_kb" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Max buffer size for drawing polygons. Any polygon bigger than this will not work.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/limits/buffers/canvas_polygon_index_buffer_size_kb" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Max index buffer size for drawing polygons. Any polygon bigger than this will not work.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/limits/buffers/immediate_buffer_size_kb" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Max buffer size for drawing immediate objects (ImmediateGeometry nodes). Nodes using more than this size will not work.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/limits/rendering/max_renderable_elements" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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 mesh themselves.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/limits/time/time_rollover_secs" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Shaders have a time variable that constantly increases. At some point it needs to be rolled back to zero to avoid numerical errors on shader animations. This setting specifies when.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/2d/use_pixel_snap" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Force 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-12 00:41:16 +08:00
</member>
<member name="rendering/quality/depth_prepass/disable_for_vendors" type="String" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Disable 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-12 00:41:16 +08:00
</member>
<member name="rendering/quality/depth_prepass/enable" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Do 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-12 00:41:16 +08:00
</member>
<member name="rendering/quality/directional_shadow/size" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Size in pixels of the directional shadow.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/directional_shadow/size.mobile" type="int" setter="" getter="">
</member>
Fall back to GLES2 if GLES3 is not working This adds a static is_viable() method to all rasterizers which has to be called before initializing the rasterizer. This allows us to check what rasterizer to use in OS::initialize together with the GL context initialization. This commit also adds a new project setting "rendering/quality/driver/driver_fallback" which allows the creator of a project to specify whether or not fallback to GLES2 is allowed. This setting is ignored for the editor so the editor will always open even if the project itself cannot run. This will hopefully reduce confusion for users downloading projects from the internet. We also no longer crash when GLES3 is not functioning on a platform. This fixes #15324
2018-08-25 06:04:25 +08:00
<member name="rendering/quality/driver/driver_fallback" type="String" setter="" getter="">
Whether to allow falling back to other graphics drivers if the preferred driver is not available. Best means use the best working driver (this is the default). Never means never fall back to another driver even if it does not work. This means the project will not run if the preferred driver does not function.
</member>
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
<member name="rendering/quality/driver/driver_name" type="String" setter="" getter="">
</member>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
<member name="rendering/quality/filters/anisotropic_filter_level" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Maximum Anisotropic filter level used for textures when anisotropy enabled.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/filters/use_nearest_mipmap_filter" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Force to use nearest mipmap filtering when using mipmaps. This may increase performance in mobile as less memory bandwidth is used.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/intended_usage/framebuffer_allocation" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Strategy used for framebuffer allocation. The simpler it is, the less memory it uses (but the least features it supports).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/intended_usage/framebuffer_allocation.mobile" type="int" setter="" getter="">
</member>
<member name="rendering/quality/reflections/high_quality_ggx" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
For reflection probes and panorama backgrounds (sky), use a high amount of samples to create ggx blurred versions (used for roughness).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/reflections/high_quality_ggx.mobile" type="bool" setter="" getter="">
</member>
<member name="rendering/quality/reflections/texture_array_reflections" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
For reflection probes and panorama backgrounds (sky), use a texure array instead of mipmaps. This reduces jitter noise on reflections, but costs more performance and memory.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/reflections/texture_array_reflections.mobile" type="bool" setter="" getter="">
</member>
<member name="rendering/quality/shading/force_vertex_shading" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Force vertex shading for all rendering. This can increase performance a lot, but also reduces quality inmensely. Can work to optimize on very low end mobile.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/shading/force_vertex_shading.mobile" type="bool" setter="" getter="">
</member>
<member name="rendering/quality/shadow_atlas/quadrant_0_subdiv" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="rendering/quality/shadow_atlas/quadrant_1_subdiv" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="rendering/quality/shadow_atlas/quadrant_2_subdiv" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="rendering/quality/shadow_atlas/quadrant_3_subdiv" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08: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-12 00:41:16 +08:00
</member>
<member name="rendering/quality/shadow_atlas/size" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Size for shadow atlas (used for point and omni lights). See documentation.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/shadow_atlas/size.mobile" type="int" setter="" getter="">
</member>
<member name="rendering/quality/shadows/filter_mode" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Shadow filter mode. The more complex the filter, the more memory bandwidth required.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/shadows/filter_mode.mobile" type="int" setter="" getter="">
</member>
<member name="rendering/quality/subsurface_scattering/follow_surface" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Improves quality of subsurface scattering, but cost significantly increases.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/subsurface_scattering/quality" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Quality setting for subsurface scaterring (samples taken).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/subsurface_scattering/scale" type="int" setter="" getter="">
</member>
<member name="rendering/quality/subsurface_scattering/weight_samples" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Weight subsurface scattering samples. Helps to avoid reading samples from unrelated parts of the screen.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/quality/voxel_cone_tracing/high_quality" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Use high quality voxel cone tracing (looks better, but requires a higher end GPU).
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/threads/thread_model" type="int" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
Thread model for rendering. Rendering on a thread can vastly improve performance, but syncinc 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-12 00:41:16 +08:00
</member>
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
<member name="rendering/vram_compression/import_bptc" type="bool" setter="" getter="">
</member>
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
<member name="rendering/vram_compression/import_etc" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
If the project uses this compression (usually low end mobile), texture importer will import these.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/vram_compression/import_etc2" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
If the project uses this compression (usually high end mobile), texture importer will import these.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/vram_compression/import_pvrtc" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
If the project uses this compression (usually iOS), texture importer will import these.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="rendering/vram_compression/import_s3tc" type="bool" setter="" getter="">
Style fixes for commit d5bb6faa
2018-06-13 20:42:55 +08:00
If the project uses this compression (usually Desktop and Consoles), texture importer will import these.
-Make sure that ProjectSettings are properly dumped when dumping docs. -Documented all properties of project settings Update documentation for ProjectSettings
2018-06-12 00:41:16 +08:00
</member>
<member name="script" type="Script" setter="" getter="">
</member>
</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-13 04:42:36 +08:00
<constants>
</constants>
</class>
Reference in New Issue Copy Permalink