Online

Classes
interface	BackendApi
	Backend Api instance. More...
interface	BackendAuthenticatorApi
	This API is used for accessing current state of Authenticator for backend services from client game. More...
interface	BackendCallback
	Object used as callback structure in which you will receive results of Backend requests exposed via ScriptAPIs. More...
interface	BackendDebugApi
interface	BackendImage
interface	BanListPageParams
	JsonApiStruct passed to BanList backend requests. More...
interface	BanServiceApi
	Ban Service API. More...
interface	BaseWorkshopItem
interface	BlockListItem
	Data structure for block list response. More...
interface	BohemiaAccountApi
	This API is used for linking user Game Identity with his Bohemia Account. More...
interface	ClientLobbyApi
interface	Dependency
	Dependency represent minimal structure of workshop item that other things depends on. More...
interface	DSSession
	DS server Session. More...
interface	DSSessionCallback
	Dedicated Server Session callback class for script. More...
interface	GroupApplication
	Serves as both Application and Invitation. More...
interface	GroupCatalogue
	GroupCatalogue serves as manager (register new group) as well as browser. More...
interface	GroupData
interface	GroupManifest
	Data set needed to register a new Group. More...
interface	GroupMemberCatalogue
interface	GroupMemberRole
interface	GroupMembership
interface	ImageScale
interface	JsonApiStruct
interface	MissionWorkshopItem
interface	NewsFeedItem
	New Feed data structure. More...
interface	OnlineBanListData
	Structure for ban data response of BanList requests. More...
interface	PopupFeedItem
	Popup Feed data structure. More...
interface	RestApi
interface	RestCallback
	Object used as callback structure in which you will receive results of scripted RestAPI calls. More...
interface	RestContext
	Script accessible REST context. More...
interface	Revision
interface	Room
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	ServerConfigApi
interface	ServerConfigMeta
interface	ServerInfo
	Object containing info and interaction methods for game servers. More...
interface	ServiceStatusItem
	Service status item. More...
interface	SessionStorage
	Save & Load handler. More...
interface	WorkshopApi
	Workshop Api instance. More...
interface	WorkshopAuthor
interface	WorkshopCatalogue
interface	WorkshopItem
	Workshop Item instance. More...
interface	WorkshopTag
	Workshop Item Tag structure TODO replace by DString. More...
interface	WorldSaveItem
interface	WorldSaveManifest

