Class ConfigFile
- Namespace
- Godot
- Assembly
- GodotSharp.dll
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 World3D!"
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 create a simple ConfigFile and save it on disc:
// Create new ConfigFile object.
var config = new ConfigFile();
// Store some values.
config.SetValue("Player1", "player_name", "Steve");
config.SetValue("Player1", "best_score", 10);
config.SetValue("Player2", "player_name", "V3geta");
config.SetValue("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:
var score_data = new Godot.Collections.Dictionary();
var config = new ConfigFile();
// Load data from a file.
Error err = config.Load("user://scores.cfg");
// If the file didn't load, ignore it.
if (err != Error.Ok)
{
return;
}
// Iterate over all sections.
foreach (String player in config.GetSections())
{
// Fetch the data for each section.
var player_name = (String)config.GetValue(player, "player_name");
var player_score = (int)config.GetValue(player, "best_score");
score_data[player_name] = player_score;
}
Any operation that mutates the ConfigFile such as SetValue(string, string, Variant), Clear(), or EraseSection(string), 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(string), SaveEncrypted(string, byte[]), or SaveEncryptedPass(string, string).
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.
public class ConfigFile : RefCounted, IDisposable- Inheritance
-
ConfigFile
- Implements
- Inherited Members
Constructors
ConfigFile()
public ConfigFile()Methods
Clear()
Removes the entire contents of the config.
public void Clear()EncodeToText()
Obtain the text version of this config file (the same text that would be written to a file).
public string EncodeToText()Returns
EraseSection(string)
Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist.
public void EraseSection(string section)Parameters
sectionstring
EraseSectionKey(string, string)
Deletes the specified key in a section. Raises an error if either the section or the key do not exist.
public void EraseSectionKey(string section, string key)Parameters
GetSectionKeys(string)
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.
public string[] GetSectionKeys(string section)Parameters
sectionstring
Returns
- string[]
GetSections()
Returns an array of all defined section identifiers.
public string[] GetSections()Returns
- string[]
GetValue(string, string, Variant)
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.
public Variant GetValue(string section, string key, Variant @default = default)Parameters
Returns
HasGodotClassMethod(in godot_string_name)
Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.
protected override bool HasGodotClassMethod(in godot_string_name method)Parameters
methodgodot_string_nameName of the method to check for.
Returns
HasGodotClassSignal(in godot_string_name)
Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.
protected override bool HasGodotClassSignal(in godot_string_name signal)Parameters
signalgodot_string_nameName of the signal to check for.
Returns
HasSection(string)
Returns true if the specified section exists.
public bool HasSection(string section)Parameters
sectionstring
Returns
HasSectionKey(string, string)
Returns true if the specified section-key pair exists.
public bool HasSectionKey(string section, string key)Parameters
Returns
InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)
Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.
protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)Parameters
methodgodot_string_nameName of the method to invoke.
argsNativeVariantPtrArgsArguments to use with the invoked method.
retgodot_variantValue returned by the invoked method.
Returns
Load(string)
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 Ok on success, or one of the other Error values if the operation failed.
public Error Load(string path)Parameters
pathstring
Returns
LoadEncrypted(string, byte[])
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 Ok on success, or one of the other Error values if the operation failed.
public Error LoadEncrypted(string path, byte[] key)Parameters
Returns
LoadEncryptedPass(string, string)
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 Ok on success, or one of the other Error values if the operation failed.
public Error LoadEncryptedPass(string path, string password)Parameters
Returns
Parse(string)
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 Ok on success, or one of the other Error values if the operation failed.
public Error Parse(string data)Parameters
datastring
Returns
Save(string)
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure.
Returns Ok on success, or one of the other Error values if the operation failed.
public Error Save(string path)Parameters
pathstring
Returns
SaveEncrypted(string, byte[])
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 Ok on success, or one of the other Error values if the operation failed.
public Error SaveEncrypted(string path, byte[] key)Parameters
Returns
SaveEncryptedPass(string, string)
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 Ok on success, or one of the other Error values if the operation failed.
public Error SaveEncryptedPass(string path, string password)Parameters
Returns
SetValue(string, string, Variant)
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.
public void SetValue(string section, string key, Variant value)