Z.TriggerRegion
Inherits from Z.Node
Description
A TriggerRegion node can be used to determine if the origin point of specified Z.Object nodes are within a defined area.
TriggerRegion nodes check Z.Object nodes that are members of the tag specified by the triggerTag property.
Provided by Z.TriggerRegion
Constructor
Enumerations
Shape |
The shape that the TriggerRegion takes. |
Events
triggerenter |
Emitted when the origin point of an object first enters the TriggerRegion. |
triggerleave |
Emitted when the origin point of an object leaves the TriggerRegion. |
triggermove |
Emitted every frame the origin point of an object moves inside the TriggerRegion. |
triggers |
Emitted once a frame with data for every object currently inside the TriggerRegion. |
Functions
reportLocalPosition( ) |
Gets whether the objects within the TriggerRegion should return their position in the TriggerRegion's local coordinate system. |
reportLocalPosition(...) |
Sets whether the objects within the TriggerRegion should return their position in the TriggerRegion's local coordinate system. |
reportParentPosition( ) |
Gets whether the objects within a TriggerRegion should return their position in the parent's coordinate system. |
reportParentPosition(...) |
Sets whether the objects within a TriggerRegion should return their position in the parent's coordinate system. |
shape( ) |
Gets the shape of the TriggerRegion. |
shape(...) |
Sets the shape of the TriggerRegion. |
triggerTag( ) |
Gets the triggerTag of the TriggerRegion. |
triggerTag(...) |
Sets the triggerTag of the TriggerRegion. |
Interfaces
Inherited from Z.Node
Functions
Inherited from Z.Base
Functions
emit(...) |
Calls the handler functions attached to an event. |
hasTag(...) |
Returns true if this object has the specified tag. |
off(...) |
Removes a handler function from an event. |
on(...) |
Attaches a handler function to an event. |
one(...) |
Attaches a single-use handler function to an event. |
pushTag(...) |
Adds a tag to this object. |
removeTag(...) |
Removes a tag from this object. |
tags( ) |
Gets an array of the tags that this object belongs to. |
tags(...) |
Sets the array of the tags that this object belongs to. |