Preparing search index...

    Implements

    Index

    Constructors

    Properties

    mockLocalUserInfo: UserInfo = null

    Accessors

    Methods

    • 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

    • Returns void

    • Returns string

    • Returns number

    • Parameters

      • localUserIdCallback: (userId: string) => void

      Returns 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

      Returns void

    • Returns string

    • Returns void

    • Returns void

    • Get the SafeSnapchatUser for a user in the session. This returns only non-sensitive user info (userId, bitmojiInfo, name) suitable for Bitmoji rendering.

      Parameters

      Returns void

    • 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

    • Get a value stored within the specified scope.

      Returns void

      Use Realtime Stores instead

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

      Parameters

      • type: string

      Returns boolean

    • Returns boolean

    • Returns void

    • Returns void

    • List all values stored within the specified scope.

      Returns void

      Use Realtime Stores instead

    • Sends a string message via the realtime backend.

      Parameters

      • message: string

      Returns void

    • Returns void

    • Returns 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

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • Saves the value to the specified scope.

      Returns void

      Use Realtime Stores instead

    • Returns void

    • Returns void