This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

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 configs/default.user configuration file, but you can change file location if necessary.

See Also#

UserConfig Class

Properties

bool Autosave#

Console: user_config_autosave
The 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.

string Path#

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

Members


bool 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

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

bool 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

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: 2022-12-14
Build: ()