This page has been translated automatically.
Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Usage Examples
API Reference
Integration Samples
Usage Examples
C++ Plugins
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.


This construct suspends execution of the current function. The address of the function is placed into a list of waiting functions. Waiting functions are "unfrozen" after the runWaits call, which can be performed only in the C++ part of the application. Unigine runs functions from the waiting list each frame automatically. Therefore, you can create threads that act once per frame and use wait for synchronization.

wait construst can only be used in a thread.


Source code (UnigineScript)
wait value;


  • value is an optional return value (0 by default).


Source code (UnigineScript)
void thread_func() {
	for(int i = 0; i < 4; i++) {


/* Output: 
 * "0" // first frame
 * "1" // second frame
 * "2" // third frame
 * "3" // fourth frame
wait construct is valid when called from a simple function (rather then the member function of the class):
Source code (UnigineScript)
void update_redirector(Sprite sprite) {
	while(1) {

If the class instance is set, an error will be generated, because a class instance is not stored when saving the function to be handled by runWaits in the next frame. However, wait is possible if the class function is called as a static function (without passing a class instance to it):

Source code (UnigineScript)
class Foo {

	void update() { 
		while(true) wait 1; 
Foo f = new Foo();
Foo::update();		// this is valid, because the method is called as a static function

// f.update();		// this would cause a crash, because a class instance is passed

See also: thread().

Last update: 2017-07-03
Build: ()