Enumerations
enum	EApiCode {   EApiCode.EACODE_ERROR_OK , EApiCode.EACODE_ERROR_UNKNOWN , EApiCode.EACODE_ERROR_ASSET_BLOCKED , EApiCode.EACODE_ERROR_ASSET_DELETED ,   EApiCode.EACODE_ERROR_ASSET_FIELD_IMMUTABLE , EApiCode.EACODE_ERROR_ASSET_NOT_CONTRIBUTED , EApiCode.EACODE_ERROR_ASSET_NOT_OWNED , EApiCode.EACODE_ERROR_ASSET_NOT_PUBLISHED ,   EApiCode.EACODE_ERROR_ASSET_PRIVATE , EApiCode.EACODE_ERROR_ASSET_VERSION_ALREADY_EXISTS , EApiCode.EACODE_ERROR_ASSET_TAG_NON_MATCHING_TYPE , EApiCode.EACODE_ERROR_ASSET_TOO_MANY_TAGS ,   EApiCode.EACODE_ERROR_ASSET_DIFFERENT_ENV , EApiCode.EACODE_ERROR_COLLECTION_NOT_OWNED , EApiCode.EACODE_ERROR_COLLECTION_PRIVATE , EApiCode.EACODE_ERROR_COLLECTION_FULL ,   EApiCode.EACODE_ERROR_COMMENT_BLOCKED , EApiCode.EACODE_ERROR_COMMENT_NOT_OWNED , EApiCode.EACODE_ERROR_COMMENTS_ASSET_NOT_MATCHING , EApiCode.EACODE_ERROR_TAG_PROTECTED ,   EApiCode.EACODE_ERROR_UPLOAD_FIELD_LIMIT , EApiCode.EACODE_ERROR_UPLOAD_FILE_HASH_MISMATCH , EApiCode.EACODE_ERROR_UPLOAD_FILE_LIMIT , EApiCode.EACODE_ERROR_UPLOAD_FILE_SIZE_LIMIT ,   EApiCode.EACODE_ERROR_UPLOAD_FILE_SIZE_MISMATCH , EApiCode.EACODE_ERROR_UPLOAD_MANIFEST_INVALID , EApiCode.EACODE_ERROR_UPLOAD_MANIFEST_MISSING , EApiCode.EACODE_ERROR_UPLOAD_MANIFEST_SIZE_LIMIT ,   EApiCode.EACODE_ERROR_UPLOAD_NO_FILE_PROVIDED , EApiCode.EACODE_ERROR_UPLOAD_PART_LIMIT , EApiCode.EACODE_ERROR_SERVICE_ERROR , EApiCode.EACODE_ERROR_VALIDATION_ERROR ,   EApiCode.EACODE_ERROR_UNAUTHORIZED , EApiCode.EACODE_ERROR_TOKEN_EXPIRED , EApiCode.EACODE_ERROR_RESOURCE_NOT_FOUND_ERROR , EApiCode.EACODE_ERROR_ALREADY_EXISTS ,   EApiCode.EACODE_ERROR_REQUEST_ERROR , EApiCode.EACODE_ERROR_REFERENCED_RESOURCE_NOT_FOUND_ERROR , EApiCode.EACODE_ERROR_NOT_IMPLEMENTED_ERROR , EApiCode.EACODE_ERROR_NOT_FOUND ,   EApiCode.EACODE_ERROR_METHOD_NOT_ALLOWED , EApiCode.EACODE_ERROR_INVALID_TOKEN_TYPE , EApiCode.EACODE_ERROR_INVALID_TOKEN , EApiCode.EACODE_ERROR_INTERNAL_SERVER_ERROR ,   EApiCode.EACODE_ERROR_CLIENT_ID_MISMATCH , EApiCode.EACODE_ERROR_ACCOUNT_LOCKED , EApiCode.EACODE_ERROR_ACCESS_FORBIDDEN , EApiCode.EACODE_ERROR_CONCURRENT_DATA_MODIFICATION ,   EApiCode.EACODE_ERROR_DATA_VERSION_MISMATCH , EApiCode.EACODE_ERROR_GAME_BINARY_CHECKSUM_UNDEFINED , EApiCode.EACODE_ERROR_INVALID_GAME_IDENTITY_TOKEN , EApiCode.EACODE_ERROR_INVALID_INPUT ,   EApiCode.EACODE_ERROR_INVALID_REQUEST_SIGNATURE , EApiCode.EACODE_ERROR_UNSUPPORTED_CLIENT , EApiCode.EACODE_ERROR_USER_NOT_FOUND , EApiCode.EACODE_ERROR_SERVER_NOT_FOUND ,   EApiCode.EACODE_ERROR_SERVER_PASSWORD_MISMATCH , EApiCode.EACODE_ERROR_SERVER_IS_FULL , EApiCode.EACODE_ERROR_MP_ROOM_NOT_FOUND , EApiCode.EACODE_ERROR_MP_ROOM_IS_FULL ,   EApiCode.EACODE_ERROR_MP_ROOM_QUEUE_JOIN , EApiCode.EACODE_ERROR_MP_ROOM_QUEUE_WAIT , EApiCode.EACODE_ERROR_MP_ROOM_QUEUE_FULL , EApiCode.EACODE_ERROR_MP_ROOM_QUEUE_NOT_FOUND ,   EApiCode.EACODE_ERROR_MP_ROOM_USER_NOT_IN_QUEUE , EApiCode.EACODE_ERROR_PASSWORD_MISMATCH , EApiCode.EACODE_ERROR_P2P_USER_JOIN_BAN , EApiCode.EACODE_ERROR_DS_USER_JOIN_BAN ,   EApiCode.EACODE_ERROR_PLAYER_IS_BANNED , EApiCode.EACODE_ERROR_MULTIPLE_TARGET_MATCH , EApiCode.EACODE_ERROR_RENTED_SERVER_GAME_DATA_CORRUPTED , EApiCode.EACODE_ERROR_MAINTENANCE_IN_PROGRESS ,   EApiCode.EACODE_ERROR_USER_IS_BANNED_FROM_SHARED_GAME , EApiCode.EACODE_ERROR_NO_AVAILABLE_SERVER , EApiCode.EACODE_ERROR_DEDICATED_SERVER_COMMUNICATION_PROBLEM , EApiCode.EACODE_ERROR_RENTED_SERVER_GAME_LOCKED ,   EApiCode.EACODE_ERROR_SCENARIO_BLOCKED , EApiCode.EACODE_ERROR_TEMPORARY_HOSTING_ERROR , EApiCode.EACODE_ERROR_MP_ROOM_IS_NOT_JOINABLE , EApiCode.EACODE_ERROR_PLAYER_ALREADY_JOINED ,   EApiCode.EACODE_ERROR_ASSET_NOT_FOUND , EApiCode.EACODE_ERROR_MP_ROOM_AUTO_JOINABLE_WITH_PASSWORD , EApiCode.EACODE_ERROR_MP_ROOM_MORE_ACTIVE_PLAYERS_THAN_NEW_LIMIT , EApiCode.EACODE_ERROR_INVALID_SESSION_TICKET ,   EApiCode.EACODE_ERROR_DEDICATED_SERVER_NOT_FOUND , EApiCode.EACODE_ERROR_PLAYER_NOT_FOUND_IN_ROOM , EApiCode.EACODE_ERROR_OBSOLETE_ASSET_GAME_VERSION , EApiCode.EACODE_ERROR_IDENTITY_INVALID_TOKEN ,   EApiCode.EACODE_ERROR_IDENTITY_UNKNOWN_IDENTITY , EApiCode.EACODE_ERROR_IDENTITY_CONFLICT_IDENTITY , EApiCode.EACODE_ERROR_IDENTITY_STEAM_CONNECTION_ERROR , EApiCode.EACODE_ERROR_USER_LOCKED ,   EApiCode.EACODE_ERROR_USER_SERVICE_USER_NOT_FOUND , EApiCode.EACODE_ERROR_USER_INVALID_CREDENTIALS , EApiCode.EACODE_ERROR_USER_MISSING_2FA , EApiCode.EACODE_ERROR_USER_INVALID_2FA ,   EApiCode.EACODE_ERROR_INVALID_ROOM_INVITE_TOKEN , EApiCode.EACODE_ERROR_FILE_LOAD_FAILED , EApiCode.EACODE_ERROR_FILE_SAVE_FAILED }
enum	EBackendCatalogueBoolFlag { EBackendCatalogueBoolFlag.BCB_FALSE , EBackendCatalogueBoolFlag.BCB_TRUE , EBackendCatalogueBoolFlag.BCB_ANY }
	Boolean value for backend catalogue filters which support any value. More...
