BiosLobbyService Class Reference

Private Member Functions
proto native EBiosError	GetServers (GetServersInput inputValues)
	Query game servers.
proto native EBiosError	GetFirstServerWithEmptySlot (GetFirstServerWithEmptySlotInput inputValues)
	First 1st free server.
proto native void	AddServerFavorite (string ipAddress, int port, int steamQueryPort)
proto native void	RemoveServerFavorite (string ipAddress, int port, int steamQueryPort)
proto native void	GetFavoriteServers (TStringArray favServers)
proto native void	GetCachedFavoriteServerInfo (array< ref CachedServerInfo > favServersInfoCache)
	Get cached info about favorited servers (ONLY ON WINDOWS)
proto native EBiosError	GetServerModList (string serverId)
void	OnDoneAsync (GetServersResult result_list, EBiosError error, string response)
	Async callback for GetServers.
void	OnGetFirstServerWithEmptySlot (GetFirstServerWithEmptySlotResult result_list, EBiosError error)
void	OnServerModList (GetServerModListResult result_list, EBiosError error)
	Async callback for GetServerModList.

Detailed Description

Definition at line 508 of file BiosLobbyService.c.

Member Function Documentation

AddServerFavorite()

proto native void BiosLobbyService::AddServerFavorite ( string ipAddress, int port, int steamQueryPort )

private

GetCachedFavoriteServerInfo()

proto native void BiosLobbyService::GetCachedFavoriteServerInfo ( array< ref CachedServerInfo > favServersInfoCache )

private

Get cached info about favorited servers (ONLY ON WINDOWS)

Parameters

favServersInfoCache

gets populated with data with format: key = Query End Point, value.param1 = Server Name, value.param2 = Connection Port

GetFavoriteServers()

proto native void BiosLobbyService::GetFavoriteServers ( TStringArray favServers )

private

GetFirstServerWithEmptySlot()

proto native EBiosError BiosLobbyService::GetFirstServerWithEmptySlot ( GetFirstServerWithEmptySlotInput inputValues )

private

First 1st free server.

The async result is returned in the OnGetFirstServerWithEmptySlot callback.

GetServerModList()

proto native EBiosError BiosLobbyService::GetServerModList ( string serverId )

private

Async function to retrieve info about mods for specific server (only for PC)

Parameters

serverId

have to be an id returned by callbacks issued by last call to GetServers if GetServers is used another time the id's must be upated

GetServers()

proto native EBiosError BiosLobbyService::GetServers ( GetServersInput inputValues )

private

Query game servers.

The async result is returned in the OnDoneAsync callback. Expected errors: BAD_PARAMETER - if atleast one of the permissions is not supported on the current platform, or atleast one of the input arrays is NULL.

Parameters

inputValues

input structure

OnDoneAsync()

void BiosLobbyService::OnDoneAsync ( GetServersResult result_list, EBiosError error, string response )

inlineprivate

Async callback for GetServers.

Parameters

result_list	result object
error	error indicating success or fail of the async operation.
response	for debugging - this is the data returned by the server; or an empty string ;)

Definition at line 551 of file BiosLobbyService.c.

  {
    /*
      if (result_list.m_Results != null && result_list.m_Results.Count() > 0)
      Print(result_list.m_Results[0].m_TimeOfDay);
    */
    OnlineServices.OnLoadServersAsync(result_list, error, response);
  }

References OnlineServices::OnLoadServersAsync().

OnGetFirstServerWithEmptySlot()

void BiosLobbyService::OnGetFirstServerWithEmptySlot ( GetFirstServerWithEmptySlotResult result_list, EBiosError error )

inlineprivate

Definition at line 560 of file BiosLobbyService.c.

  {
    OnlineServices.OnAutoConnectToEmptyServer(result_list, error);
  }

References OnlineServices::OnAutoConnectToEmptyServer().

OnServerModList()

void BiosLobbyService::OnServerModList ( GetServerModListResult result_list, EBiosError error )

inlineprivate

Async callback for GetServerModList.

Definition at line 566 of file BiosLobbyService.c.

  {
    OnlineServices.OnGetServerModList(result_list, error);
  }

References OnlineServices::OnGetServerModList().

RemoveServerFavorite()

proto native void BiosLobbyService::RemoveServerFavorite ( string ipAddress, int port, int steamQueryPort )

private

---

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

• scripts/3_Game/Services/BiosLobbyService.c