This page has been translated automatically.
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1
Внимание! Эта версия документация УСТАРЕЛА, поскольку относится к более ранней версии SDK! Пожалуйста, переключитесь на самую актуальную документацию для последней версии SDK.
Внимание! Эта версия документации описывает устаревшую версию SDK, которая больше не поддерживается! Пожалуйста, обновитесь до последней версии SDK.

Unigine::Config Class

Unigine config.

To use this class, include the UnigineConfig.h file.

Notice
Use Unigine::Console class functions, if you want to change Console variables or execute Console commands.

Unigine::Config Class

Members


virtual ~Config ()

Virtual destructor.

static Config * get ()

Returns a pointer to the existing config.

Return value

Pointer to the existing config.

virtual int flush () const =0

Flushes config into the current file.

Return value

Returns 1 if the config is successfully flushed into the file; otherwise, 0.

virtual int load (const char * name) const =0

Loads config from the file.

Arguments

  • const char * name - Config file name.

Return value

Returns 1 if the config is successfully loaded from the file; otherwise, 0 is returned.

virtual int save (const char * name) const =0

Saves config into the file.

Arguments

  • const char * name - Config file name.

Return value

Returns 1 if the config is successfully saved into the file; otherwise, 0 is returned.

virtual int isExist (const char * name) const =0

Checks whether the parameter with a given name exists.

Arguments

  • const char * name - Name of the parameter.

Return value

Returns 1 if the parameter with the given name exists; otherwise, 0.

virtual void remove (const char * name) const =0

Removes a parameter with a given name.

Arguments

  • const char * name - Name of the parameter.

virtual void setBool (const char * name, int value) const =0

Sets a boolean value of a given parameter. If the parameter with this name already exists, its value is overwritten.

Arguments

  • const char * name - Name of the parameter.
  • int value - Boolean value of the parameter: 0 means FALSE, 1 means TRUE.

virtual int getBool (const char * name) const =0

Returns the current boolean value of a given parameter parameter.

Arguments

  • const char * name - Name of the parameter.

Return value

Boolean value of the parameter: 0 means FALSE, 1 means TRUE.

virtual void setInt (const char * name, int value) const =0

Sets an integer value of a given parameter. If the parameter with this name already exists, its value is overwritten.

Arguments

  • const char * name - Name of the parameter.
  • int value - Integer value of the parameter.

virtual int getInt (const char * name) const =0

Returns the current integer value of a given parameter.

Arguments

  • const char * name - Name of the parameter.

Return value

Integer value of the parameter.

virtual void setFloat (const char * name, float value) const =0

Sets a float value of a given parameter. If the parameter with this name already exists, its value is overwritten.

Arguments

  • const char * name - Name of the parameter.
  • float value - Float value of the parameter.

virtual float getFloat (const char * name) const =0

Returns the current float value of a given parameter.

Arguments

  • const char * name - Name of the parameter.

Return value

Float value of the parameter.

virtual void setString (const char * name, const char * value) const =0

Sets a string value of a given parameter.

Arguments

  • const char * name - Name of the parameter.
  • const char * value - string value of the parameter.

virtual const char * getString (const char * name) const =0

Returns the current string value of a given parameter.

Arguments

  • const char * name - Name of the parameter.

Return value

String value of the parameter.
Last update: 03.07.2017
Build: ()