This page has been translated automatically.
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
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and 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
Rendering-Related Classes
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.

Wait

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.

Notice
wait construst can only be used in a thread.

Syntax

Source code (UnigineScript)
wait value;

Parts

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

Example

Source code (UnigineScript)
void thread_func() {
	for(int i = 0; i < 4; i++) {
		log.message("%d\n",i);
		wait;
	}
}

thread("thread_func");

/* Output: 
 * "0" // first frame
 * "1" // second frame
 * "2" // third frame
 * "3" // fourth frame
 */
Notice
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) {
		sprite.update();
		wait;
	}
}

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: 2019-12-25
Build: ()