ProjectSettings¶
Inherits: Object
Contains global variables accessible from everywhere.
Description¶
Contains global variables accessible from everywhere. Use get_setting, set_setting or has_setting to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options.
When naming a Project Settings property, use the full path to the setting including the category. For example, "application/config/name" for the project name. Category and property names can be viewed in the Project Settings dialog.
Feature tags: Project settings can be overridden for specific platforms and configurations (debug, release, ...) using feature tags.
Overriding: Any project setting can be overridden by creating a file named override.cfg 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. Overriding will still take the base project settings' feature tags in account. Therefore, make sure to also override the setting with the desired feature tags if you want them to override base project settings on all platforms and configurations.
Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
rendering/batching/parameters/colored_vertex_format_threshold |
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
rendering/limits/buffers/canvas_polygon_index_buffer_size_kb |
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
rendering/quality/intended_usage/framebuffer_allocation.mobile |
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
rendering/quality/reflections/texture_array_reflections.mobile |
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods¶
void |
add_property_info ( Dictionary hint ) |
void |
|
get_setting ( String name ) const |
|
globalize_path ( String path ) const |
|
has_setting ( String name ) const |
|
load_resource_pack ( String pack, bool replace_files=true, int offset=0 ) |
|
localize_path ( String path ) const |
|
property_can_revert ( String name ) |
|
property_get_revert ( String name ) |
|
save ( ) |
|
save_custom ( String file ) |
|
void |
set_initial_value ( String name, Variant value ) |
void |
|
void |
set_setting ( String name, Variant value ) |
Property Descriptions¶
String android/modules
Default |
|
Comma-separated list of custom Android modules (which must have been built in the Android export templates) using their Java package path, e.g. "org/godotengine/godot/MyCustomSingleton,com/example/foo/FrenchFriesFactory".
Note: Since Godot 3.2.2, the org/godotengine/godot/GodotPaymentV3 module was deprecated and replaced by the GodotPayment plugin which should be enabled in the Android export preset under Plugins section. The singleton to access in code was also renamed to GodotPayment.
Color application/boot_splash/bg_color
Default |
|
Background color for the boot splash.
bool application/boot_splash/fullsize
Default |
|
If true, scale the boot splash image to the full window length when engine starts. If false, the engine will leave it at the default pixel size.
String application/boot_splash/image
Default |
|
Path to an image used as the boot splash.
bool application/boot_splash/use_filter
Default |
|
If true, applies linear filtering when scaling the image (recommended for high resolution artwork). If false, uses nearest-neighbor interpolation (recommended for pixel art).
String application/config/custom_user_dir_name
Default |
|
This user directory is used for storing persistent data (user:// filesystem). If left empty, user:// resolves to a project-specific folder in Godot's own configuration folder (see 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 OS.get_user_data_dir).
The application/config/use_custom_user_dir setting must be enabled for this to take effect.
String application/config/description
Default |
|
The project's description, displayed as a tooltip in the Project Manager when hovering the project.
String application/config/icon
Default |
|
Icon used for the project, set when project loads. Exporters will also use this icon when possible.
String application/config/macos_native_icon
Default |
|
Icon set in .icns format used on macOS to set the game's icon. This is done automatically on start by calling OS.set_native_icon.
String application/config/name
Default |
|
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.
Note: Changing this value will also change the user data folder's path if application/config/use_custom_user_dir is false. After renaming the project, you will no longer be able to access existing data in user:// unless you rename the old folder to match the new project name. See Data paths in the documentation for more information.
String application/config/project_settings_override
Default |
|
Specifies a file to override project settings. For example: user://custom_settings.cfg. See "Overriding" in the ProjectSettings class description at the top for more information.
Note: Regardless of this setting's value, res://override.cfg will still be read to override the project settings.
bool application/config/use_custom_user_dir
Default |
|
If true, the project will save user data to its own user directory (see application/config/custom_user_dir_name). This setting is only effective on desktop platforms. A name must be set in the application/config/custom_user_dir_name setting for this to take effect. If false, the project will save user data to (OS user data directory)/Godot/app_userdata/(project name).
Default |
|
If true, the project will use a hidden directory (.import) for storing project-specific data (metadata, shader cache, etc.).
If false, a non-hidden directory (import) will be used instead.
Note: Restart the application after changing this setting.
Note: Changing this value can help on platforms or with third-party tools where hidden directory patterns are disallowed. Only modify this setting if you know that your environment requires it, as changing the default can impact compatibility with some external tools or plugins which expect the default .import folder.
String application/config/windows_native_icon
Default |
|
Icon set in .ico format used on Windows to set the game's icon. This is done automatically on start by calling OS.set_native_icon.
bool application/run/delta_smoothing
Default |
|
Time samples for frame deltas are subject to random variation introduced by the platform, even when frames are displayed at regular intervals thanks to V-Sync. This can lead to jitter. Delta smoothing can often give a better result by filtering the input deltas to correct for minor fluctuations from the refresh rate.
Note: Delta smoothing is only attempted when display/window/vsync/use_vsync is switched on, as it does not work well without V-Sync.
It may take several seconds at a stable frame rate before the smoothing is initially activated. It will only be active on machines where performance is adequate to render frames at the refresh rate.
bool application/run/delta_sync_after_draw
Default |
|
Experimental. Shifts the measurement of delta time for each frame to just after the drawing has taken place. This may lead to more consistent deltas and a reduction in frame stutters.
bool application/run/disable_stderr
Default |
|
If true, disables printing to standard error. If true, this also hides error and warning messages printed by @GDScript.push_error and @GDScript.push_warning. See also application/run/disable_stdout.
Changes to this setting will only be applied upon restarting the application.
bool application/run/disable_stdout
Default |
|
If true, disables printing to standard output. This is equivalent to starting the editor or project with the --quiet command line argument. See also application/run/disable_stderr.
Changes to this setting will only be applied upon restarting the application.
bool application/run/flush_stdout_on_print
Default |
|
If true, flushes the standard output stream every time a line is printed. This affects both terminal logging and file logging.
When running a project, this setting must be enabled if you want logs to be collected by service managers such as systemd/journalctl. This setting is disabled by default on release builds, since flushing on every printed line will negatively affect performance if lots of lines are printed in a rapid succession. Also, if this setting is enabled, logged files will still be written successfully if the application crashes or is otherwise killed by the user (without being closed "normally").
Note: Regardless of this setting, the standard error stream (stderr) is always flushed when a line is printed to it.
Changes to this setting will only be applied upon restarting the application.
bool application/run/flush_stdout_on_print.debug
Default |
|
Debug build override for application/run/flush_stdout_on_print, as performance is less important during debugging.
Changes to this setting will only be applied upon restarting the application.
int application/run/frame_delay_msec
Default |
|
Forces a delay between frames in the main loop (in milliseconds). This may be useful if you plan to disable vertical synchronization.
bool application/run/low_processor_mode
Default |
|
If true, 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.
int application/run/low_processor_mode_sleep_usec
Default |
|
Amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage.
String application/run/main_scene
Default |
|
Path to the main scene file that will be loaded when the project runs.
float audio/channel_disable_threshold_db
Default |
|
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.
float audio/channel_disable_time
Default |
|
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.
String audio/default_bus_layout
Default |
|
Default AudioBusLayout resource file to use in the project, unless overridden by the scene.
String audio/driver
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.
bool audio/enable_audio_input
Default |
|
If true, microphone input will be allowed. This requires appropriate permissions to be set when exporting to Android or iOS.
int audio/mix_rate
Default |
|
The mixing rate used for audio (in Hz). In general, it's better to not touch this and leave it to the host operating system.
int audio/mix_rate.web
Default |
|
Safer override for audio/mix_rate in the Web platform. Here 0 means "let the browser choose" (since some browsers do not like forcing the mix rate).
int audio/output_latency
Default |
|
Specifies the preferred 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.
Audio output latency may be constrained by the host operating system and audio hardware drivers. If the host can not provide the specified audio output latency then Godot will attempt to use the nearest latency allowed by the host. As such you should always use AudioServer.get_output_latency to determine the actual audio output latency.
Note: This setting is ignored on Windows.
int audio/output_latency.web
Default |
|
Safer override for audio/output_latency in the Web platform, to avoid audio issues especially on mobile devices.
int audio/video_delay_compensation_ms
Default |
|
Setting to hardcode audio delay when playing video. Best to leave this untouched unless you know what you are doing.
int compression/formats/gzip/compression_level
Default |
|
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. -1 uses the default gzip compression level, which is identical to 6 but could change in the future due to underlying zlib updates.
int compression/formats/zlib/compression_level
Default |
|
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. -1 uses the default gzip compression level, which is identical to 6 but could change in the future due to underlying zlib updates.
int compression/formats/zstd/compression_level
Default |
|
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.
bool compression/formats/zstd/long_distance_matching
Default |
|
Enables long-distance matching in Zstandard.
int compression/formats/zstd/window_log_size
Default |
|
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.
bool debug/gdscript/completion/autocomplete_setters_and_getters
Default |
|
If true, 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.
bool debug/gdscript/warnings/constant_used_as_function
Default |
|
If true, enables warnings when a constant is used as a function.
bool debug/gdscript/warnings/deprecated_keyword
Default |
|
If true, enables warnings when deprecated keywords such as slave are used.
bool debug/gdscript/warnings/enable
Default |
|
If true, enables specific GDScript warnings (see debug/gdscript/warnings/* settings). If false, disables all GDScript warnings.
bool debug/gdscript/warnings/exclude_addons
Default |
|
If true, scripts in the res://addons folder will not generate warnings.
bool debug/gdscript/warnings/function_conflicts_constant
Default |
|
If true, enables warnings when a function is declared with the same name as a constant.
bool debug/gdscript/warnings/function_conflicts_variable
Default |
|
If true, enables warnings when a function is declared with the same name as a variable. This will turn into an error in a future version when first-class functions become supported in GDScript.
bool debug/gdscript/warnings/function_may_yield
Default |
|
If true, enables warnings when a function assigned to a variable may yield and return a function state instead of a value.
bool debug/gdscript/warnings/function_used_as_property
Default |
|
If true, enables warnings when using a function as if it was a property.
bool debug/gdscript/warnings/incompatible_ternary
Default |
|
If true, enables warnings when a ternary operator may emit values with incompatible types.
bool debug/gdscript/warnings/integer_division
Default |
|
If true, enables warnings when dividing an integer by another integer (the decimal part will be discarded).
bool debug/gdscript/warnings/narrowing_conversion
Default |
|
If true, enables warnings when passing a floating-point value to a function that expects an integer (it will be converted and lose precision).
bool debug/gdscript/warnings/property_used_as_function
Default |
|
If true, enables warnings when using a property as if it was a function.
bool debug/gdscript/warnings/return_value_discarded
Default |
|
If true, 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 Error enum.
bool debug/gdscript/warnings/shadowed_variable
Default |
|
If true, enables warnings when defining a local or subclass member variable that would shadow a variable at an upper level (such as a member variable).
bool debug/gdscript/warnings/standalone_expression
Default |
|
If true, enables warnings when calling an expression that has no effect on the surrounding code, such as writing 2 + 2 as a statement.
bool debug/gdscript/warnings/standalone_ternary
Default |
|
If true, enables warnings when calling a ternary expression that has no effect on the surrounding code, such as writing 42 if active else 0 as a statement.
bool debug/gdscript/warnings/treat_warnings_as_errors
Default |
|
If true, all warnings will be reported as if they were errors.