Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Sandworm (Experimental)
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Light Sources
World Objects
Sound Objects
Pathfinding Objects
Setting Up Development Environment
Usage Examples
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
Double Precision Coordinates
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

Structure of a Program

The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Like any other computer program, Unigine script program is a sequence of instructions that tell the computer what to do. Lets take a quick look at the basic components of the UnigineScript program.

Statements and Expressions#

The most common type of instructions in a program is the statement. A statement in UnigineScript is the smallest independent unit in the language. We write statements in order to convey to the interpreter that we want to perform a task. Statements in UnigineScript are terminated by a semicolon.

The most common types of simple statements:

Source code (UnigineScript)
int x;

int x is a declaration statement. It tells the interpreter that x is a variable. All variables in a program must be declared before they are used.

Source code (UnigineScript)
x = 5;

x = 5 is an assignment statement. It assigns a value (5) to a variable (x).

The interpreter is also capable of resolving expressions. An expression is a mathematical entity that evaluates to a value. Expressions can involve values (such as 2), variables (such as x), operators (such as +) and functions. They can be singular (such as 2, or x), or compound (such as 2 + 3, 2 + x, x + y, or (2 + x)*(y - 3)).

Source code (UnigineScript)
x = 2 + 3;

x = 2 + 3 is a valid assignment statement. The expression 2+3 evaluates to the value of 5. This value of 5 is then assigned to x.


A variable is the name for a place in the computer's memory where you store some data. To be distinguished from others each variable needs an identifier (a sequence of characters used to name the variable, type, class, function etc.) In UnigineScript variables are declared to be of a type (however, the language uses dynamic typing in fact).

Here is an example of a variable declaration.

Source code (UnigineScript)
int x; // x - identifier, int - type
All the variables in UnigineScript are static by default.

For example:

Source code (UnigineScript)
int foo() {
	int i;
	return i++;


// the output is: 0,1,2,3...

You can also specify a reference variable if you want to allow your function to modify passed values:

Source code (UnigineScript)
void foo(int &v) {
	if(v) log.message("%d\n",v);
	v = 13;

int v = 0;

// the output is: 13


UnigineScript supports both single- and multi-line comments. Comments are ignored during code execution.

  1. Single-line comments. Everything starting from // to the end of a line is a comment:
    Source code (UnigineScript)
    // single-line comment
    int x; // one more comment
  2. Everything between /* and */ is a multi-line comment:
    Source code (UnigineScript)
    /* multi-line comment:
     * comment line
     * one more line
    int foo() {
    	return 0;


In UnigineScript, statements are typically grouped into units called functions. A function is a collection of statements that executes sequentially. Read more information about functions.


Libraries are groups of functions that have been “packaged up” for reuse in many different programs. The core UnigineScript language is actually very small and minimalistic — however, UnigineScript comes with a bunch of libraries, that provide programmers with lots of extra functionality. To include the library in your program use Preprocessor Directives.

Last update: 2017-07-03