enum	EBackendCatalogueOrderDir { EBackendCatalogueOrderDir.BCOD_ASC , EBackendCatalogueOrderDir.BCOD_DESC }
	Value specifying direction of ordering in Backend Catalogue. More...
enum	EBackendCredentials {   EBackendCredentials.EBCRED_NAME , EBackendCredentials.EBCRED_PWD , EBackendCredentials.EBCRED_BASEURI , EBackendCredentials.EBCRED_PLATFORMUID ,   EBackendCredentials.EBCRED_2FA_TOKEN }
	Credential parameters. More...
enum	EBackendDebugHandling { EBackendDebugHandling.EBDH_NONE , EBackendDebugHandling.EBDH_ERROR , EBackendDebugHandling.EBDH_TIMEOUT }
enum	EBackendError {   EBackendError.EBERR_OK , EBackendError.EBERR_UNKNOWN , EBackendError.EBERR_DISABLED , EBackendError.EBERR_INVALID_STATE ,   EBackendError.EBERR_BUSY , EBackendError.EBERR_ALREADY_REQUESTED , EBackendError.EBERR_LOGIN_FAILED , EBackendError.EBERR_AUTH_FAILED ,   EBackendError.EBERR_LOGIN_SUCCESS , EBackendError.EBERR_AUTH_SUCCESS , EBackendError.EBERR_CONFIGURATION_GET , EBackendError.EBERR_CONFIGURATION_WRITE ,   EBackendError.EBERR_CHARACTER_GET , EBackendError.EBERR_CHARACTER_UPDATE , EBackendError.EBERR_FILE_NOT_FOUND , EBackendError.EBERR_LINK_FAILED ,   EBackendError.EBERR_UNSUPPORTED_REQUEST , EBackendError.EBERR_STORAGE_IS_FULL , EBackendError.EBERR_VALIDATION_FAILED , EBackendError.EBERR_INVALID_INPUT }
	Backend error. More...
enum	EDsSessionState {   EDsSessionState.EDSESSION_OFFLINE , EDsSessionState.EDSESSION_LAUNCHING , EDsSessionState.EDSESSION_INIT , EDsSessionState.EDSESSION_ACTIVE ,   EDsSessionState.EDSESSION_CLOSING , EDsSessionState.EDSESSION_PAUSED , EDsSessionState.EDSESSION_RESTARTING }
	Session state. More...
enum	EJsonApiError {   EJsonApiError.ETJSON_UNKNOWN , EJsonApiError.ETJSON_OK , EJsonApiError.ETJSON_COMMSEND , EJsonApiError.ETJSON_PARSERERROR ,   EJsonApiError.ETJSON_TIMEOUT , EJsonApiError.ETJSON_NOBUFFERS , EJsonApiError.ETJSON_FAILFILELOAD , EJsonApiError.ETJSON_FAILFILESAVE ,   EJsonApiError.ETJSON_NOTARRAY }
enum	EPendingLoadState {   EPendingLoadState.ELS_NONE , EPendingLoadState.ELS_SCENARIOS , EPendingLoadState.ELS_DEPENDENCIES , EPendingLoadState.ELS_FILES ,   EPendingLoadState.ELS_CHANGELOG , EPendingLoadState.ELS_ALL_ADDON }
	Specifies which data of Revision were not yet loaded from the backend,. More...
