StaticgetThe store options.
OptionalonSuccess: (store: GeneralDataStore) => voidCallback for success.
OptionalonError: (message: string) => voidCallback for error.
The colocated build status if set manually, null otherwise.
Returns the custom landmark being using, or null if not set.
The custom landmark being using, or null if not set.
Returns the host connection id, or null.
The host connection id or null.
Returns the host user id, or null.
The host user id or null.
Returns the host display name, or null.
The host display name or null.
Checks if the current connection is the first joiner of the session.
True if the current connection is the first joiner of the session.
Returns true if the session has finished setting up and the lens experience is ready to start.
True if the session has finished setting up and the lens experience is ready to start.
Returns true if the session has been shared.
True if the session has been shared.
Returns the local connection id, or null.
The local connection id or null.
Returns the local user id, or null.
The local user id or null.
Returns the local display name, or null.
The local display name or null.
Returns the LocationCloudStorageModule.
The LocationCloudStorageModule.
Returns true if the map exists.
True if the map exists.
Returns the current MappingSession. Returns null if the session doesn't exist yet.
The current mapping session or null.
Returns true if we're ready to start the colocated tracking flow.
True if we're ready to start the colocated tracking flow.
Returns a unix timestamp in seconds 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.
The unix timestamp in seconds of the current time according to the server.
Returns the current MultiplayerSession. Returns null if the session doesn't exist yet.
The current multiplayer session or null.
Returns the shared session store (if exists) or null. Useful for needed session info like colocated build status.
The shared session store or null.
Get the current start mode. Start Menu - Will show the start menu when the lens starts Multiplayer - Will launch into multiplayer when the lens starts Off - Will not show the start menu and will not launch into multiplayer. Use startWithStartMenu or startMultiplayer when ready.
The current start mode.
Returns the current state.
The current state.
Returns StoreInfo for the store with matching id.
The network id.
StoreInfo for the store with matching id.
Returns the user info with matching connection id, or null.
The connection id.
The user info with matching connection id, or null.
Returns the user info with matching id, or null.
The user id.
The user info with matching id, or null.
Returns the list of current user connections.
The list of current user connections.
Returns the list of users with matching user id.
The user id.
The list of users with matching user id.
Returns true if the local user is the host, or null if the session doesn't exist yet.
True if the local user is the host, or null if the session doesn't exist yet.
Returns true if the passed in userInfo matches the host user and connection.
The user info to check.
True if the user info matches the host user and connection.
Returns true if the passed in userInfo matches the local user and connection.
The user info to check.
True if the user info matches the local user and connection.
Returns true if the passed in userInfo matches the host userId. Note that this is separate from connectionId.
The user info to check.
True if the user info matches the host userId.
Returns true if the passed in userInfo matches the local userId. Note that this is separate from connectionId.
The user info to check.
True if the user info matches the local userId.
Returns true if the session is singleplayer.
Whether the session is singleplayer.
Executes onLocatedAtFound immediately if the locatedAtComponent is found, or will execute it later when the component is found.
Callback for when the locatedAtComponent is found.
Callback for when the locationId is found.
Executes onMapExists immediately if the map exists.
Callback for when the map exists.
Executes onReady immediately if the Session is ready, or will execute it later when the Session becomes ready.
Callback for when the session is ready.
Executes the onStartColocated callback immediately if the Session's colocated setup has already begun.
If not, onStartColocated will be called when colocated setup starts later on.
Callback for starting colocation.
Prepares SessionController to use a Mocked version of Connected Lenses. Make sure to call this before calling init().
Optionaloptions: MockMultiplayerSessionConfigThe mock session options.
Sets whether the current connection is the first joiner of the session.
Whether the current connection is the first joiner of the session.
Share an Invite to the session.
Starts the session directly into Multiplayer mode. This will not show the start menu, but will show error messages if any issues occur. Will automatically retry at intervals if the connection fails.
Starts the session with the start menu, allowing the user to select Multiplayer or Singleplayer.
Create a RealtimeStore.