Classes
class	ServerCatalogueApi
class	ServerCatalogueFilters
	Object used to specify filters when listing internet servers in the ServerCatalogueApi. More...
class	ServerGameDataBase
class	ServerInfo
class	ServerPingSite
class	ServerWorkshopData

Enumerations
enum	EServerCatalogueMode { INTERNET , DISCOVERY_BROADCAST , DISCOVERY_DIRECT , DISCOVERY_COMBINED , INTERNET , DISCOVERY_BROADCAST , DISCOVERY_DIRECT , DISCOVERY_COMBINED }
	Different modes of ServerCatalogueApi which determines how will be catalogue filled with servers. More...
enum	EServerCatalogueMode { INTERNET , DISCOVERY_BROADCAST , DISCOVERY_DIRECT , DISCOVERY_COMBINED , INTERNET , DISCOVERY_BROADCAST , DISCOVERY_DIRECT , DISCOVERY_COMBINED }
enum	EServerCatalogueOrderBy { NONE , PLAYER_COUNT , SERVER_NAME , SERVER_NAME_ASCII , LAST_JOINED , PING_SITE_AVG_RTT , NONE , PLAYER_COUNT , SERVER_NAME , SERVER_NAME_ASCII , LAST_JOINED , PING_SITE_AVG_RTT }
	Server Catalogue ordering values. More...
enum	EServerCatalogueOrderBy { NONE , PLAYER_COUNT , SERVER_NAME , SERVER_NAME_ASCII , LAST_JOINED , PING_SITE_AVG_RTT , NONE , PLAYER_COUNT , SERVER_NAME , SERVER_NAME_ASCII , LAST_JOINED , PING_SITE_AVG_RTT }
enum	EServerCataloguePlatformMatch { ONLY_MY_PLATFORM , CROSSPLATFORM , ANY_COMPATIBLE , ONLY_INCOMPATIBLE , ANY , ONLY_MY_PLATFORM , CROSSPLATFORM , ANY_COMPATIBLE , ONLY_INCOMPATIBLE , ANY }
	Server Catalogue value for platform support matching. More...
enum	EServerCataloguePlatformMatch { ONLY_MY_PLATFORM , CROSSPLATFORM , ANY_COMPATIBLE , ONLY_INCOMPATIBLE , ANY , ONLY_MY_PLATFORM , CROSSPLATFORM , ANY_COMPATIBLE , ONLY_INCOMPATIBLE , ANY }
enum	EServerCatalogueSearchFlags { SCSF_NONE , SCSF_SERVER_NAME , SCSF_SCENARIO_NAME , SCSF_SCENARIO_ID , SCSF_HOST_ADDRESS , SCSF_MOD_ID , SCSF_TAG , SCSF_NONE , SCSF_SERVER_NAME , SCSF_SCENARIO_NAME , SCSF_SCENARIO_ID , SCSF_HOST_ADDRESS , SCSF_MOD_ID , SCSF_TAG }
	Server Catalogue value for platform support matching. More...
enum	EServerCatalogueSearchFlags { SCSF_NONE , SCSF_SERVER_NAME , SCSF_SCENARIO_NAME , SCSF_SCENARIO_ID , SCSF_HOST_ADDRESS , SCSF_MOD_ID , SCSF_TAG , SCSF_NONE , SCSF_SERVER_NAME , SCSF_SCENARIO_NAME , SCSF_SCENARIO_ID , SCSF_HOST_ADDRESS , SCSF_MOD_ID , SCSF_TAG }
enum	EServerCatalogueVersionMatch { ANY , ONLY_MATCHING , ONLY_MISMATCHING , ANY , ONLY_MATCHING , ONLY_MISMATCHING }
	Server Catalogue value for version matching. More...
enum	EServerCatalogueVersionMatch { ANY , ONLY_MATCHING , ONLY_MISMATCHING , ANY , ONLY_MATCHING , ONLY_MISMATCHING }
enum	EServerPlatform { PC , XBOX , PLAYSTATION , PC , XBOX , PLAYSTATION }
	Platforms which can be supported by the server. More...
