Return
Warning
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 UnigineScript (beyond its scope of applications) 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: 9If the function returns an array, vector or matrix, you can access each element as follows:
Source code (UnigineScript)
Swizzles of the return value elements are also available:
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.0Source 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.0Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)