This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
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
Engine-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::ConsoleVariableInt Class

Header: #include <UnigineConsole.h>

The ConsoleVariableInt class is used to create integer console variable.

Here is an example for show_fps console variable:

Source code (C++)
ConsoleVariableInt show_fps("show_fps","show frames per second counter\n"
  "0 is to hide FPS counter\n"
  "1 is to show FPS counter\n"
  "2 is to show more detailed FPS counter",1,1,0,2);

ConsoleVariableInt Class

Members


void set ( int value ) const#

Sets the variable value.

Arguments

  • int value - Value of the variable.

int get ( ) const#

Gets the variable value.

Return value

Value of the variable.

ConsoleVariableInt ( const char * name, const char * desc, int save, int value, int min, int max ) #

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.
  • int value - Integer value of the variable.
  • int min - Minimum value of the variable.
  • int max - Maximum value of the variable.

operator int ( ) const#

Cast operator for the variable.

Return value

Value of the variable.

int operator= ( int value ) #

Assignment operator for the variable.

Arguments

  • int value - Value of the variable.

void setGetFunc ( int(*) func ) #

Sets a function that will be called when the get() function is called for the variable.

Arguments

  • int(*) func - Function pointer.

void setSetFunc ( void (*)(int) func ) #

Sets a function that will be called when the set() function is called for the variable. For example:
Source code (C++)
ConsoleVariableInt my_debug_mode(...);

my_debug_mode.setSetFunc([](int new_value) -> void
{
	// do something with "new_value"
	// and/or make some API calls here
});

Arguments

  • void (*)(int) func - Function pointer.

~ConsoleVariableInt ( ) #

Destructor.
Last update: 2023-06-23
Build: ()