@urth/metatell-sdk - v0.1.0
    Preparing search index...

    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.

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

    // payload is inferred as ChatMessage
    on("chat:message", (m) => console.log(m.text));
    interface EventMap {
        "chat:message": ChatMessage;
        "chat:send-request": ChatSendRequest;
        "chat:send-result": ChatSendResult;
        emote: EmoteEvent;
        "emote:trigger-request": EmoteTriggerRequest;
        "environment:changed": EnvironmentChanged;
        "environment:release": EnvironmentRelease;
        "environment:request": EnvironmentRequest;
        "environment:result": EnvironmentResult;
        "input:gaze": GazeInfo;
        "input:hover": PointerEvent;
        "input:pointerdown": PointerEvent;
        "input:pointermove": PointerEvent;
        "input:pointerup": PointerEvent;
        "input:raycast-request": RaycastRequest;
        "input:raycast-result": RaycastResult;
        "objects:added": RoomObject;
        "objects:moved": { id: string; transform: ObjectTransform };
        "objects:op-request": ObjectOpRequest;
        "objects:op-result": ObjectOpResult;
        "objects:removed": { id: string };
        "objects:updated": RoomObject;
        "runtime:changed": RuntimeSnapshot;
        "runtime:request": RuntimeRequest;
        "runtime:result": RuntimeResult;
        "trigger:fired": TriggerFiredEvent;
        "trigger:op-request": TriggerOpRequest;
        "trigger:op-result": TriggerOpResult;
        "user:profile": UserProfile;
        "users:join": RemoteUser;
        "users:leave": { sessionId: string };
        "users:speaking": SpeakingEvent;
        "users:transform": TransformUpdate;
        "users:update": RemoteUser;
        "voice:local-level": number;
        "voice:speaking": SpeakingEvent;
    }
    Index
    chat:message chat:send-request chat:send-result emote emote:trigger-request environment:changed environment:release environment:request environment:result 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 runtime:changed runtime:request runtime:result 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
    "chat:message": ChatMessage

    A chat message was received. Payload: ChatMessage.

    "chat:send-request": ChatSendRequest

    Internal: request to send a chat message.

    "chat:send-result": ChatSendResult

    Internal: result of a chat send.

    emote: EmoteEvent

    A user performed an emote. Payload: EmoteEvent.

    "emote:trigger-request": EmoteTriggerRequest

    Internal: request to trigger an emote.

    "environment:changed": EnvironmentChanged

    Invalidate owner-relative environment state.

    "environment:release": EnvironmentRelease

    Release only the requesting room scope's environment slot.

    "environment:request": EnvironmentRequest

    Internal owner-scoped environment request.

    "environment:result": EnvironmentResult

    Internal correlated environment response.

    "input:gaze": GazeInfo

    Gaze target changed. Payload: GazeInfo.

    "input:hover": PointerEvent

    Pointer hovered an object. Payload: PointerEvent.

    "input:pointerdown": PointerEvent

    Pointer pressed in the scene. Payload: PointerEvent.

    "input:pointermove": PointerEvent

    Pointer moved in the scene. Payload: PointerEvent.

    "input:pointerup": PointerEvent

    Pointer released in the scene. Payload: PointerEvent.

    "input:raycast-request": RaycastRequest

    Internal: request a raycast.

    "input:raycast-result": RaycastResult

    Internal: result of a raycast.

    "objects:added": RoomObject

    A room object was added. Payload: RoomObject.

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

    A room object's transform changed.

    "objects:op-request": ObjectOpRequest

    Internal: request a room-object operation.

    "objects:op-result": ObjectOpResult

    Internal: result of a room-object operation.

    "objects:removed": { id: string }

    A room object was removed.

    "objects:updated": RoomObject

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

    "runtime:changed": RuntimeSnapshot

    Runtime state after a driver, connection, room, or domain change.

    "runtime:request": RuntimeRequest

    Internal: query the installed runtime capability bridge.

    "runtime:result": RuntimeResult

    Internal: correlated runtime capability response.

    "trigger:fired": TriggerFiredEvent

    A Spoke trigger fired. Payload: TriggerFiredEvent.

    "trigger:op-request": TriggerOpRequest

    Internal: request a trigger operation.

    "trigger:op-result": TriggerOpResult

    Internal: result of a trigger operation.

    "user:profile": UserProfile

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

    "users:join": RemoteUser

    A user joined the room. Payload: RemoteUser.

    "users:leave": { sessionId: string }

    A user left the room.

    "users:speaking": SpeakingEvent

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

    "users:transform": TransformUpdate

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

    "users:update": RemoteUser

    A user's profile changed. Payload: RemoteUser.

    "voice:local-level": number

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

    "voice:speaking": SpeakingEvent

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

    Settings
    Member Visibility

    On This Page
    Properties