`arena-message`

The top-level ARENA wire message. All ARENA messages share this envelope structure. The data attribute contents depend on the message type.

ARENA Message Attributes

Attribute	Type	Default	Description	Required
object_id	string		A uuid or otherwise unique identifier for this object.	Yes
persist	boolean	`True`	Persist this object in the database.	Yes
type	string; One of: `['gripdown', 'gripup', 'menudown', 'menuup', 'mousedown', 'mouseenter', 'mouseleave', 'mouseup', 'object', 'program', 'scene-options', 'soundpause', 'soundplay', 'soundstop', 'systemdown', 'systemup', 'trackpaddown', 'trackpadup', 'triggerdown', 'triggerup']`		ARENA message type.	Yes
action	string; One of: `['create', 'delete', 'update']`	`'create'`	Message action create, update, delete.	Yes
ttl	number		When applied to an entity, the entity will remove itself from DOM after the specified number of seconds. Update is allowed, which will reset the timer to start from that moment.	No
private	boolean	`False`	If true, interactions with this object should not be broadcasted to other clients, but rather sent on private topics	No
program_id	string		The program_id on private program topics that interactions to be directed to, if the private flag is set true. Ignored if private flag is false.	No
timestamp	string		Indicates the time of message in milliseconds.	No
override	boolean	`False`	If true, override timestamp and overwrite protection will not happen for older messages.	No
data	object		The message payload. Varies by message type. See: ARENAUI Button Panel, ARENAUI Card Panel, ARENAUI Prompt, Box, Camera Override, Capsule, Circle, Cone, Cube (deprecated; don’t use), Cylinder, Dodecahedron, Entity (generic object), Event, Gaussian Splat, GLTF Model, Hand, Hand, Icosahedron, Image, Light, Line, Camera Override, OBJ Model, Ocean, Octahedron, PCD Model, Plane, Program, Ring, Rounded Box, Scene Config, Sphere, Camera Override, Tetrahedron, Text, Thickline, Three.js Scene, Torus, Torus Knot, Triangle, URDF Model, Videosphere	Yes