Online_workshop

Classes
interface	WorkshopAsset
	Final structure of the workshop asset which contains all data and functionality. More...
interface	WorkshopAssetBase
	Base structure for all assets from workshop containing partial data of the full asset. More...
interface	WorkshopAssetTag
interface	WorkshopCatalogueApi
interface	WorkshopCatalogueFilters
interface	WorkshopCollection
	This structure represent collection of multiple workshop assets alongside specific or latest revisions. More...
interface	WorkshopCollectionItem
	This is data structure which encapsulates individual asset and its specific revision. More...
interface	WorkshopJob
	This is interface to track state and control individual asynchronous jobs withing workshop. More...
interface	WorkshopLicense
	Structure containing details about licensing for individual revisions of workshop assets. More...
interface	WorkshopRevision
	Final structure of the workshop asset which contains all data and functionality. More...
interface	WorkshopRevisionBase
interface	WorkshopUserProfile
	Structure containing details about licensing for individual revisions of workshop assets. More...

Enumerations
enum	EWorkshopAssetState {   EWorkshopAssetState.NONE , EWorkshopAssetState.BLOCKED , EWorkshopAssetState.SUBSCRIBED , EWorkshopAssetState.DISABLED ,   EWorkshopAssetState.ENABLED , EWorkshopAssetState.LOADED , EWorkshopAssetState.PENDING_JOB , EWorkshopAssetState.MISSING_DEPENDENCIES ,   EWorkshopAssetState.CORRUPTED , EWorkshopAssetState.CORRUPTED_UNKNOWN }
	Specifies possible states of locally available revision of this asset. More...
enum	EWorkshopAssetVisibility { EWorkshopAssetVisibility.PUBLIC , EWorkshopAssetVisibility.UNLISTED }
	Possible visibility states of an asset on the workshop. More...
enum	EWorkshopCatalogueOrderBy {   EWorkshopCatalogueOrderBy.ID , EWorkshopCatalogueOrderBy.NAME , EWorkshopCatalogueOrderBy.POPULARITY_NEW , EWorkshopCatalogueOrderBy.POPULARITY_ALL_TIME ,   EWorkshopCatalogueOrderBy.RATING , EWorkshopCatalogueOrderBy.RATING_COUNT , EWorkshopCatalogueOrderBy.SUBSCRIBER_COUNT , EWorkshopCatalogueOrderBy.UNIQUE_DOWNLOAD_COUNT ,   EWorkshopCatalogueOrderBy.LATEST_REVISION_SIZE , EWorkshopCatalogueOrderBy.LATEST_REVISION_CREATED_AT , EWorkshopCatalogueOrderBy.CREATED_AT }
	Workshop Catalogue ordering values. More...
enum	EWorkshopJobState {   EWorkshopJobState.PREPARING , EWorkshopJobState.ACTIVE , EWorkshopJobState.QUEUED , EWorkshopJobState.PAUSED ,   EWorkshopJobState.FINISHED , EWorkshopJobState.CANCELED , EWorkshopJobState.FAILED }
	Determines state in which WorkshopJob currently is in. More...
enum	EWorkshopJobTask {   EWorkshopJobTask.DOWNLOAD , EWorkshopJobTask.UPDATE , EWorkshopJobTask.DOWNGRADE , EWorkshopJobTask.VALIDATE ,   EWorkshopJobTask.REPAIR }
	Determines what task is WorkshopJob supposed to do. More...
enum	EWorkshopReportTypes { EWorkshopReportTypes.GAMECODE }
	Enums specifies types of reports for the asset. More...
enum	WorkshopInitState { WorkshopInitState.INIT , WorkshopInitState.INIT_RETRY , WorkshopInitState.READY , WorkshopInitState.DISABLED }

Detailed Description

Enumeration Type Documentation

EWorkshopAssetState

enum EWorkshopAssetState

sealed

Specifies possible states of locally available revision of this asset.

Enumerator
NONE	No revision is locally available/downloaded and not subscribed (cannot download until subscribed).
BLOCKED	User has this asset blocked so it should not be possible to interact with it until unblocked.
SUBSCRIBED	Asset is subscribed but no revision is downloaded (waiting for request to begin download).
DISABLED	Asset is disabled and should not load any data until until enabled.
ENABLED	Asset is marked as enabled and its data should be loaded when possible.
LOADED	Asset is loaded and some operations should not be possible in this state.
PENDING_JOB	This asset has currently pending job and cannot be used until finished.
MISSING_DEPENDENCIES	Current revision is missing some dependencies and will not be allowed to be used (ENABLED and LOADED) until fixed.
CORRUPTED	Current revision is corrupted and cannot be used (ENABLED and LOADED) until fixed.
CORRUPTED_UNKNOWN	Asset has some data downloaded but unknown to which revision - cannot be repaired.

EWorkshopAssetVisibility

enum EWorkshopAssetVisibility

sealed

Possible visibility states of an asset on the workshop.

Enumerator
PUBLIC	Any user can find and view the asset when browsing workshop.
UNLISTED	The asset doesn't appear when browsing workshop or search results but anyone that knows it's GUID can view and download it.

EWorkshopCatalogueOrderBy

enum EWorkshopCatalogueOrderBy

Workshop Catalogue ordering values.

Enumerator
ID	ordered by assets IDs.
NAME	ordered by assets names.
POPULARITY_NEW	ordered by assets popularities prioritizing recently newly released.
POPULARITY_ALL_TIME	ordered by assets popularities regardless of when it was released.
RATING	ordered by assets overall ratings.
RATING_COUNT	ordered by how many people rated assets.
SUBSCRIBER_COUNT	ordered by how many people have currently subscribed those assets (should have downloaded right now).
UNIQUE_DOWNLOAD_COUNT	ordered by how many people have ever downloaded those assets.
LATEST_REVISION_SIZE	ordered by total size of latest revision of assets.
LATEST_REVISION_CREATED_AT	ordered by time when assets had latest update - latest revision created.
CREATED_AT	ordered by time when the assets were created.

EWorkshopJobState

enum EWorkshopJobState

Determines state in which WorkshopJob currently is in.

Enumerator
PREPARING	Job is preparing to be active.
ACTIVE	Job is currently actively processing its task.
QUEUED	Job is queued and waiting for other ACTIVE task to finish.
PAUSED	Job is paused and will not continue until resumed.
FINISHED	Job was successfully finished.
CANCELED	Job was canceled and will not do any additional actions.
FAILED	Job failed during its processing and can be retried.

EWorkshopJobTask

enum EWorkshopJobTask

Determines what task is WorkshopJob supposed to do.

Enumerator
DOWNLOAD	Job is downloading revision without any other revision of the asset present - fresh download.
UPDATE	Some revision is already present and job is downloading newer one.
DOWNGRADE	Some revision is already present and job is downloading older one.
VALIDATE	Job is doing deep validation where it attempts to find if any fragment is corrupted.
REPAIR	Job is fixing corrupted fragments.

EWorkshopReportTypes

enum EWorkshopReportTypes

Enums specifies types of reports for the asset.

Warning

Core implementation does not provide any predefined types. Every project must define its own types inside gamecode.

Enumerator
GAMECODE	INTERNAL - first type in gamecode definition should have this value.

WorkshopInitState

enum WorkshopInitState

sealed

Enumerator
INIT	Workshop is initializing data and any systems or UI elements should wait until ready.
INIT_RETRY	Workshop init failed and retry will be attempted - semi-permanent state to indicate issues with INIT until success.
READY	Workshop is ready and can be used by other systems and UI - permanent state until application restart.
DISABLED	Workshop is disabled and any systems or UI elements should be also disabled - permanent state until application restart.