enum	ERestResult {   ERestResult.EREST_EMPTY , ERestResult.EREST_SUCCESS , ERestResult.EREST_ERROR , ERestResult.EREST_ERROR_SERVERERROR ,   ERestResult.EREST_ERROR_APPERROR , ERestResult.EREST_ERROR_TIMEOUT , ERestResult.EREST_ERROR_NOTIMPLEMENTED , ERestResult.EREST_ERROR_PACKINGREQUEST ,   ERestResult.EREST_ERROR_CREATE , ERestResult.EREST_ERROR_RECV , ERestResult.EREST_ERROR_SEND , ERestResult.EREST_ERROR_STORE ,   ERestResult.EREST_ERROR_UNKNOWN }
	States and result + error code produced by RestApi. More...
enum	ERevisionAvailability { ERevisionAvailability.ERA_AVAILABLE , ERevisionAvailability.ERA_DELETED , ERevisionAvailability.ERA_OBSOLETE }
enum	ERolePermission {   ERolePermission.EPERMISSION_NOT_SET , ERolePermission.ERPERMISSION_APPLICATION_EVALUATE , ERolePermission.ERPERMISSION_INVITATION_CREATE , ERolePermission.ERPERMISSION_EDIT_GROUP_DATA ,   ERolePermission.ERPERMISSION_KICK_MEMBER , ERolePermission.ERPERMISSION_ROLE_MANAGEMENT , ERolePermission.ERPERMISSION_GROUP_DISBANDMENT }
enum	EServerCatalogueMode { EServerCatalogueMode.SCM_INTERNET , EServerCatalogueMode.SCM_DISCOVERY_BROADCAST , EServerCatalogueMode.SCM_DISCOVERY_DIRECT , EServerCatalogueMode.SCM_DISCOVERY_COMBINED }
	Different modes of ServerCatalogueApi which determines how will be catalogue filled with servers. More...
enum	EServerCatalogueOrderBy {   EServerCatalogueOrderBy.SCOB_NONE , EServerCatalogueOrderBy.SCOB_PLAYER_COUNT , EServerCatalogueOrderBy.SCOB_SERVER_NAME , EServerCatalogueOrderBy.SCOB_SCENARIO_NAME ,   EServerCatalogueOrderBy.SCOB_LAST_JOINED }
	Server Catalogue ordering values. More...
enum	EServerCataloguePlatformMatch {   EServerCataloguePlatformMatch.SCPM_ONLY_MY_PLATFORM , EServerCataloguePlatformMatch.SCPM_CROSSPLATFORM , EServerCataloguePlatformMatch.SCPM_ANY_COMPATIBLE , EServerCataloguePlatformMatch.SCPM_ONLY_INCOMPATIBLE ,   EServerCataloguePlatformMatch.SCPM_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.SCVM_ANY , EServerCatalogueVersionMatch.SCVM_ONLY_MATCHING , EServerCatalogueVersionMatch.SCVM_ONLY_MISMATCHING }
	Server Catalogue value for version matching. More...
enum	EServerType { EServerType.ST_NONE , EServerType.ST_OFFICIAL , EServerType.ST_COMMUNITY , EServerType.ST_LISTEN }
	Determines type of the server. More...
enum	EStringMatchType { EStringMatchType.ESMT_EQUALS , EStringMatchType.ESMT_STARTS_WITH , EStringMatchType.ESMT_CONTAINS }
	Enum used to specify how string is matched when searching in backend database. More...
enum	EWorkshopItemAccessState { EWorkshopItemAccessState.EWASTATE_OK , EWorkshopItemAccessState.EWASTATE_REPORTED , EWorkshopItemAccessState.EWASTATE_PRIVATE , EWorkshopItemAccessState.EWASTATE_BLOCKED }
	Access restriction flags for WorkshopItems (values are bit flags!) More...
enum	EWorkshopItemType { EWorkshopItemType.EWTYPE_UNKNOWN , EWorkshopItemType.EWTYPE_ADDON , EWorkshopItemType.EWTYPE_WORLD_SAVE }
	Workshop item type. More...
enum	EWorkshopReportType {   EWorkshopReportType.EWREPORT_INAPPROPRIATE_CONTENT , EWorkshopReportType.EWREPORT_OFFENSIVE_LANGUAGE , EWorkshopReportType.EWREPORT_MISLEADING , EWorkshopReportType.EWREPORT_SPAM ,   EWorkshopReportType.EWREPORT_SCAM , EWorkshopReportType.EWREPORT_MALICIOUS , EWorkshopReportType.EWREPORT_INTELLECTUAL_PROPERTY , EWorkshopReportType.EWREPORT_OTHER }
	Content reporting types. More...
