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
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials

Library's Namespace

By default, all variables, functions, classes, etc. are exported from C++ in the global namespace. Libraries provide a convenient way to organize exposed functionality by adding a library's namespace. This namespace is used instead of Foo::Bar syntax that is not allowed for export.

Namespace Export Example

  1. In order to use a library namespace, a library should be registered first via Unigine::Interpreter::addExternLibrary().
  2. After that, you can use a library namespace to register your variables, functions, classes, etc.
Source code (C++)
#include <Unigine.h>
#include <UnigineInterpreter.h>

using namespace Unigine;

// A variable within a namespace for export.
namespace Foo {
	int i = 25;
}

int main(int argc,char **argv) {

	// Register a library in order to use a library namespace.
	Interpreter::addExternLibrary("Foo");

	// Export a variable with a library prefix.
	Interpreter::addExternVariable("Foo.integer",MakeExternVariable(&Foo::i));

	// Initialize an engine. 
	Engine *engine = Engine::init(UNIGINE_VERSION,argc,argv);

	// Enter main loop.
	engine->main();
 
	// Engine shutdown. 
	Engine::shutdown();

	return 0;

}

An example is made by modifying the Simple.cpp sample, that can be found in the source/samples/Api/Systems/Simple/ folder of Unigine SDK or Evaluation kit.

Access from Scripts

You can simply call the registered variables, functions, classes from Unigine scripts using the registered name. (If Foo library is not registered, the first dot in an object or function name is treated as an operator of class member access, which is wrong in our case).

Source code (UnigineScript)
// my_world.cpp

int init() {
	log.message("Foo.i is %d\n",Foo.integer);
}

Output

The following console message will be printed:

Output
Foo.i is 25
Last update: 2017-07-03