Unigine.WorldTrigger Class
| Inherits: | Node |
WorldTrigger Class
Members
static WorldTrigger(vec3 size)
Constructor. Creates a new world trigger with given dimensions.Arguments
- vec3 size - Dimensions of the new world trigger. If negative values are provided, 0 will be used instead of them.
WorldTrigger cast(Node node)
Casts a WorldTrigger out of the Node instance.Arguments
- Node node - Node instance.
Return value
WorldTrigger instance.void setEnterCallback(EnterCallback func)
Arguments
- EnterCallback func
void setEnterCallbackName(string name)
Sets a callback function to be fired when nodes are entering the world trigger. Unlike setEnterCallback(), this callback function accepts a node that entered the world trigger and world trigger itself as arguments.Arguments
- string name - Name of the callback function.
string getEnterCallbackName()
Returns the name of callback function to be fired on entering the world trigger. This callback function is set via setEnterCallbackName().Return value
World script function name.void setExcludeNodes(Set<Node> nodes)
Sets a list of excluded nodes, on which the world trigger will not react.Arguments
- Set<Node> nodes - Exclude nodes vector.
Set<Node> getExcludeNodes()
Returns the current list of excluded nodes, on which the world trigger does not react.Arguments
void setExcludeTypes(Set<int> types)
Sets a list of excluded node types, on which the world trigger will not react.Arguments
- Set<int> types - Exclude node types vector.
Set<int> getExcludeTypes()
Returns the current list of excluded node types, on which the world trigger does not react.Arguments
void setLeaveCallback(LeaveCallback func)
Arguments
- LeaveCallback func
void setLeaveCallbackName(string name)
Sets a callback function to be fired when nodes are leaving the world trigger. Unlike setLeaveCallback(), this callback function accepts a node that left the world trigger and world trigger itself as arguments.Arguments
- string name - Name of the callback function.
string getLeaveCallbackName()
Returns the name of the callback function name to be fired on leaving the world trigger. This callback function is set via setLeaveCallbackName().Return value
World script function name.Node getNode(int num)
Returns a node pointer.Arguments
- int num - Number of the node.
Return value
Node pointer.Node getNode()
Returns a node pointer.Return value
Node pointer.Node[] getNodes()
Gets nodes contained in the trigger.Arguments
int getNumNodes()
Returns the number of nodes contained in the world trigger.Return value
Number of nodes contained in the trigger.void setSize(vec3 size)
Updates the current dimensions of the world trigger. The minimum size is vec3(0,0,0).Arguments
- vec3 size - Dimensions of the world trigger. If negative values are provided, 0 will be used instead of them.
vec3 getSize()
Returns the current dimensions of the world trigger.Return value
Current dimensions of the world trigger.void setTargetNodes(Set<Node> nodes)
Sets a list of target nodes, which will fire callbacks. If this list is empty, all nodes fire callbacks.Arguments
- Set<Node> nodes - Target nodes vector.
Set<Node> getTargetNodes()
Returns the current list of target nodes, which fire callbacks. If this list is empty, all nodes fire callbacks.Arguments
void setTargetTypes(Set<int> types)
Sets a list of target node types, which will fire callbacks. If this list is empty, all nodes fire callbacks.Arguments
- Set<int> types - Target node types vector.
Set<int> getTargetTypes()
Returns the current list of target node types, which fire callbacks. If this list is empty, all nodes fire callbacks.Arguments
void setTouch(int touch)
Sets a touch mode for the trigger. With this mode on, the trigger will react to the node by partial contact. When set to off, the trigger reacts only if the whole bounding sphere/box gets inside or outside of it. The default is 0.Arguments
- int touch - Touch mode flag: positive number to enable mode, 0 to disable.
int isTouch()
Returns a value indicating if a touch mode is enabled for the trigger. With this mode on, the trigger will react to the node by partial contact. When set to off, the trigger reacts only if the whole bounding sphere/box gets inside or outside of it.Return value
Returns 1 if the touch mode is enabled; otherwise, 0.int type()
Returns the type of the node.Return value
World type identifier.Last update: 2018-08-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)