enum	HttpCode {   HttpCode.HTTP_CODE_NULL , HttpCode.HTTP_CODE_100 , HttpCode.HTTP_CODE_200 , HttpCode.HTTP_CODE_201 ,   HttpCode.HTTP_CODE_202 , HttpCode.HTTP_CODE_300 , HttpCode.HTTP_CODE_301 , HttpCode.HTTP_CODE_302 ,   HttpCode.HTTP_CODE_303 , HttpCode.HTTP_CODE_400 , HttpCode.HTTP_CODE_401 , HttpCode.HTTP_CODE_403 ,   HttpCode.HTTP_CODE_404 , HttpCode.HTTP_CODE_405 , HttpCode.HTTP_CODE_408 , HttpCode.HTTP_CODE_409 ,   HttpCode.HTTP_CODE_412 , HttpCode.HTTP_CODE_413 , HttpCode.HTTP_CODE_418 , HttpCode.HTTP_CODE_422 ,   HttpCode.HTTP_CODE_433 , HttpCode.HTTP_CODE_444 , HttpCode.HTTP_CODE_500 , HttpCode.HTTP_CODE_501 ,   HttpCode.HTTP_CODE_502 , HttpCode.HTTP_CODE_503 , HttpCode.HTTP_CODE_504 , HttpCode.HTTP_CODE_520 ,   HttpCode.HTTP_CODE_521 , HttpCode.HTTP_CODE_522 , HttpCode.HTTP_CODE_523 , HttpCode.HTTP_CODE_524 ,   HttpCode.HTTP_CODE_525 , HttpCode.HTTP_CODE_526 , HttpCode.HTTP_CODE_530 }
	Common HTTP (result / error) codes Can be used in code as constant values to easier find use of specific HTTP code compared to search for simple numbers in the code. More...

Detailed Description

Enumeration Type Documentation

EApiCode

enum EApiCode

