Interface MultiplayerSession

An instance of a Connected Lens session among a group of participants who were successfully invited into the experience.

interface MultiplayerSession {
    activeUserCount: number;
    activeUsersInfo: UserInfo[];
    allRealtimeStores: GeneralDataStore[];
    clearRealtimeStoreOwnership(store: GeneralDataStore, onSuccess: ((store: GeneralDataStore) => void), onError: ((message: string) => void)): void;
    createRealtimeStore(options: RealtimeStoreCreateOptions, onSuccess: ((store: GeneralDataStore) => void), onError: ((message: string) => void)): void;
    deleteRealtimeStore(store: GeneralDataStore, onSuccess: ((store: GeneralDataStore) => void), onError: ((message: string) => void)): void;
    getLocalUserId(localUserIdCallback: ((userId: string) => void)): void;
    getLocalUserInfo(localUserInfoCallback: ((userInfo: UserInfo) => void)): void;
    getRealtimeStoreInfo(store: GeneralDataStore): RealtimeStoreCreationInfo;
    getServerTimestamp(): number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    requestRealtimeStoreOwnership(store: GeneralDataStore, onSuccess: ((store: GeneralDataStore) => void), onError: ((message: string) => void)): void;
    sendMessage(message: string): void;
    sendMessageWithTimeout(message: string, timeoutMs: number): void;
}

Hierarchy (view full)

Properties

activeUserCount activeUsersInfo allRealtimeStores

Methods

clearRealtimeStoreOwnership createRealtimeStore deleteRealtimeStore getLocalUserId getLocalUserInfo getRealtimeStoreInfo getServerTimestamp getTypeName isOfType isSame requestRealtimeStoreOwnership sendMessage sendMessageWithTimeout

Properties

ReadonlyactiveUserCount

activeUserCount: number

Get the number of active users in the Session.

ReadonlyactiveUsersInfo

activeUsersInfo: UserInfo[]

ReadonlyallRealtimeStores

allRealtimeStores: GeneralDataStore[]

Get all the Realtime Stores in the current session.

Methods

clearRealtimeStoreOwnership

  • clearRealtimeStoreOwnership(store, onSuccess, onError): void

  • Sets the realtime store to unowned.

    Parameters

    Returns void

createRealtimeStore

  • createRealtimeStore(options, onSuccess, onError): void

  • Creates a realtime store to share data within a multiplayer session. The realtime store will allow you to pass data between multiple connected users in the same experience, such as: syncing the position of objects in the scene, syncing the current game score, etc.

    Parameters

    Returns void

deleteRealtimeStore

  • deleteRealtimeStore(store, onSuccess, onError): void

  • Deletes a realtime store.

    Parameters

    Returns void

getLocalUserId

  • getLocalUserId(localUserIdCallback): void

  • Parameters

    • localUserIdCallback: ((userId: string) => void)
        • (userId): void

        • Parameters

          • userId: string

          Returns void

    Returns void

getLocalUserInfo

  • getLocalUserInfo(localUserInfoCallback): void

  • Gets information about the current user, which includes their display name and unique userID which can be used to identify them in session.

    Parameters

    • localUserInfoCallback: ((userInfo: UserInfo) => void)
        • (userInfo): void

        • Parameters

          Returns void

    Returns void

getRealtimeStoreInfo

getServerTimestamp

  • getServerTimestamp(): number

  • Returns a unix timestamp in milliseconds of the current time according to the server. Useful for synchronizing time-based game events across devices. -1 will be returned if session is not connected to the server.

    Returns number

getTypeName

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

requestRealtimeStoreOwnership

  • requestRealtimeStoreOwnership(store, onSuccess, onError): void

  • Requests for ownership of the realtime store.

    Parameters

    Returns void

sendMessage

  • sendMessage(message): void

  • Sends a string message via the realtime backend.

    Parameters

    • message: string

    Returns void

sendMessageWithTimeout

  • sendMessageWithTimeout(message, timeoutMs): void

  • Sends a string message with a timeout in milliseconds. Allows messages to be dropped from the outgoing message queue when they become too old. Useful to ensure the quick delivery of subsequent messages.

    Parameters

    • message: string
    • timeoutMs: number

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods