engine.user_config Functions
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 UnigineScript (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 configs/default.user configuration file, but you can change file location if necessary.
See Also#
- Article on Configuration Files.
UserConfig Class
Members
void engine.user_config.setPath ( string path ) #
Console: user_config
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: Arguments
- string path - New path to the user configuration file to be set.
string engine.user_config.getPath ( ) #
Console: user_config
Returns the current path to the user configuration file (default: configs/default.user). This parameter is stored in the following configuration file: Return value
Current path to the user configuration file.void engine.user_config.setAutosave ( int autosave ) #
Console: user_config_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
- int autosave - 1 to enable automatic saving of current user configuration settings; 0 — to disable it.
int engine.user_config.isAutosave ( ) #
Console: user_config_autosave
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
1 if automatic saving of current user configuration settings is enabled; otherwise, 0.int engine.user_config.load ( ) #
Console: user_config_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 engine.user_config.save ( ) #
Console: user_config_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 engine.user_config.reset ( ) #
Resets the settings in the user configuration file to the default.Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)