Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

Return

The return statement terminates function execution and returns a value and program control to the caller, that is, to the line of code, from which the function was called.

Syntax

Source code (UnigineScript)
return value;
				

Parts

  • value is a value to return. It is optional.

Example

Source code (UnigineScript)
int foo(int a) {
	return a * a;
}
log.message("%d\n",foo(3));

// the result is: 9

If the function returns an array, vector or matrix, you can access each element as follows:

Source code (UnigineScript)
vec3 foo() {
	return vec3(1.0f,2.0f,3.0f);
}

log.message("%f %f\n",foo().x,foo()[2]);

// the output is: 1.0 3.0
				
Swizzles of the return value elements are also available:
Source code (UnigineScript)
log.message("%f %f\n",translate(1.0f,2.0f,3.0f).m23,translate(1.0f,2.0f,3.0f)[14]);

// the result is: 3.0 3.0
				
Last update: 2017-07-03