ConfigFile

Inherits: Reference < Object Helper class to handle INI-style files.

Description

Variant values on the filesystem using INI-style formatting. The stored values are identified by a section and a key:

  1. [section]some_key=42string_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. ConfigFile and save it on disk:

  1. # Create new ConfigFile object.var config = ConfigFile.new()# Store some values.config.set_value("Player1", "player_name", "Steve")config.set_value("Player1", "best_score", 10)config.set_value("Player2", "player_name", "V3geta")config.set_value("Player2", "best_score", 9001)# Save it to a file (overwrite if already exists).config.save("user://scores.cfg")

This example shows how the above file could be loaded:

  1. var score_data = {}var config = ConfigFile.new()# Load data from a file.var err = config.load("user://scores.cfg")# If the file didn't load, ignore it.if err != OK:    return# Iterate over all sections.for player in config.get_sections():    # Fetch the data for each section.    var player_name = config.get_value(player, "player_name")    var player_score = config.get_value(player, "best_score")    score_data[player_name] = player_score

set_value, clear, 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, save_encrypted, or save_encrypted_pass. Keep in mind that section and property names can’t contain spaces. Anything after a space will be ignored on save and on load. ;). 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.

Methods

Method Descriptions

  • clear ( ) Removes the entire contents of the config.
  • 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.
  • 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 default value. If default is not specified or set to null, an error is also raised.
  • bool has_section ( String section ) const true if the specified section exists.
  • bool has_section_key ( String section, String key ) const true if the specified section-key pair exists.
  • Error load ( String path ) ConfigFile object which the method was called on. Error code constants (OK on success).
  • Error load_encrypted ( String path, PoolByteArray key ) key to decrypt it. The file’s contents are parsed and loaded in the ConfigFile object which the method was called on. Error code constants (OK on success).
  • Error load_encrypted_pass ( String path, String password ) password to decrypt it. The file’s contents are parsed and loaded in the ConfigFile object which the method was called on. 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. Error code constants (OK on success).
  • Error save ( String path ) ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Error code constants (OK on success).
  • Error save_encrypted ( String path, PoolByteArray key ) 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. Error code constants (OK on success).
  • Error save_encrypted_pass ( String path, String password ) 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. Error code constants (OK on success).
  • set_value ( String section, String key, Variant value ) null value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.