WorldExpression Class

List of Functions:

This class executes an arbitrary expression. For other nodes to move along with expression transformations, they should be assigned as WorldExpression children.

Attaching Script

There are two ways to write WorldExpression script:

Directly in the editor (Nodes panel -> Expression -> Source field):
Source code (UnigineScript)
```
{
	log.message("WorldExpression is updated\n");
}
```
Attach a script file:
1. Specify it in the File field (relative to the data directory, for example, project/scripts/world_script.h).
2. Specify #include in the Source field:
Source code (UnigineScript)
```
{
	#include <project/scripts/world_script.h>
}
```

Creating Script

WorldExpression script can be implemented in the following way:

Source code (UnigineScript)

void __constructor__() { }  // Create resources. This function is called on world load, when
							// not all of the nodes can be loaded!

void __destructor__() { }  // Delete created resources.
 
/* 
 */
void my_update() { ... }   // Code that the WorldExpression will execute for its child node each frame
					       // (when WorldExpression is in the view frustum or player is inside its radius).

my_update();               // Execute the update function.

Inter-Script Communication

Each WorldExpression has its own scope. You cannot directly set or get variables to or from the WorldExpression (as memory corruption occurs).

If WorldExpression calls a function from a world script:

Source code (UnigineScript)

// World script
namespace WorldScriptScope {

	void worldScriptFunc(string arg) {
		log.message("World script code: %s\n",arg);
	}
}

Source code (UnigineScript)

// WorldExpression
engine.world.call("WorldScriptScope::worldScriptFunc","hello from WorldExpression");

If a world script calls a function from WorldExpression:

Source code (UnigineScript)

// World script
namespace WorldScriptScope {

	void worldScriptFunc(WorldExpression expression) {
		expression.call("worldExpressionFunc","hello from the world script");
	}
}

Source code (UnigineScript)

// WorldExpression
void worldExpressionFunc(string arg) {
	log.message("WorldExpression code: %s\n",arg);
}

Script Functions

The following internal functions are available within the WorldExpression script:

Node getNode() - returns the WorldExpression node.
Node getChild(int num) - returns the WorldExpression child node by its number. If the child is not found, returns NULL.
int getNumChilds() - returns the number of WorldExpression children.
Node getParent() - returns the WorldExpression parent node. If there is no parent, returns NULL.

To get the WorldExpression node and its parent, you can write the following in the WorldExpression script:

Source code (UnigineScript)

Node node = getNode();
Node parent = node.getParent();

Now you can, for example, operate with all of the WorldExpression children as follows:

Source code (UnigineScript)

forloop(int i = 0; getNumChilds()) {
	Node child = getChild(i);
	log.message("The type of the node is: %s\n",child.getTypeName());
}
// this example shows the type of each WorldExpression child

WorldExpression Class

This class inherits from Node

Members

WorldExpression (vec3 size = 1)

Constructor. Creates an arbitrary expression to be executed.

Arguments

vec3 size = 1 - Size of the bounding box. Within it an expression is executed (valid only the expression-transformed child object is outside the view frustum). This is an optional argument.

variable call (string name)

Calls a world expression function from any other script.