Online_server

Classes
interface	ServerCatalogueApi
	Catalogue for listing servers from backend. More...
interface	ServerCatalogueFilters
	Object used to specify filters when listing internet servers in the ServerCatalogueApi. More...
interface	ServerGameDataBase
interface	ServerInfo
	Object containing info and interaction methods for game servers. More...
interface	ServerPingSite
interface	ServerWorkshopData
	Data structure for integrating workshop with servers. More...

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

Detailed Description

Enumeration Type Documentation

EServerCatalogueMode

enum EServerCatalogueMode

sealed

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.

EServerCatalogueOrderBy

enum EServerCatalogueOrderBy

sealed

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

EServerCataloguePlatformMatch

enum EServerCataloguePlatformMatch

sealed

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.

EServerCatalogueSearchFlags

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

EServerCatalogueVersionMatch

enum EServerCatalogueVersionMatch

sealed

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.

EServerPlatform

enum EServerPlatform

sealed

Platforms which can be supported by the server.

Enumerator
PC
XBOX
PLAYSTATION

EServerPlatformFlags

enum EServerPlatformFlags

sealed

Bit flags for multi-platform support of the server.

Enumerator
NONE
PC
XBOX
PLAYSTATION
ALL_PLATFORMS