ProjectSettings

Documentation

Overview

Package ProjectSettings provides methods for working with ProjectSettings object instances.

Index

• func AddPropertyInfo(hint PropertyInfo)
• func Advanced() class
• func Clear(name string)
• func GetOrder(name string) int
• func GetSetting(name string) any
• func GetSettingWithOverride(name string) any
• func GlobalizePath(path string) string
• func HasSetting(name string) bool
• func LoadResourcePack(pack string) bool
• func LocalizePath(path string) string
• func OnSettingsChanged(cb func())
• func Save() error
• func SaveCustom(file string) error
• func SetAsBasic(name string, basic bool)
• func SetAsInternal(name string, internal_ bool)
• func SetInitialValue(name string, value any)
• func SetOrder(name string, position int)
• func SetRestartIfChanged(name string, restart bool)
• func SetSetting(name string, value any)
• type GlobalClass
  • func GetGlobalClassList() []GlobalClass
• type PropertyInfo

Functions

func AddPropertyInfo

func AddPropertyInfo(hint PropertyInfo)

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] [b]Example:[/b] [codeblocks] [gdscript] 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) [/gdscript] [csharp] ProjectSettings.Singleton.Set("category/property_name", 0);

var propertyInfo = new Godot.Collections.Dictionary

{
    {"name", "category/propertyName"},
    {"type", (int)Variant.Type.Int},
    {"hint", (int)PropertyHint.Enum},
    {"hint_string", "one,two,three"},
};

ProjectSettings.AddPropertyInfo(propertyInfo); [/csharp] [/codeblocks]

func Advanced

func Advanced() class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

func Clear

func Clear(name string)

Clears the whole configuration (not recommended, may break things).

func GetOrder

func GetOrder(name string) int

Returns the order of a configuration value (influences when saved to the config file).

func GetSetting

func GetSetting(name string) any

Returns the value of the setting identified by [param name]. If the setting doesn't exist and [param default_value] is specified, the value of [param default_value] is returned. Otherwise, [code]null[/code] is returned. [b]Example:[/b] [codeblocks] [gdscript] print(ProjectSettings.get_setting("application/config/name")) print(ProjectSettings.get_setting("application/config/custom_description", "No description specified.")) [/gdscript] [csharp] GD.Print(ProjectSettings.GetSetting("application/config/name")); GD.Print(ProjectSettings.GetSetting("application/config/custom_description", "No description specified.")); [/csharp] [/codeblocks] [b]Note:[/b] This method doesn't take potential feature overrides into account automatically. Use [method get_setting_with_override] to handle seamlessly.

func GetSettingWithOverride

func GetSettingWithOverride(name string) any

Similar to [method get_setting], but applies feature tag overrides if any exists and is valid. [b]Example:[/b] If the following setting override exists "application/config/name.windows", and the following code is executed: [codeblocks] [gdscript] print(ProjectSettings.get_setting_with_override("application/config/name")) [/gdscript] [csharp] GD.Print(ProjectSettings.GetSettingWithOverride("application/config/name")); [/csharp] [/codeblocks] Then the overridden setting will be returned instead if the project is running on the [i]Windows[/i] operating system.

func GlobalizePath

func GlobalizePath(path string) string

