ConfigFile

Inherits: Reference < Object

Helper class to handle INI-style files.

Description

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:

[section]
some_key=42
string_example="Hello World!"
a_vector=Vector3( 1, 0, 2 )

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:

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")

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

ConfigFiles can also contain manually written comment lines starting with a semicolon (;). Those lines will be ignored when parsing the file. Note that comments will be lost when saving the ConfigFile. This can still be useful for dedicated server configuration files, which are typically never overwritten without explicit user action.

Methods

Method Descriptions

• void clear ( )

• void erase_section ( String section )

Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist.

• void erase_section_key ( String section, String key )

Deletes the specified key in a section. Raises an error if either the section or the key do not exist.

• PoolStringArray get_section_keys ( String section ) const

Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist.

• PoolStringArray get_sections ( ) const

Returns an array of all defined section identifiers.

• Variant get_value ( String section, String key, Variant default=null ) const

Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback default value. If default is not specified or set to null, an error is also raised.

• bool has_section ( String section ) const

Returns true if the specified section exists.

• bool has_section_key ( String section, String key ) const

Returns true if the specified section-key pair exists.

• 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 Error code constants (OK on success).

• Error load_encrypted ( String path, PoolByteArray key )

Loads the encrypted config file specified as a parameter, using the provided key to decrypt it. The file’s contents are parsed and loaded in the ConfigFile object which the method was called on.

Returns one of the Error code constants (OK on success).

• Error load_encrypted_pass ( String path, String password )

Loads the encrypted config file specified as a parameter, using the provided password to decrypt it. The file’s contents are parsed and loaded in the ConfigFile object which the method was called on.

Returns one of the Error code constants (OK on success).

• Error parse ( String data )

Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on.

Returns one of the Error code constants (OK on success).

• 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 Error code constants (OK on success).

• Error save_encrypted ( String path, PoolByteArray key )

Saves the contents of the ConfigFile object to the AES-256 encrypted file specified as a parameter, using the provided key to encrypt it. The output file uses an INI-style structure.

Returns one of the Error code constants (OK on success).

• Error save_encrypted_pass ( String path, String password )

Saves the contents of the ConfigFile object to the AES-256 encrypted file specified as a parameter, using the provided password to encrypt it. The output file uses an INI-style structure.

Returns one of the Error code constants (OK on success).

• void set_value ( String section, String key, Variant value )

Assigns a value to the specified key of the specified section. If either the section 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.