Z.TriggerRegion

Studio

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

Z.TriggerRegion( ) Constructs a new Z.TriggerRegion object.

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

TriggerEvent Information provided during trigger events.
TriggerPresentEvent An extended collection of information during trigger events.

Inherited from Z.Node

Functions

blend( ) Gets the type of blending used to render this object.
blend(...) Sets the type of blending used to render this object
color( ) Gets the color of the node.
color(...) Sets the color of the node.
cullFaces( ) Gets the type of culling to performed on this object.
cullFaces(...) Sets the type of culling to performed on this object.
enabled( ) Gets the value of enabled for the node.
enabled(...) Sets the value of enabled for the node.
position( ) Gets the position of the node.
position(...) Sets the position of the node
relativeTo( ) Gets an array of nodes that this node's location is relative to.
relativeTo(...) Sets the node(s) that this node's location is relative to.
relativeToProp( ) Gets the ratio of contributions that the nodes specified by relativeTo have on this node's location.
relativeToProp(...) Sets the ratio of contributions that the nodes specified by relativeTo have on this node's location.
rotation( ) Gets the rotation of the node.
rotation(...) Sets the rotation of the node.
scale( ) Gets the scale of the node.
scale(...) Sets the scale of the node.
visible( ) Gets the visibility of the node.
visible(...) Sets the visibility of this node.

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.
Open in new window