ClientLobbyApi Interface Reference

Public Member Functions
proto native void	SearchRooms (JsonApiStruct searchParams, BackendCallback callback)
	Search first batch of rooms.
proto native int	Rooms (out notnull array< Room > rooms)
	Get room data for current position.
proto native void	GetRoomsByIds (GetRoomsIds searchParams, BackendCallback callback)
proto native void	GetRoomsByHostIds (GetRoomsIds searchParams, BackendCallback callback)
proto native void	Scroll (int position, BackendCallback callback)
	Update current position.
proto native void	SetViewSize (int size)
	View size is expected size of rooms from Rooms(rooms).
proto native int	TotalRoomCount ()
	The total room count by the current filter.
proto native void	KillGeneratedRooms ()
proto native void	GenerateRooms ()
proto native Room	GetInviteRoom ()
	Get room for the last invite request.
proto native bool	InvitationFailed ()
	Clear the room from GetInviteRoom()
proto native void	ClearInviteRoom ()
	Clear the room from GetInviteRoom()
proto native JsonApiStruct	GetParameters ()
	Get parameters created in the current run.
proto native void	ClearParams ()
	Clear serialized data.
proto native string	GetStrParams ()
	Get serialized parameters.
proto native void	StoreParams ()
	Serialize params before reload.
proto native void	SetRefreshCallback (BackendCallback callback)
	Set callback for periodical room refresh.
proto native void	SetRefreshRate (int iRate)
	Set a time span between page updates (in ms).
proto native int	Target (out notnull array< Room > rooms)
	Get room searched by SearchTarget.
proto native int	SearchTarget (JsonApiStruct searchParams, BackendCallback callback)
	Search for a specific room and keep cached data.
proto native string	GetMyIP ()
	Get automatically detected IP of the network adapter.
proto native string	GetPreviousRoomId ()
	In case of a disconnection you can retrieve the previous room ID.
proto native void	ClearPreviousRoomId ()
proto native Room	GetRoomById (string id)
	Find the room by its ID in cached data.
proto native void	MeasureLatency (BackendCallback callback)
	Retrieve the pings sites and start to measure latency.
proto native bool	IsPingAvailable ()
	True if ping data to the ping sites are ready to use.
proto native void	ProcessLastHostError (BackendCallback callback)
	Triggers OnError/OnTimeout in case the previous listen server initialization failed.

Member Function Documentation

ClearInviteRoom()

proto native void ClientLobbyApi.ClearInviteRoom

(

)

Clear the room from GetInviteRoom()

ClearParams()

proto native void ClientLobbyApi.ClearParams

(

)

Clear serialized data.

ClearPreviousRoomId()

proto native void ClientLobbyApi.ClearPreviousRoomId

(

)

GenerateRooms()

proto native void ClientLobbyApi.GenerateRooms

(

)

GetInviteRoom()

proto native Room ClientLobbyApi.GetInviteRoom

(

)

Get room for the last invite request.

Returns null if no room is available

GetMyIP()

proto native string ClientLobbyApi.GetMyIP

(

)

Get automatically detected IP of the network adapter.

TODO: This will be obsolete when the proper LAN server support is ready

GetParameters()

proto native JsonApiStruct ClientLobbyApi.GetParameters

(

)

Get parameters created in the current run.

GetPreviousRoomId()

proto native string ClientLobbyApi.GetPreviousRoomId

(

)

In case of a disconnection you can retrieve the previous room ID.

It should be cleared after that to prevent acquiring the same id twice.

GetRoomById()

proto native Room ClientLobbyApi.GetRoomById

(

string

id

)

Find the room by its ID in cached data.

GetRoomsByHostIds()

proto native void ClientLobbyApi.GetRoomsByHostIds	(	GetRoomsIds	searchParams,
		BackendCallback	callback
	)

GetRoomsByIds()

proto native void ClientLobbyApi.GetRoomsByIds	(	GetRoomsIds	searchParams,
		BackendCallback	callback
	)

GetStrParams()

proto native string ClientLobbyApi.GetStrParams

(

)

Get serialized parameters.

InvitationFailed()

proto native bool ClientLobbyApi.InvitationFailed

(

)

Clear the room from GetInviteRoom()

IsPingAvailable()

proto native bool ClientLobbyApi.IsPingAvailable

(

)

True if ping data to the ping sites are ready to use.

KillGeneratedRooms()

proto native void ClientLobbyApi.KillGeneratedRooms

(

)

MeasureLatency()

proto native void ClientLobbyApi.MeasureLatency

(

BackendCallback

callback

)

Retrieve the pings sites and start to measure latency.

ProcessLastHostError()

proto native void ClientLobbyApi.ProcessLastHostError

(

BackendCallback

callback

)

Triggers OnError/OnTimeout in case the previous listen server initialization failed.

Rooms()

proto native int ClientLobbyApi.Rooms

(

out notnull array< Room >

rooms

)

Get room data for current position.

Scroll()

proto native void ClientLobbyApi.Scroll	(	int	position,
		BackendCallback	callback
	)

Update current position.

SearchRooms()

proto native void ClientLobbyApi.SearchRooms	(	JsonApiStruct	searchParams,
		BackendCallback	callback
	)

Search first batch of rooms.

SearchTarget()

proto native int ClientLobbyApi.SearchTarget	(	JsonApiStruct	searchParams,
		BackendCallback	callback
	)

Search for a specific room and keep cached data.

SetRefreshCallback()

proto native void ClientLobbyApi.SetRefreshCallback

(

BackendCallback

callback

)

Set callback for periodical room refresh.

SetRefreshRate()

proto native void ClientLobbyApi.SetRefreshRate

(

int

iRate

)

Set a time span between page updates (in ms).

SetViewSize()

proto native void ClientLobbyApi.SetViewSize

(

int

size

)

View size is expected size of rooms from Rooms(rooms).

StoreParams()

proto native void ClientLobbyApi.StoreParams

(

)

Serialize params before reload.

Target()

proto native int ClientLobbyApi.Target

(

out notnull array< Room >

rooms

)

Get room searched by SearchTarget.

TotalRoomCount()

proto native int ClientLobbyApi.TotalRoomCount

(

)

The total room count by the current filter.

---

The documentation for this interface was generated from the following file:

• GameLib/online/serverBrowser.c