Skip to main content

ConnectedLensModule.MatchmakingConfig.LobbyState

Enum

Open/close gate of an open-lobby session.

  • Snapchat: not supported
  • SPECS: not supported
  • Camera Kit Web: fully supported
  • Camera Kit Mobile: fully supported
  • SnapchatNot supported — Available on Camera Kit only
  • SPECSNot supported — Available on Camera Kit only
  • Camera Kit WebFully supported
  • Camera Kit MobileFully supported

Platform details

  • Snapchat — Not supported — Available on Camera Kit only.

  • SPECS — Not supported — Available on Camera Kit only.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v387

Open/close gate of an open-lobby session. Read it with MultiplayerSession#getLobbyState; the session host changes it with MultiplayerSession#setLobbyState.

Index

Enumeration Members

Example

options.onLobbyStateChanged = function (session, lobbyState) {
if (lobbyState === ConnectedLensModule.MatchmakingConfig.LobbyState.Closed) {
print("The lobby is closed");
}
};
// On the session host, when the round starts:
session.setLobbyState(ConnectedLensModule.MatchmakingConfig.LobbyState.Closed);

Enumeration Members

Closed

Closed: number

Camera Kit

Matchmaking adds no players. Joins by session id still work up to the maximum player count.

Since

Lens Scripting Version 387


Open

Open: number

Camera Kit

Matchmaking adds players while the session is below the target player count.

Since

Lens Scripting Version 387


Unset

Unset: number

Camera Kit

Not known yet: the session is classic, or the server has not confirmed the gate.

Since

Lens Scripting Version 387