Unigine::UserConfig Class

UserConfig Class

Members

---

void setPath ( const char * path ) #

Sets a new path to the user configuration file (default: configs/default.user). The path can be specified as an absolute path or relative to the -data_path or <project_name> folder if the -project_name is set. This parameter is stored in the following configuration file: *.boot.

Arguments

• const char * path - New path to the user configuration file to be set.

const char * getPath ( ) const#

Returns the current path to the user configuration file (default: configs/default.user). This parameter is stored in the following configuration file: *.boot.

Return value

Current path to the user configuration file.

void setAutosave ( bool autosave ) #

Sets a value indicating if current user configuration settings are automatically saved to the corresponding user config file (configs/default.user by default) on loading, closing, and saving the world, as well as on the Engine shutdown.

Arguments

• bool autosave - true to enable automatic saving of current user configuration settings; false — to disable it.

bool isAutosave ( ) const#

Returns a value indicating if current user configuration settings are automatically saved to the corresponding user config file (configs/default.user by default) on loading, closing, and saving the world, as well as on the Engine shutdown.

Return value

true if automatic saving of current user configuration settings is enabled; otherwise, 0.

bool load ( ) #

Loads user configuration from the file. To change the path to the configuration file use the setPath() method.

Return value

true if the user configuration is successfully loaded from the file; otherwise, false.

bool save ( ) const#

Saves the current user configuration to the file. To change the path to the configuration file use the setPath() method.

Return value

true if the current user configuration is successfully saved to the file; otherwise, false.

void reset ( ) #

Resets the settings in the user configuration file to the default.