Interface EventMap

Map of every event name on the bus to its payload type.

Used by on / once / off in @urth/metatell-sdk/events to infer the handler argument from the event name. Most plugins should use the dedicated modules (users, chat, input, voice, emote, objects, triggers) instead of subscribing to raw events.

Example

import { on } from "@urth/metatell-sdk/events";

// payload is inferred as ChatMessage
on("chat:message", (m) => console.log(m.text));

Hierarchy

  • EventMap

Properties

chat:message chat:send-request chat:send-result emote emote:trigger-request input:gaze input:hover input:pointerdown input:pointermove input:pointerup input:raycast-request input:raycast-result objects:added objects:moved objects:op-request objects:op-result objects:removed objects:updated trigger:fired trigger:op-request trigger:op-result user:profile users:join users:leave users:speaking users:transform users:update voice:local-level voice:speaking

Properties

chat:message

chat:message: ChatMessage

A chat message was received. Payload: ChatMessage.

chat:send-request

chat:send-request: ChatSendRequest

Internal: request to send a chat message.

chat:send-result

chat:send-result: ChatSendResult

Internal: result of a chat send.

emote

emote: EmoteEvent

A user performed an emote. Payload: EmoteEvent.

emote:trigger-request

emote:trigger-request: EmoteTriggerRequest

Internal: request to trigger an emote.

input:gaze

input:gaze: GazeInfo

Gaze target changed. Payload: GazeInfo.

input:hover

input:hover: PointerEvent

Pointer hovered an object. Payload: PointerEvent.

input:pointerdown

input:pointerdown: PointerEvent

Pointer pressed in the scene. Payload: PointerEvent.

input:pointermove

input:pointermove: PointerEvent

Pointer moved in the scene. Payload: PointerEvent.

input:pointerup

input:pointerup: PointerEvent

Pointer released in the scene. Payload: PointerEvent.

input:raycast-request

input:raycast-request: RaycastRequest

Internal: request a raycast.

input:raycast-result

input:raycast-result: RaycastResult

Internal: result of a raycast.

objects:added

objects:added: RoomObject

A room object was added. Payload: RoomObject.

objects:moved

objects:moved: {
    id: string;
    transform: ObjectTransform;
}

A room object's transform changed.

Type declaration

objects:op-request

objects:op-request: ObjectOpRequest

Internal: request a room-object operation.

objects:op-result

objects:op-result: ObjectOpResult

Internal: result of a room-object operation.

objects:removed

objects:removed: {
    id: string;
}

A room object was removed.

Type declaration

  • id: string

objects:updated

objects:updated: RoomObject

A room object was updated (for example pinned/src/pdfIndex changed).

trigger:fired

trigger:fired: TriggerFiredEvent

A Spoke trigger fired. Payload: TriggerFiredEvent.

trigger:op-request

trigger:op-request: TriggerOpRequest

Internal: request a trigger operation.

trigger:op-result

trigger:op-result: TriggerOpResult

Internal: result of a trigger operation.

user:profile

user:profile: UserProfile

The current user's profile changed. Payload: UserProfile.

users:join

users:join: RemoteUser

A user joined the room. Payload: RemoteUser.

users:leave

users:leave: {
    sessionId: string;
}

A user left the room.

Type declaration

  • sessionId: string

users:speaking

users:speaking: SpeakingEvent

A user's speaking state changed. Payload: SpeakingEvent.

users:transform

users:transform: TransformUpdate

A user's avatar transform changed. Payload: TransformUpdate.

users:update

users:update: RemoteUser

A user's profile changed. Payload: RemoteUser.

voice:local-level

voice:local-level: number

The current user's microphone level changed. Payload: the level number.

voice:speaking

voice:speaking: SpeakingEvent

The current user's speaking state changed. Payload: SpeakingEvent.

Settings

Member Visibility

Theme

On This Page