class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectRefCounted 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:

[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 = 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:

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

Any operation that mutates the ConfigFile such as 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.

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.

 void clear<>():void

Removes the entire contents of the config.

 String encode_to_text<>():String

Obtain the text version of this config file (the same text that would be written to a file).

 void erase_section<>( String section=, section:String=, ):void

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=, section:String=, String key=, key:String=, ):void

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

 PackedStringArray get_section_keys<>( String section=, section:String=, ):PackedStringArray

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.

 PackedStringArray get_sections<>():PackedStringArray

Returns an array of all defined section identifiers.

 Variant get_value<>( String section=, section:String=, String key=, key:String=, Variant default=null, default:Variant=null, ):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.

 bool has_section<>( String section=, section:String=, ):bool

Returns true if the specified section exists.

 bool has_section_key<>( String section=, section:String=, String key=, key:String=, ):bool

Returns true if the specified section-key pair exists.

 Error load<>( String path=, path:String=, ):Error

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 @GlobalScope.OK on success, or one of the other Error values if the operation failed.

 Error load_encrypted<>( String path=, path:String=, PackedByteArray key=, key:PackedByteArray=, ):Error

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 @GlobalScope.OK on success, or one of the other Error values if the operation failed.

 Error load_encrypted_pass<>( String path=, path:String=, String password=, password:String=, ):Error

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 @GlobalScope.OK on success, or one of the other Error values if the operation failed.

 Error parse<>( String data=, data:String=, ):Error

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 @GlobalScope.OK on success, or one of the other Error values if the operation failed.

 Error save<>( String path=, path:String=, ):Error

Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure.

Returns @GlobalScope.OK on success, or one of the other Error values if the operation failed.

 Error save_encrypted<>( String path=, path:String=, PackedByteArray key=, key:PackedByteArray=, ):Error

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 @GlobalScope.OK on success, or one of the other Error values if the operation failed.

 Error save_encrypted_pass<>( String path=, path:String=, String password=, password:String=, ):Error

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 @GlobalScope.OK on success, or one of the other Error values if the operation failed.

 void set_value<>( String section=, section:String=, String key=, key:String=, Variant value=, value:Variant=, ):void

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.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...