Enumerator
EACODE_ERROR_OK
EACODE_ERROR_UNKNOWN
EACODE_ERROR_ASSET_BLOCKED
EACODE_ERROR_ASSET_DELETED
EACODE_ERROR_ASSET_FIELD_IMMUTABLE
EACODE_ERROR_ASSET_NOT_CONTRIBUTED
EACODE_ERROR_ASSET_NOT_OWNED
EACODE_ERROR_ASSET_NOT_PUBLISHED
EACODE_ERROR_ASSET_PRIVATE
EACODE_ERROR_ASSET_VERSION_ALREADY_EXISTS
EACODE_ERROR_ASSET_TAG_NON_MATCHING_TYPE
EACODE_ERROR_ASSET_TOO_MANY_TAGS
EACODE_ERROR_ASSET_DIFFERENT_ENV
EACODE_ERROR_COLLECTION_NOT_OWNED
EACODE_ERROR_COLLECTION_PRIVATE
EACODE_ERROR_COLLECTION_FULL
EACODE_ERROR_COMMENT_BLOCKED
EACODE_ERROR_COMMENT_NOT_OWNED
EACODE_ERROR_COMMENTS_ASSET_NOT_MATCHING
EACODE_ERROR_TAG_PROTECTED
EACODE_ERROR_UPLOAD_FIELD_LIMIT
EACODE_ERROR_UPLOAD_FILE_HASH_MISMATCH
EACODE_ERROR_UPLOAD_FILE_LIMIT
EACODE_ERROR_UPLOAD_FILE_SIZE_LIMIT
EACODE_ERROR_UPLOAD_FILE_SIZE_MISMATCH
EACODE_ERROR_UPLOAD_MANIFEST_INVALID
EACODE_ERROR_UPLOAD_MANIFEST_MISSING
EACODE_ERROR_UPLOAD_MANIFEST_SIZE_LIMIT
EACODE_ERROR_UPLOAD_NO_FILE_PROVIDED
EACODE_ERROR_UPLOAD_PART_LIMIT
EACODE_ERROR_SERVICE_ERROR
EACODE_ERROR_VALIDATION_ERROR
EACODE_ERROR_UNAUTHORIZED
EACODE_ERROR_TOKEN_EXPIRED
EACODE_ERROR_RESOURCE_NOT_FOUND_ERROR
EACODE_ERROR_ALREADY_EXISTS
EACODE_ERROR_REQUEST_ERROR
EACODE_ERROR_REFERENCED_RESOURCE_NOT_FOUND_ERROR
EACODE_ERROR_NOT_IMPLEMENTED_ERROR
EACODE_ERROR_NOT_FOUND
EACODE_ERROR_METHOD_NOT_ALLOWED
EACODE_ERROR_INVALID_TOKEN_TYPE
EACODE_ERROR_INVALID_TOKEN
EACODE_ERROR_INTERNAL_SERVER_ERROR
EACODE_ERROR_CLIENT_ID_MISMATCH
EACODE_ERROR_ACCOUNT_LOCKED
EACODE_ERROR_ACCESS_FORBIDDEN
EACODE_ERROR_CONCURRENT_DATA_MODIFICATION
EACODE_ERROR_DATA_VERSION_MISMATCH
EACODE_ERROR_GAME_BINARY_CHECKSUM_UNDEFINED
EACODE_ERROR_INVALID_GAME_IDENTITY_TOKEN
EACODE_ERROR_INVALID_INPUT
EACODE_ERROR_INVALID_REQUEST_SIGNATURE
EACODE_ERROR_UNSUPPORTED_CLIENT
EACODE_ERROR_USER_NOT_FOUND
EACODE_ERROR_SERVER_NOT_FOUND	Client-Side only - Requested operation failed because server was not found.
EACODE_ERROR_SERVER_PASSWORD_MISMATCH	Client-Side only - Requested operation failed because user did not provide correct password.
EACODE_ERROR_SERVER_IS_FULL	Client-Side only - Requested operation failed because server does not have free slots.
EACODE_ERROR_MP_ROOM_NOT_FOUND
EACODE_ERROR_MP_ROOM_IS_FULL
EACODE_ERROR_MP_ROOM_QUEUE_JOIN
EACODE_ERROR_MP_ROOM_QUEUE_WAIT
EACODE_ERROR_MP_ROOM_QUEUE_FULL
EACODE_ERROR_MP_ROOM_QUEUE_NOT_FOUND
EACODE_ERROR_MP_ROOM_USER_NOT_IN_QUEUE
EACODE_ERROR_PASSWORD_MISMATCH
EACODE_ERROR_P2P_USER_JOIN_BAN
EACODE_ERROR_DS_USER_JOIN_BAN
EACODE_ERROR_PLAYER_IS_BANNED
EACODE_ERROR_MULTIPLE_TARGET_MATCH
EACODE_ERROR_RENTED_SERVER_GAME_DATA_CORRUPTED
EACODE_ERROR_MAINTENANCE_IN_PROGRESS
EACODE_ERROR_USER_IS_BANNED_FROM_SHARED_GAME
EACODE_ERROR_NO_AVAILABLE_SERVER
EACODE_ERROR_DEDICATED_SERVER_COMMUNICATION_PROBLEM
EACODE_ERROR_RENTED_SERVER_GAME_LOCKED
EACODE_ERROR_SCENARIO_BLOCKED
EACODE_ERROR_TEMPORARY_HOSTING_ERROR
EACODE_ERROR_MP_ROOM_IS_NOT_JOINABLE
EACODE_ERROR_PLAYER_ALREADY_JOINED
EACODE_ERROR_ASSET_NOT_FOUND
EACODE_ERROR_MP_ROOM_AUTO_JOINABLE_WITH_PASSWORD
EACODE_ERROR_MP_ROOM_MORE_ACTIVE_PLAYERS_THAN_NEW_LIMIT
EACODE_ERROR_INVALID_SESSION_TICKET
EACODE_ERROR_DEDICATED_SERVER_NOT_FOUND
EACODE_ERROR_PLAYER_NOT_FOUND_IN_ROOM
EACODE_ERROR_OBSOLETE_ASSET_GAME_VERSION
EACODE_ERROR_IDENTITY_INVALID_TOKEN
EACODE_ERROR_IDENTITY_UNKNOWN_IDENTITY
EACODE_ERROR_IDENTITY_CONFLICT_IDENTITY
EACODE_ERROR_IDENTITY_STEAM_CONNECTION_ERROR
EACODE_ERROR_USER_LOCKED
EACODE_ERROR_USER_SERVICE_USER_NOT_FOUND
EACODE_ERROR_USER_INVALID_CREDENTIALS
EACODE_ERROR_USER_MISSING_2FA
EACODE_ERROR_USER_INVALID_2FA
EACODE_ERROR_INVALID_ROOM_INVITE_TOKEN
EACODE_ERROR_FILE_LOAD_FAILED
EACODE_ERROR_FILE_SAVE_FAILED

EBackendCatalogueBoolFlag

enum EBackendCatalogueBoolFlag

Boolean value for backend catalogue filters which support any value.

Enumerator
BCB_FALSE
BCB_TRUE
BCB_ANY

EBackendCatalogueOrderDir

enum EBackendCatalogueOrderDir

Value specifying direction of ordering in Backend Catalogue.

Enumerator
BCOD_ASC
BCOD_DESC

EBackendCredentials

enum EBackendCredentials

Credential parameters.

Enumerator
EBCRED_NAME
EBCRED_PWD
EBCRED_BASEURI
EBCRED_PLATFORMUID
EBCRED_2FA_TOKEN

EBackendDebugHandling

enum EBackendDebugHandling

Enumerator
EBDH_NONE
EBDH_ERROR
EBDH_TIMEOUT

EBackendError

enum EBackendError

Backend error.

