This page has been translated automatically.
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Setting Up Development Environment
Usage Examples
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
Double Precision Coordinates
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
CIGI Client Plugin
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.

World Expression

A world expression is a cuboid-shaped object, which executes arbitrary expressions (scripts) at the specified distance and frame rate. By default, expressions are executed at the same frame rate as the main application.

An expression is executed only if its bounding box is in the viewing frustum or the camera is positioned within this bounding box.

By using world expressions, you can attach a script to an object in the scene. To do that, such object must be added as a child node to the world expression. Child nodes inherit transformations (if any) of the world expression.

Child nodes are transformed relative to the pivot point of the world expression node.
If there are nested world expression nodes, the child node of the last world expression in the hierarchy inherits transformations of all parent world expression nodes.

For example, by using the world expression, you can transform objects in the scene, turn on and off sounds with the distance, turn on and off NPC behavior, attach objects to the camera (e.g. drops of the rain on the camera), and so on.

ObjectMeshDynamic nodes added as children to the nested WorldExpression nodes

See also#

Creating World Expression#

To create a world expression via UnigineEditor:

  1. In the Menu bar, click Create -> Logic -> Expression.

  2. Place the world expression somewhere in the world.

Attaching World Expression Script#

There are two ways of attaching a world expression script via UnigineEditor:

  • Directly in UnigineEditor in the Parameters window -> Node tab -> World Expression section -> Source field. The source code must be inside the curly braces {} as they define the world expression scope.

  • Attached as a script file in the Parameters window -> Node tab -> World Expression section -> File field. The script file should be included in the world expression scope in the Source field. The curly braces {} are also required:

    In this case, the my_expression.h should contain the following code:
    Source code (UnigineScript)
    log.message("WorldExpression is updated\n");
    In the script file, the source code must not be wrapped with curly braces {}.

Implementing Script#

The script itself can be implemented as a simple sequence of functions' calls or as a set of functions and classes. See examples here.

It is recommended to implement simple scripts.

Inter-Script Communication#

Such script can communicate with the world script via the corresponding functions or with world triggers via callbacks (see the samples listed above).

Script Functions#

Besides functions of the UnigineScript library, there is also a set of internal functions that are available within the world expression script. The list of such functions with descriptions and examples can be found here.

Setting World Expression Parameters#

You can adjust the following parameters of the world expression in the Node tab:

Size A size of the bounding box of the world expression along the X, Y, and Z axes.
  • If the bounding box is in the viewing frustum or the camera is positioned within the bounding box, the expression is executed.
  • If the child node of the world expression node gets outside the viewing frustum, but the bounding box is still in the viewing frustum (or the camera is positioned within the bounding box), the playback of the transformation sequence will not stop.
Offset An offset of the center of the world expression's bounding box along the X, Y, and Z axes.
Distance A distance at which the expression is not executed.
IFps A constant frame duration (inverse FPS, 1/FPS) used to execute the expression. If 0 is set, the expression is executed at the same frame rate as the main application.
File A path to a file with a world expression script to be executed. The path is relative to the data directory. This file should be included in the world expression scope in the Source field. This field is optional as the world expression script can be implemented directly via the UnigineEditor interface (see the description of the Source field below).
If the script file is changed, it should be refreshed via UnigineEditor: click to the right of the File field.
Source Source code of a world expression script. This field can contain:
  • Direct implementation of the world expression script.
  • The #include directive that loads the script file specified in the File field (see the description above).
In both cases, the curly braces {} must wrap the code in the field.

Deleting World Expression#

To delete the world expression via UnigineEditor, right-click the world expression node in the nodes hierarchy list and press Delete.

Last update: 2019-08-16
Build: ()