Video Tutorials
Interface
Essentials
Advanced
Полезные советы
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Программирование
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
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

Return

Warning
UnigineScript is deprecated and will be removed in future releases. Please consider using C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt is not guaranteed, as the current level of support assumes only fixing critical issues.

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: 03.07.2017