UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials

Unigine::ConsoleVariableString Class

String console variable.

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

Unigine::ConsoleVariableString Class

Members


ConsoleVariableString (const char * name, const char * desc, int save, const char * value)

Console variable constructor.

Arguments

  • const char * name - Name of the variable.
  • const char * desc - Variable description.
  • int save - Value indicating whether to save the variable value into the configuration file: 1 to save the variable; otherwise,0.
  • const char * value - Value of the variable.

~ConsoleVariableString ()

Destructor.

UNIGINE_INLINE const char * operator= (const char * value)

Assignment operator for the variable.

Arguments

  • const char * value - Value of the variable.

UNIGINE_INLINE operator const char * () const

Cast operator for the variable.

Return value

Value of the variable.

void set (const char * value) const

Sets the variable value.

Arguments

  • const char * value - Value of the variable.

const char * get () const

Gets the variable value.

Return value

Value of the variable.
Last update: 2017-07-03