enum	EServerPlatform { PC , XBOX , PLAYSTATION , PC , XBOX , PLAYSTATION }
enum	EServerPlatformFlags { NONE , PC , XBOX , PLAYSTATION , ALL_PLATFORMS , NONE , PC , XBOX , PLAYSTATION , ALL_PLATFORMS }
	Bit flags for multi-platform support of the server. More...
enum	EServerPlatformFlags { NONE , PC , XBOX , PLAYSTATION , ALL_PLATFORMS , NONE , PC , XBOX , PLAYSTATION , ALL_PLATFORMS }

Detailed Description

Enumeration Type Documentation

◆ EServerCatalogueMode [1/2]

enum EServerCatalogueMode

Different modes of ServerCatalogueApi which determines how will be catalogue filled with servers.

Enumerator
INTERNET	Server list provided by Backend.
DISCOVERY_BROADCAST	Server list discovered via broadcast on LAN.
DISCOVERY_DIRECT	Server discovered via direct IP and appended into list.
DISCOVERY_COMBINED	Combined list of servers from Broadcast and Direct Discovery.
INTERNET	Server list provided by Backend.
DISCOVERY_BROADCAST	Server list discovered via broadcast on LAN.
DISCOVERY_DIRECT	Server discovered via direct IP and appended into list.
DISCOVERY_COMBINED	Combined list of servers from Broadcast and Direct Discovery.

Definition at line 13 of file EServerCatalogueMode.c.

◆ EServerCatalogueMode [2/2]

enum EServerCatalogueMode

Enumerator
INTERNET	Server list provided by Backend.
DISCOVERY_BROADCAST	Server list discovered via broadcast on LAN.
DISCOVERY_DIRECT	Server discovered via direct IP and appended into list.
DISCOVERY_COMBINED	Combined list of servers from Broadcast and Direct Discovery.
INTERNET	Server list provided by Backend.
DISCOVERY_BROADCAST	Server list discovered via broadcast on LAN.
DISCOVERY_DIRECT	Server discovered via direct IP and appended into list.
DISCOVERY_COMBINED	Combined list of servers from Broadcast and Direct Discovery.

Definition at line 13 of file EServerCatalogueMode.c.

◆ EServerCatalogueOrderBy [1/2]

enum EServerCatalogueOrderBy

Server Catalogue ordering values.

Enumerator
NONE	ordered randomly.
PLAYER_COUNT	ordered by player counts.
SERVER_NAME	ordered by their names.
SERVER_NAME_ASCII
LAST_JOINED	ordering based on how long ago user last joined - works only with favorites and oldest join filters
PING_SITE_AVG_RTT
NONE	ordered randomly.
PLAYER_COUNT	ordered by player counts.
SERVER_NAME	ordered by their names.
SERVER_NAME_ASCII
LAST_JOINED	ordering based on how long ago user last joined - works only with favorites and oldest join filters
PING_SITE_AVG_RTT

Definition at line 13 of file EServerCatalogueOrderBy.c.

◆ EServerCatalogueOrderBy [2/2]

enum EServerCatalogueOrderBy

Enumerator
NONE	ordered randomly.
PLAYER_COUNT	ordered by player counts.
SERVER_NAME	ordered by their names.
SERVER_NAME_ASCII
LAST_JOINED	ordering based on how long ago user last joined - works only with favorites and oldest join filters
PING_SITE_AVG_RTT
NONE	ordered randomly.
PLAYER_COUNT	ordered by player counts.
SERVER_NAME	ordered by their names.
SERVER_NAME_ASCII
LAST_JOINED	ordering based on how long ago user last joined - works only with favorites and oldest join filters
PING_SITE_AVG_RTT

Definition at line 13 of file EServerCatalogueOrderBy.c.

◆ EServerCataloguePlatformMatch [1/2]

enum EServerCataloguePlatformMatch

Server Catalogue value for platform support matching.

Enumerator
ONLY_MY_PLATFORM	Will list only servers which support only platform of the client.
CROSSPLATFORM	Will list only servers which support multiple platforms including one of the client.
ANY_COMPATIBLE	Will list all servers that at least support platform of the client.
ONLY_INCOMPATIBLE	Will list all servers that are not compatible with client platform.
ANY	Will list all servers regardless platform compatibility.
ONLY_MY_PLATFORM	Will list only servers which support only platform of the client.
CROSSPLATFORM	Will list only servers which support multiple platforms including one of the client.
ANY_COMPATIBLE	Will list all servers that at least support platform of the client.
ONLY_INCOMPATIBLE	Will list all servers that are not compatible with client platform.
ANY	Will list all servers regardless platform compatibility.

