Unigine.UserConfig Class
This class is used to manage user configuration - various personal settings, such as helpers (wireframe, profiler, etc.). By default these settings are stored in the data/configs/default.user configuration file, but you can change file location if necessary.
UserConfig Class
Properties
bool IsAutosave#
A value indicating if current user configuration settings are automatically saved to the corresponding user config file (data/configs/default.user by default) on loading, closing, and saving the world, as well as on the Engine shutdown.
set
Sets a value indicating if current user configuration settings are automatically saved to the corresponding user config file (data/configs/default.user by default) on loading, closing, and saving the world, as well as on the Engine shutdown.
set value -
true to enable automatic saving of current user configuration settings; false — to disable it.
string Path#
The current path to the user configuration file (default: data/configs/default.user).
set
Sets a new path to the user configuration file (default: data/configs/default.user).
set value -
New path to the user configuration file to be set.
Members
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 ( ) #
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.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)