Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface ActivityData

    interface ActivityData {
        active?: boolean;
        av?: AVSettingsData;
        cursor?: Point;
        idle?: boolean;
        lastActivityTime?: number;
        levelId?: string | null;
        ping?: PingData;
        ruler?: ElevatedPoint[];
        sceneId?: string | null;
        targets?: string[];
    }
    Index

    Properties

    active? av? cursor? idle? lastActivityTime? levelId? ping? ruler? sceneId? targets?

    Properties

    active?: boolean

    Whether the user has an open WS connection to the server or not.

    av?: AVSettingsData

    The state of the user's AV settings.

    cursor?: Point

    The position of the user's cursor.

    idle?: boolean

    Whether the user's last activity exceeds an idleness threshold.

    lastActivityTime?: number

    The number of milliseconds since the user's last reported activity.

    levelId?: string | null

    The ID of the scene level that the user is viewing.

    ping?: PingData

    Is the user emitting a ping at the cursor coordinates?

    ruler?: ElevatedPoint[]

    The state of the user's ruler, if they are currently using one.

    sceneId?: string | null

    The ID of the scene that the user is viewing.

    targets?: string[]

    The IDs of the tokens the user has targeted in the currently viewed scene.

    Settings

    Member Visibility

    On This Page

    Properties