Interface Presence

interface Presence {
    awareness: Awareness;
    clientId: number;
    dispose(): void;
    evictStale(): void;
    getPeers(): PresenceMap;
    getSelf(): PresenceState | null;
    onUpdate(listener: PresenceUpdateListener): () => void;
    patch(partial: Partial<PresenceState>): void;
    setActiveSection(plane: Vec4 | null): void;
    setActiveView(viewId: string | null): void;
    setCamera(camera: CameraState | null): void;
    setCursor2d(viewport: string, pos: Vec2 | null): void;
    setCursor3d(pos: Vec3 | null): void;
    setIsolated(paths: string[] | null): void;
    setModelId(modelId: string | null): void;
    setSelection(paths: string[]): void;
    setStatus(status: "offline" | "active" | "idle"): void;
    setTool(tool: string | null | undefined): void;
    setUser(user: UserIdentity): void;
}

Index

Properties

`Readonly`awareness

awareness: Awareness

`Readonly`clientId

clientId: number

Methods

dispose

dispose(): void

Returns void

evictStale

evictStale(): void

Force a stale sweep; normally automatic.

Returns void

getPeers

getPeers(): PresenceMap

Returns PresenceMap

getSelf

getSelf(): PresenceState | null

Returns PresenceState | null

onUpdate

onUpdate(listener: PresenceUpdateListener): () => void
Parameters
- listener: PresenceUpdateListener
Returns () => void

patch

patch(partial: Partial<PresenceState>): void
Patch arbitrary fields in one go. Use for camera+cursor on the same frame.
Parameters
- partial: Partial<PresenceState>
Returns void

setActiveSection

setActiveSection(plane: Vec4 | null): void
Parameters
- plane: Vec4 | null
Returns void

setActiveView

setActiveView(viewId: string | null): void
Parameters
- viewId: string | null
Returns void

setCamera

setCamera(camera: CameraState | null): void
Parameters
- camera: CameraState | null
Returns void

setCursor2d

setCursor2d(viewport: string, pos: Vec2 | null): void
Parameters
- viewport: string
- pos: Vec2 | null
Returns void

setCursor3d

setCursor3d(pos: Vec3 | null): void
Parameters
- pos: Vec3 | null
Returns void

setIsolated

setIsolated(paths: string[] | null): void
Parameters
- paths: string[] | null
Returns void

setModelId

setModelId(modelId: string | null): void
Parameters
- modelId: string | null
Returns void

setSelection

setSelection(paths: string[]): void
Parameters
- paths: string[]
Returns void

setStatus

setStatus(status: "offline" | "active" | "idle"): void
Parameters
- status: "offline" | "active" | "idle"
Returns void

setTool

setTool(tool: string | null | undefined): void
Parameters
- tool: string | null | undefined
Returns void

setUser

setUser(user: UserIdentity): void
Parameters
- user: UserIdentity
Returns void