ConfigFile

Helper class to handle INI-style files.

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:

More...

@GodotBaseClass

struct ConfigFile {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(ConfigFile other);

ConfigFile opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static ConfigFile _new();

void setValue(StringArg0 section, StringArg1 key, VariantArg2 value);

Variant getValue(StringArg0 section, StringArg1 key, VariantArg2 _default);

bool hasSection(StringArg0 section);

bool hasSectionKey(StringArg0 section, StringArg1 key);

PoolStringArray getSections();

PoolStringArray getSectionKeys(StringArg0 section);

void eraseSection(StringArg0 section);

GodotError load(StringArg0 path);

GodotError save(StringArg0 path);

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

eraseSection void eraseSection(StringArg0 section): Deletes the specified section along with all the key-value pairs inside.
getSectionKeys PoolStringArray getSectionKeys(StringArg0 section): Returns an array of all defined key identifiers in the specified section.
getSections PoolStringArray getSections(): Returns an array of all defined section identifiers.
getValue Variant getValue(StringArg0 section, StringArg1 key, VariantArg2 _default): 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.
hasSection bool hasSection(StringArg0 section): Returns true if the specified section exists.
hasSectionKey bool hasSectionKey(StringArg0 section, StringArg1 key): Returns true if the specified section-key pair exists.
load GodotError load(StringArg0 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.
opAssign ConfigFile opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(ConfigFile other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
save GodotError save(StringArg0 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.
setValue void setValue(StringArg0 section, StringArg1 key, VariantArg2 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.

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new ConfigFile _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Detailed Description

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

ConfigFile

Members

Aliases

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Detailed Description

Meta

Source

ConfigFile

From mixin baseCasts

From `mixin baseCasts`