This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
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
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
Art Samples
Tutorials

Unigine::UserConfig Class

Header: #include <UnigineConfig.h>

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

Members


void setPath ( const char * 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: *.boot.

Arguments

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

const char * getPath ( ) const#

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: *.boot.

Return value

Current path to the user configuration file.

void setAutosave ( bool 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

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

bool isAutosave ( ) const#

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

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

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 ( ) const#

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: 2021-02-17
Build: ()