ILobbyCallbacks Interface Reference

Collection of "organizational" callbacks for the Realtime Api to cover the Lobby. More...

Inherited by MonoBehaviourPunCallbacks, LobbyCallbacksContainer, and SupportLogger.

Public Member Functions
void	OnJoinedLobby ()
	Called on entering a lobby on the Master Server. The actual room-list updates will call OnRoomListUpdate. More...
void	OnLeftLobby ()
	Called after leaving a lobby. More...
void	OnRoomListUpdate (List< RoomInfo > roomList)
	Called for any update of the room-listing while in a lobby (InLobby) on the Master Server. More...
void	OnLobbyStatisticsUpdate (List< TypedLobbyInfo > lobbyStatistics)
	Called when the Master Server sent an update for the Lobby Statistics. More...

Detailed Description

Collection of "organizational" callbacks for the Realtime Api to cover the Lobby.

Classes that implement this interface must be registered to get callbacks for various situations.

To register for callbacks, call LoadBalancingClient.AddCallbackTarget and pass the class implementing this interface To stop getting callbacks, call LoadBalancingClient.RemoveCallbackTarget and pass the class implementing this interface

Member Function Documentation

OnJoinedLobby()

void OnJoinedLobby

(

)

Called on entering a lobby on the Master Server. The actual room-list updates will call OnRoomListUpdate.

While in the lobby, the roomlist is automatically updated in fixed intervals (which you can't modify in the public cloud). The room list gets available via OnRoomListUpdate.

Implemented in SupportLogger, MonoBehaviourPunCallbacks, and ConnectAndJoinRandom.

OnLeftLobby()

void OnLeftLobby

(

)

Called after leaving a lobby.

When you leave a lobby, OpCreateRoom and OpJoinRandomRoom automatically refer to the default lobby.

Implemented in SupportLogger, and MonoBehaviourPunCallbacks.

OnLobbyStatisticsUpdate()

void OnLobbyStatisticsUpdate

(

List< TypedLobbyInfo >

lobbyStatistics

)

Called when the Master Server sent an update for the Lobby Statistics.

This callback has two preconditions: EnableLobbyStatistics must be set to true, before this client connects. And the client has to be connected to the Master Server, which is providing the info about lobbies.

Implemented in SupportLogger, and MonoBehaviourPunCallbacks.

OnRoomListUpdate()

void OnRoomListUpdate

(

List< RoomInfo >

roomList

)

Called for any update of the room-listing while in a lobby (InLobby) on the Master Server.

Each item is a RoomInfo which might include custom properties (provided you defined those as lobby-listed when creating a room). Not all types of lobbies provide a listing of rooms to the client. Some are silent and specialized for server-side matchmaking.

The list is sorted using two criteria: open or closed, full or not. So the list is composed of three groups, in this order:

first group: open and not full (joinable).
second group: full but not closed (not joinable).
third group: closed (not joinable, could be full or not).

In each group, entries do not have any particular order (random).

The list of rooms (or rooms' updates) is also limited in number, see Lobby Limits.

Implemented in SupportLogger, and MonoBehaviourPunCallbacks.