This page has been translated automatically.
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and 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
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
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.

Game Namespace

Warning
Game Framework is deprecated and no longer supported. We can't guarantee the stable work of the framework.

The following functions are implemented in the Game namespace (can be found in the data/framework/game/game_system.h file).

void Game::init()

Initializes a system framework: parses CLIs, defines a path to the *.game file, generates a MasterGame class and loads the level.

void Game::update()

Updates a system framework.

void Game::shutdown()

Releases framework resources.

string Game::getGamePath()

Returns a path to the loaded game file.

Return value

Path to the loaded game file.

int Game::getActiveLevelIndex()

Returns a level index of the loaded game.

Return value

Level index.

string Game::getActiveLevelName()

Returns a level name of the loaded game.

Return value

Level name.

void Game::loadLevel(int index)

Loads a level.

Arguments

  • int index - Level index if index is an integer; level name if index is a string.

void Game::setGameParameter(string name, variable value)

Sets a game custom parameter.

Arguments

  • string name - Unique parameter name.
  • variable value - Parameter value. The value can be the following types: int, float, double, vec3, vec4, string.

variable Game::getGameParameter(string name)

Returns a custom parameter value.

Arguments

  • string name - Parameter name.

Return value

Custom parameter value if it is found; otherwise 0.

int Game::isGameParameter(string name)

Returns a value indicating if the game parameter exists.

Arguments

  • string name - Parameter name.

Return value

1 if the parameter exists; otherwise 0.
Last update: 2017-10-20
Build: ()