UserConfig Class
Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
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
Members
void setPath ( string path ) #
Sets a new path to the user configuration file (default: data/configs/default.user).Arguments
- string path - New path to the user configuration file to be set.
string getPath ( ) #
Returns the current path to the user configuration file (default: data/configs/default.user).Return value
Current path to the user configuration file.void setAutosave ( int autosave ) #
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.Arguments
- int autosave - 1 to enable automatic saving of current user configuration settings; 0 — to disable it.
int isAutosave ( ) #
Returns 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.Return value
1 if automatic saving of current user configuration settings is enabled; otherwise, 0.int load ( ) #
Loads user configuration from the file. To change the path to the configuration file use the setPath() method.Return value
1 if the user configuration is successfully loaded from the file; otherwise, 0.int save ( ) #
Saves the current user configuration to the file. To change the path to the configuration file use the setPath() method.Return value
1 if the current user configuration is successfully saved to the file; otherwise, 0.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)