Enumerator
EBERR_OK	all OK
EBERR_UNKNOWN	unknown error
EBERR_DISABLED	backend is disabled
EBERR_INVALID_STATE	called request from state where it is not possible (ie. reading data before login and such)
EBERR_BUSY	no request can be called - login/auth in process
EBERR_ALREADY_REQUESTED	state already requested once!
EBERR_LOGIN_FAILED	failed to login
EBERR_AUTH_FAILED	failed to authenticate
EBERR_LOGIN_SUCCESS	login successful
EBERR_AUTH_SUCCESS	authenticate successful
EBERR_CONFIGURATION_GET	configuration received
EBERR_CONFIGURATION_WRITE	configuration written
EBERR_CHARACTER_GET	character data received
EBERR_CHARACTER_UPDATE	character update done
EBERR_FILE_NOT_FOUND	save point doesn't exist
EBERR_LINK_FAILED
EBERR_UNSUPPORTED_REQUEST	non-supported request call performed
EBERR_STORAGE_IS_FULL	unable to store data
EBERR_VALIDATION_FAILED
EBERR_INVALID_INPUT

EDsSessionState

enum EDsSessionState

Session state.

Enumerator
EDSESSION_OFFLINE	session is not initialized
EDSESSION_LAUNCHING	session is handling online services, connections and loading initial data
EDSESSION_INIT	session is waiting for script/ game to finish initialization (load world) and such
EDSESSION_ACTIVE	session is running - players can connect
EDSESSION_CLOSING	session is being terminated
EDSESSION_PAUSED	session is paused (this is state where server was hibernated)
EDSESSION_RESTARTING	session is restarted (in process)

EJsonApiError

enum EJsonApiError

---

error codes for handle processing defined in C++

Enumerator
ETJSON_UNKNOWN	invalid code
ETJSON_OK	all fine
ETJSON_COMMSEND	error during send
ETJSON_PARSERERROR	error during parsing
ETJSON_TIMEOUT	failed to send/ store handle due to timeout
ETJSON_NOBUFFERS	not enough buffers available
ETJSON_FAILFILELOAD	failed to load file
ETJSON_FAILFILESAVE	failed to save file
ETJSON_NOTARRAY	object is not array (ie. attempt to provide different or none object as array)

EPendingLoadState

enum EPendingLoadState

Specifies which data of Revision were not yet loaded from the backend,.

Enumerator
ELS_NONE	All Loaded.
ELS_SCENARIOS	Scenarios.
ELS_DEPENDENCIES	Dependencies.
ELS_FILES	Files.
ELS_CHANGELOG	Changelog.
ELS_ALL_ADDON	Entire addon.

ERestResult

enum ERestResult

States and result + error code produced by RestApi.

Enumerator
EREST_EMPTY	not initialized
EREST_SUCCESS	result and/or data are ready (success)
EREST_ERROR	(state >= EREST_ERROR) == error happened
EREST_ERROR_SERVERERROR
EREST_ERROR_APPERROR
EREST_ERROR_TIMEOUT
EREST_ERROR_NOTIMPLEMENTED
EREST_ERROR_PACKINGREQUEST	packing request to JSON failed (too much data?)
EREST_ERROR_CREATE	failed to even create REST request (send failed)
EREST_ERROR_RECV	failed to receive response
EREST_ERROR_SEND	failed to send request
EREST_ERROR_STORE	unable to store received data (not enough space?)
EREST_ERROR_UNKNOWN

ERevisionAvailability

enum ERevisionAvailability

Enumerator
ERA_AVAILABLE	Revision is available and can be accessed.
ERA_DELETED	Revision was deleted from the Workshop.
ERA_OBSOLETE	Revision is obsolete to this game version.

ERolePermission

enum ERolePermission

Enumerator
EPERMISSION_NOT_SET
ERPERMISSION_APPLICATION_EVALUATE
ERPERMISSION_INVITATION_CREATE
ERPERMISSION_EDIT_GROUP_DATA
ERPERMISSION_KICK_MEMBER
ERPERMISSION_ROLE_MANAGEMENT
ERPERMISSION_GROUP_DISBANDMENT

EServerCatalogueMode

enum EServerCatalogueMode

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

Enumerator
SCM_INTERNET	Server list provided by Backend.
SCM_DISCOVERY_BROADCAST	Server list discovered via broadcast on LAN.
SCM_DISCOVERY_DIRECT	Server discovered via direct IP and appended into list.
SCM_DISCOVERY_COMBINED	Combined list of servers from Broadcast and Direct Discovery.

EServerCatalogueOrderBy

enum EServerCatalogueOrderBy

Server Catalogue ordering values.

Enumerator
SCOB_NONE	ordered randomly.
SCOB_PLAYER_COUNT	ordered by player counts.
SCOB_SERVER_NAME	ordered by their names.
SCOB_SCENARIO_NAME	ordered by their current scenario names.
SCOB_LAST_JOINED	ordering based on how long ago user last joined - works only with favorites and oldest join filters

EServerCataloguePlatformMatch

enum EServerCataloguePlatformMatch

Server Catalogue value for platform support matching.

Enumerator
SCPM_ONLY_MY_PLATFORM	Will list only servers which support only platform of the client.
SCPM_CROSSPLATFORM	Will list only servers which support multiple platforms including one of the client.
SCPM_ANY_COMPATIBLE	Will list all servers that at least support platform of the client.
SCPM_ONLY_INCOMPATIBLE	Will list all servers that are not compatible with client platform.
SCPM_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

Server Catalogue value for version matching.

Enumerator
SCVM_ANY	Will list all servers regardless version.
SCVM_ONLY_MATCHING	Will list only servers with same version as the client.
SCVM_ONLY_MISMATCHING	Will list only server with different version that the client.

EServerType

enum EServerType

Determines type of the server.

Enumerator
ST_NONE	init value
ST_OFFICIAL	Official dedicated server.
ST_COMMUNITY	Dedicated server self-hosted by community on their own machines.
ST_LISTEN	Listen server hosted directly in-game by client (client + server).

EStringMatchType

enum EStringMatchType

Enum used to specify how string is matched when searching in backend database.

Enumerator
ESMT_EQUALS
ESMT_STARTS_WITH
ESMT_CONTAINS

EWorkshopItemAccessState

enum EWorkshopItemAccessState

Access restriction flags for WorkshopItems (values are bit flags!)

Enumerator
EWASTATE_OK
EWASTATE_REPORTED
EWASTATE_PRIVATE
EWASTATE_BLOCKED

EWorkshopItemType

enum EWorkshopItemType

Workshop item type.

Enumerator
EWTYPE_UNKNOWN
EWTYPE_ADDON
EWTYPE_WORLD_SAVE

EWorkshopReportType

enum EWorkshopReportType

Content reporting types.

Enumerator
EWREPORT_INAPPROPRIATE_CONTENT
EWREPORT_OFFENSIVE_LANGUAGE
EWREPORT_MISLEADING
EWREPORT_SPAM
EWREPORT_SCAM
EWREPORT_MALICIOUS
EWREPORT_INTELLECTUAL_PROPERTY
EWREPORT_OTHER

HttpCode

enum HttpCode

Common HTTP (result / error) codes Can be used in code as constant values to easier find use of specific HTTP code compared to search for simple numbers in the code.

Note

Only most common HTTP codes are covered by this enum.

Enumerator
HTTP_CODE_NULL	no code
HTTP_CODE_100	continue
HTTP_CODE_200	ok :-)
HTTP_CODE_201	created
HTTP_CODE_202	accepted
HTTP_CODE_300	(redirect) multiple choices
HTTP_CODE_301	(redirect) moved permanently
HTTP_CODE_302	(redirect) found - this may indicate improper use of "Http" instead "Https"
HTTP_CODE_303	(redirect) see other
HTTP_CODE_400	bad request response
HTTP_CODE_401	unauthorized response
HTTP_CODE_403	forbidden
HTTP_CODE_404	not found
HTTP_CODE_405	method not allowed
HTTP_CODE_408	request timeout
HTTP_CODE_409	conflict state
HTTP_CODE_412	precondition failed (access denied)
HTTP_CODE_413	payload too large (attempt to upload too much data)
HTTP_CODE_418	i'am a teapot
HTTP_CODE_422	missing data
HTTP_CODE_433	custom backend code
HTTP_CODE_444	non standard nginx used to instruct nginx to close connection :: https://httpstatus.in/444/
HTTP_CODE_500	server error
HTTP_CODE_501	not implemented
HTTP_CODE_502	bad gateway
HTTP_CODE_503	service unavailable
HTTP_CODE_504	gateway timeout
HTTP_CODE_520	the origin server returned an empty, unknown, or unexpected response to Cloudflare
HTTP_CODE_521	the origin server refused connections from Cloudflare, security solutions at the origin may be blocking legitimate connections from certain Cloudflare IP addresses
HTTP_CODE_522	Cloudflare timed out contacting the origin server.
HTTP_CODE_523	Cloudflare could not reach the origin server (for example, if the DNS records for the origin server are incorrect or missing)
HTTP_CODE_524	Cloudflare was able to complete a TCP connection to the origin server, but did not receive a timely HTTP response.
HTTP_CODE_525	Cloudflare could not negotiate a SSL/TLS handshake with the origin server.
HTTP_CODE_526	Cloudflare could not validate the SSL certificate on the origin web server, also used by Cloud Foundry's gorouter.
HTTP_CODE_530	Cloudflare was unable to resolve the origin hostname, body of the response contains an 1xxx error.