Returns the absolute, native OS path corresponding to the localized [param path] (starting with [code]res://[/code] or [code]user://[/code]). The returned path will vary depending on the operating system and user preferences. See [url=$DOCS_URL/tutorials/io/data_paths.html]File paths in Godot projects[/url] to see what those paths convert to. See also [method localize_path]. [b]Note:[/b] [method globalize_path] with [code]res://[/code] will not work in an exported project. Instead, prepend the executable's base directory to the path when running from an exported project: [codeblock] var path = "" if OS.has_feature("editor"):

# Running from an editor binary.
# `path` will contain the absolute path to `hello.txt` located in the project root.
path = ProjectSettings.globalize_path("res://hello.txt")

else:

# Running from an exported project.
# `path` will contain the absolute path to `hello.txt` next to the executable.
# This is *not* identical to using `ProjectSettings.globalize_path()` with a `res://` path,
# but is close enough in spirit.
path = OS.get_executable_path().get_base_dir().path_join("hello.txt")

[/codeblock]

func HasSetting

func HasSetting(name string) bool

Returns [code]true[/code] if a configuration value is present.

func LoadResourcePack

func LoadResourcePack(pack string) bool

Loads the contents of the .pck or .zip file specified by [param pack] into the resource filesystem ([code]res://[/code]). Returns [code]true[/code] on success. [b]Note:[/b] If a file from [param pack] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [param pack] unless [param replace_files] is set to [code]false[/code]. [b]Note:[/b] The optional [param offset] parameter can be used to specify the offset in bytes to the start of the resource pack. This is only supported for .pck files.

func LocalizePath

func LocalizePath(path string) string

Returns the localized path (starting with [code]res://[/code]) corresponding to the absolute, native OS [param path]. See also [method globalize_path].

func OnSettingsChanged

func OnSettingsChanged(cb func())

func Save

func Save() error

Saves the configuration to the [code]project.godot[/code] file. [b]Note:[/b] This method is intended to be used by editor plugins, as modified [ProjectSettings] can't be loaded back in the running app. If you want to change project settings in exported projects, use [method save_custom] to save [code]override.cfg[/code] file.

func SaveCustom

func SaveCustom(file string) error

Saves the configuration to a custom file. The file extension must be [code].godot[/code] (to save in text-based [ConfigFile] format) or [code].binary[/code] (to save in binary format). You can also save [code]override.cfg[/code] file, which is also text, but can be used in exported projects unlike other formats.

func SetAsBasic

func SetAsBasic(name string, basic bool)

Defines if the specified setting is considered basic or advanced. Basic settings will always be shown in the project settings. Advanced settings will only be shown if the user enables the "Advanced Settings" option.

func SetAsInternal

func SetAsInternal(name string, internal_ bool)

Defines if the specified setting is considered internal. An internal setting won't show up in the Project Settings dialog. This is mostly useful for addons that need to store their own internal settings without exposing them directly to the user.

func SetInitialValue

func SetInitialValue(name string, value any)

Sets the specified setting's initial value. This is the value the setting reverts to.

func SetOrder

func SetOrder(name string, position int)

Sets the order of a configuration value (influences when saved to the config file).

func SetRestartIfChanged

func SetRestartIfChanged(name string, restart bool)

Sets whether a setting requires restarting the editor to properly take effect. [b]Note:[/b] This is just a hint to display to the user that the editor must be restarted for changes to take effect. Enabling [method set_restart_if_changed] does [i]not[/i] delay the setting being set when changed.

func SetSetting

func SetSetting(name string, value any)

Sets the value of a setting. [b]Example:[/b] [codeblocks] [gdscript] ProjectSettings.set_setting("application/config/name", "Example") [/gdscript] [csharp] ProjectSettings.SetSetting("application/config/name", "Example"); [/csharp] [/codeblocks] This can also be used to erase custom project settings. To do this change the setting value to [code]null[/code].

Types

type GlobalClass

type GlobalClass struct {
	Base     string `gd:"base"`
	Class    string `gd:"class"`
	Icon     string `gd:"icon"`
	Language string `gd:"language"`
	Path     string `gd:"path"`
}

func GetGlobalClassList

func GetGlobalClassList() []GlobalClass

Returns an [Array] of registered global classes. Each global class is represented as a [Dictionary] that contains the following entries: - [code]base[/code] is a name of the base class; - [code]class[/code] is a name of the registered global class; - [code]icon[/code] is a path to a custom icon of the global class, if it has any; - [code]language[/code] is a name of a programming language in which the global class is written; - [code]path[/code] is a path to a file containing the global class. [b]Note:[/b] Both the script and the icon paths are local to the project filesystem, i.e. they start with [code]res://[/code].

type PropertyInfo

type PropertyInfo struct {
	ClassName  string       `gd:"class_name"`
	Name       string       `gd:"name"`
	Hint       int          `gd:"hint"`
	HintString string       `gd:"hint_string"`
	Type       reflect.Type `gd:"type"`
	Usage      int          `gd:"usage"`
}