ConfigFile

Helper class to handle INI-style files.

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

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 create a simple and save it on disk:

This example shows how the above file could be loaded:

Any operation that mutates the ConfigFile such as set_value, , or erase_section, only changes what is loaded in memory. If you want to write the change to a file, you have to save the changes with , save_encrypted, or .

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.

Note: The file extension given to a ConfigFile does not have any impact on its formatting or behavior. By convention, the .cfg extension is used here, but any other extension such as .ini is also valid. Since neither .cfg nor .ini are standardized, Godot’s ConfigFile formatting may differ from files written by other programs.

• 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.

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

• 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.

• get_sections ( ) const

Returns an array of all defined section identifiers.

• Variant get_value ( section, String key, 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 ( section ) const

Returns if the specified section exists.

• bool has_section_key ( section, String key ) const

Returns true if the specified section-key pair exists.

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

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

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

• Error parse ( 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).

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

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

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.

• void set_value ( String section, 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.