Link Search Menu Expand Document

event

Generate an event message for an object.

This is the schema for Event, the properties of wire object type event.

All wire objects have a set of basic attributes {object_id, action, type, persist, data}. The data attribute defines the object-specific attributes

Event Properties

Attribute Type Default Description Required
target string   The object_id of event destination. Yes
targetPosition Vector3   The event destination position in 3D. Yes
originPosition Vector3 {'x': 0, 'y': 1.6, 'z': 0} The event origination position in 3D. No
source string ~~~~ DEPRECATED: data.source is deprecated for clientEvent, use data.target instead. No
position object ~~~~ DEPRECATED: data.position is deprecated for clientEvent, use data.targetPosition instead. No
clickPos object ~~~~ DEPRECATED: data.clickPos is deprecated for clientEvent, use data.originPosition instead. No