Definition at line 13 of file EServerCataloguePlatformMatch.c.

◆ EServerCataloguePlatformMatch [2/2]

enum EServerCataloguePlatformMatch

Enumerator
ONLY_MY_PLATFORM	Will list only servers which support only platform of the client.
CROSSPLATFORM	Will list only servers which support multiple platforms including one of the client.
ANY_COMPATIBLE	Will list all servers that at least support platform of the client.
ONLY_INCOMPATIBLE	Will list all servers that are not compatible with client platform.
ANY	Will list all servers regardless platform compatibility.
ONLY_MY_PLATFORM	Will list only servers which support only platform of the client.
CROSSPLATFORM	Will list only servers which support multiple platforms including one of the client.
ANY_COMPATIBLE	Will list all servers that at least support platform of the client.
ONLY_INCOMPATIBLE	Will list all servers that are not compatible with client platform.
ANY	Will list all servers regardless platform compatibility.

Definition at line 13 of file EServerCataloguePlatformMatch.c.

◆ EServerCatalogueSearchFlags [1/2]

enum EServerCatalogueSearchFlags

Server Catalogue value for platform support matching.

Enumerator
SCSF_NONE	Will disable filtering by text search.
SCSF_SERVER_NAME
SCSF_SCENARIO_NAME
SCSF_SCENARIO_ID
SCSF_HOST_ADDRESS
SCSF_MOD_ID
SCSF_TAG
SCSF_NONE	Will disable filtering by text search.
SCSF_SERVER_NAME
SCSF_SCENARIO_NAME
SCSF_SCENARIO_ID
SCSF_HOST_ADDRESS
SCSF_MOD_ID
SCSF_TAG

Definition at line 13 of file EServerCatalogueSearchFlags.c.

◆ EServerCatalogueSearchFlags [2/2]

enum EServerCatalogueSearchFlags

Enumerator
SCSF_NONE	Will disable filtering by text search.
SCSF_SERVER_NAME
SCSF_SCENARIO_NAME
SCSF_SCENARIO_ID
SCSF_HOST_ADDRESS
SCSF_MOD_ID
SCSF_TAG
SCSF_NONE	Will disable filtering by text search.
SCSF_SERVER_NAME
SCSF_SCENARIO_NAME
SCSF_SCENARIO_ID
SCSF_HOST_ADDRESS
SCSF_MOD_ID
SCSF_TAG

Definition at line 13 of file EServerCatalogueSearchFlags.c.

◆ EServerCatalogueVersionMatch [1/2]

enum EServerCatalogueVersionMatch

Server Catalogue value for version matching.

Enumerator
ANY	Will list all servers regardless version.
ONLY_MATCHING	Will list only servers with same version as the client.
ONLY_MISMATCHING	Will list only server with different version that the client.
ANY	Will list all servers regardless version.
ONLY_MATCHING	Will list only servers with same version as the client.
ONLY_MISMATCHING	Will list only server with different version that the client.

Definition at line 13 of file EServerCatalogueVersionMatch.c.

◆ EServerCatalogueVersionMatch [2/2]

enum EServerCatalogueVersionMatch

Enumerator
ANY	Will list all servers regardless version.
ONLY_MATCHING	Will list only servers with same version as the client.
ONLY_MISMATCHING	Will list only server with different version that the client.
ANY	Will list all servers regardless version.
ONLY_MATCHING	Will list only servers with same version as the client.
ONLY_MISMATCHING	Will list only server with different version that the client.

Definition at line 13 of file EServerCatalogueVersionMatch.c.

◆ EServerPlatform [1/2]

enum EServerPlatform

Platforms which can be supported by the server.

Enumerator
PC
XBOX
PLAYSTATION
PC
XBOX
PLAYSTATION

Definition at line 13 of file EServerPlatform.c.

◆ EServerPlatform [2/2]