Helper class to handle INI-style files.
    public class ConfigFile : Reference

This helper class can be used to store Variant values on the filesystem using INI-style formatting. The stored values are identified by a section and a key:

[codeblock]

[section]

some_key=42

string_example=”Hello World!”

a_vector=Vector3( 1, 0, 2 )

[/codeblock]

The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly without accessing the filesystem.

The following example shows how to parse an INI-style file from the system, read its contents and store new values in it:

[codeblock]

var config = ConfigFile.new()

var err = config.load(“user://settings.cfg”)

if err == OK: # if not, something went wrong with the file loading

Look for the display/width pair, and default to 1024 if missing

var screen_width = config.get_value(“display”, “width”, 1024)

Store a variable if and only if it hasn’t been defined yet

if not config.has_section_key(“audio”, “mute”):

config.set_value(“audio”, “mute”, false)

Save the changes by overwriting the previous file

config.save(“user://settings.cfg”)

[/codeblock]

Keep in mind that section and property names can’t contain spaces. Anything after a space will be ignored on save and on load.

Inheritance Chain

Constructors

    public ConfigFile()

Methods

    public void EraseSection(string section)

Deletes the specified section along with all the key-value pairs inside.

    public string[] GetSectionKeys(string section)

Returns an array of all defined key identifiers in the specified section.

    public string[] GetSections()

Returns an array of all defined section identifiers.

    public object GetValue(string section, string key, object @default = null)

Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional default argument, or null if it is omitted.

    public bool HasSection(string section)

Returns true if the specified section exists.

    public bool HasSectionKey(string section, string key)

Returns true if the specified section-key pair exists.

    public Error Load(string path)

Loads the config file specified as a parameter. The file’s contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the OK, FAILED or ERR_* constants listed in [@GlobalScope]. If the load was successful, the return value is OK.

    public Error Save(string path)

Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the OK, FAILED or ERR_* constants listed in [@GlobalScope]. If the load was successful, the return value is OK.

    public void SetValue(string section, string key, object value)

Assigns a value to the specified key of the specified section. If the section and/or the key do not exist, they are created. Passing a null value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.

Tags: