Classes
interface	BackendApi
	Backend Api instance. More...

interface	BackendCallback
	Backend Request/Response Callback class for script. 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	ClientLobbyApi

interface	Dependency
	Dependency represent minimal structure of workshop item that other things depends on. More...

interface	DownloadableCatalogue

interface	DownloadableItem

interface	DSSession
	DS server Session. More...

interface	DSSessionCallback
	Dedicated Server Session callback class for script. More...

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	RestApi

interface	RestCallback

interface	RestContext
	Script accessible REST context. More...

interface	Revision

interface	Room

interface	ServerConfigApi

interface	ServerConfigMeta

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_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_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_USER_LOCKED , EApiCode.EACODE_ERROR_USER_SERVICE_USER_NOT_FOUND , EApiCode.EACODE_ERROR_INVALID_ROOM_INVITE_TOKEN , EApiCode.EACODE_ERROR_FILE_LOAD_FAILED , EApiCode.EACODE_ERROR_FILE_SAVE_FAILED }

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_OFFLINE , EBackendError.EBERR_ALREADY_ONLINE , 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_PENDING , ERestResult.EREST_FEEDING , ERestResult.EREST_SUCCESS , ERestResult.EREST_PROCESSED , ERestResult.EREST_DEFAULT , ERestResult.EREST_ERROR , ERestResult.EREST_ERROR_CLIENTERROR , 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 }

enum	ERevisionAvailability { ERevisionAvailability.ERA_AVAILABLE , ERevisionAvailability.ERA_DELETED , ERevisionAvailability.ERA_OBSOLETE }

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	EWorkshopItemState { EWorkshopItemState.EWSTATE_ONLINE , EWorkshopItemState.EWSTATE_OFFLINE , EWorkshopItemState.EWSTATE_UPLOADING , EWorkshopItemState.EWSTATE_DOWNLOADING , EWorkshopItemState.EWSTATE_OUTDATED , EWorkshopItemState.EWSTATE_CORRUPTED , EWorkshopItemState.EWSTATE_QUEUED , EWorkshopItemState.EWSTATE_FAVOURITE , EWorkshopItemState.EWSTATE_PURCHASED , EWorkshopItemState.EWSTATE_RECOMMENDED , EWorkshopItemState.EWSTATE_HIGHLIGHTED , EWorkshopItemState.EWSTATE_MYCREATION , EWorkshopItemState.EWSTATE_BANNED , EWorkshopItemState.EWSTATE_ABORTING_DOWNLOAD }
	Workshop item stats (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...

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_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_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_USER_LOCKED
EACODE_ERROR_USER_SERVICE_USER_NOT_FOUND
EACODE_ERROR_INVALID_ROOM_INVITE_TOKEN
EACODE_ERROR_FILE_LOAD_FAILED
EACODE_ERROR_FILE_SAVE_FAILED

◆ 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_OFFLINE	state is already active
EBERR_ALREADY_ONLINE	state is already active
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, (result + error) codes defined in C++

Enumerator
EREST_EMPTY
EREST_PENDING	‍not initialized
EREST_FEEDING	‍awaiting processing
EREST_SUCCESS	‍awaiting incoming data
EREST_PROCESSED	‍result and/ or data are ready (success), awaiting data processing to be finished (no longer blocking queue processing)
EREST_DEFAULT	‍finished and ready for removal (manually released by owner)
EREST_ERROR	‍keep the original state
EREST_ERROR_CLIENTERROR	‍(state >= EREST_ERROR) == error happened
EREST_ERROR_SERVERERROR
EREST_ERROR_APPERROR
EREST_ERROR_TIMEOUT
EREST_ERROR_NOTIMPLEMENTED
EREST_ERROR_PACKINGREQUEST
EREST_ERROR_CREATE	‍packing request to JSON failed (too much data?)
EREST_ERROR_RECV	‍failed to even create REST request (send failed)
EREST_ERROR_SEND	‍failed to receive response
EREST_ERROR_STORE	‍failed to send request
EREST_ERROR_UNKNOWN	‍unable to store received data (not enough space?)

◆ 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.

◆ 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

◆ EWorkshopItemState

enum EWorkshopItemState

Workshop item stats (values are bit flags!)

Enumerator
EWSTATE_ONLINE	2
EWSTATE_OFFLINE	4 [Obsolete("Use Revision.IsDownloaded")]
EWSTATE_UPLOADING	8
EWSTATE_DOWNLOADING	16
EWSTATE_OUTDATED	32
EWSTATE_CORRUPTED	64
EWSTATE_QUEUED
EWSTATE_FAVOURITE
EWSTATE_PURCHASED
EWSTATE_RECOMMENDED
EWSTATE_HIGHLIGHTED
EWSTATE_MYCREATION	4096
EWSTATE_BANNED
EWSTATE_ABORTING_DOWNLOAD

◆ 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

Classes

Enumerations