Classes
class	WorkshopAsset
class	WorkshopAssetBase
class	WorkshopAssetTag
class	WorkshopCatalogueApi
class	WorkshopCatalogueFilters
class	WorkshopCollection
class	WorkshopCollectionItem
class	WorkshopJob
class	WorkshopLicense
class	WorkshopRevision
class	WorkshopRevisionBase
class	WorkshopUserProfile

Enumerations
enum	EWorkshopAssetState { NONE , BLOCKED , SUBSCRIBED , DISABLED , ENABLED , LOADED , PENDING_JOB , MISSING_DEPENDENCIES , CORRUPTED , CORRUPTED_UNKNOWN , NONE , BLOCKED , SUBSCRIBED , DISABLED , ENABLED , LOADED , PENDING_JOB , MISSING_DEPENDENCIES , CORRUPTED , CORRUPTED_UNKNOWN }
enum	EWorkshopAssetState { NONE , BLOCKED , SUBSCRIBED , DISABLED , ENABLED , LOADED , PENDING_JOB , MISSING_DEPENDENCIES , CORRUPTED , CORRUPTED_UNKNOWN , NONE , BLOCKED , SUBSCRIBED , DISABLED , ENABLED , LOADED , PENDING_JOB , MISSING_DEPENDENCIES , CORRUPTED , CORRUPTED_UNKNOWN }
enum	EWorkshopAssetVisibility { PUBLIC , UNLISTED , PUBLIC , UNLISTED }
enum	EWorkshopAssetVisibility { PUBLIC , UNLISTED , PUBLIC , UNLISTED }
enum	EWorkshopCatalogueOrderBy { ID , NAME , POPULARITY_NEW , POPULARITY_ALL_TIME , RATING , RATING_COUNT , SUBSCRIBER_COUNT , UNIQUE_DOWNLOAD_COUNT , LATEST_REVISION_SIZE , LATEST_REVISION_CREATED_AT , CREATED_AT , ID , NAME , POPULARITY_NEW , POPULARITY_ALL_TIME , RATING , RATING_COUNT , SUBSCRIBER_COUNT , UNIQUE_DOWNLOAD_COUNT , LATEST_REVISION_SIZE , LATEST_REVISION_CREATED_AT , CREATED_AT }
	Workshop Catalogue ordering values. More...
enum	EWorkshopCatalogueOrderBy { ID , NAME , POPULARITY_NEW , POPULARITY_ALL_TIME , RATING , RATING_COUNT , SUBSCRIBER_COUNT , UNIQUE_DOWNLOAD_COUNT , LATEST_REVISION_SIZE , LATEST_REVISION_CREATED_AT , CREATED_AT , ID , NAME , POPULARITY_NEW , POPULARITY_ALL_TIME , RATING , RATING_COUNT , SUBSCRIBER_COUNT , UNIQUE_DOWNLOAD_COUNT , LATEST_REVISION_SIZE , LATEST_REVISION_CREATED_AT , CREATED_AT }
enum	EWorkshopJobState { PREPARING , ACTIVE , QUEUED , PAUSED , FINISHED , CANCELED , FAILED , PREPARING , ACTIVE , QUEUED , PAUSED , FINISHED , CANCELED , FAILED }
	Determines state in which WorkshopJob currently is in. More...
enum	EWorkshopJobState { PREPARING , ACTIVE , QUEUED , PAUSED , FINISHED , CANCELED , FAILED , PREPARING , ACTIVE , QUEUED , PAUSED , FINISHED , CANCELED , FAILED }
enum	EWorkshopJobTask { DOWNLOAD , UPDATE , DOWNGRADE , VALIDATE , REPAIR , DOWNLOAD , UPDATE , DOWNGRADE , VALIDATE , REPAIR }
	Determines what task is WorkshopJob supposed to do. More...
enum	EWorkshopJobTask { DOWNLOAD , UPDATE , DOWNGRADE , VALIDATE , REPAIR , DOWNLOAD , UPDATE , DOWNGRADE , VALIDATE , REPAIR }
enum	EWorkshopReportTypes { GAMECODE , GAMECODE }
enum	EWorkshopReportTypes { GAMECODE , GAMECODE }
enum	WorkshopInitState { INIT , INIT_RETRY , READY , DISABLED , INIT , INIT_RETRY , READY , DISABLED }
enum	WorkshopInitState { INIT , INIT_RETRY , READY , DISABLED , INIT , INIT_RETRY , READY , DISABLED }

Detailed Description

Enumeration Type Documentation

◆ EWorkshopAssetState [1/2]

enum EWorkshopAssetState

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

Definition at line 15 of file EWorkshopAssetState.c.

◆ EWorkshopAssetState [2/2]

enum EWorkshopAssetState

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

Definition at line 15 of file EWorkshopAssetState.c.

◆ EWorkshopAssetVisibility [1/2]

enum EWorkshopAssetVisibility

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

Definition at line 15 of file EWorkshopAssetVisibility.c.

◆ EWorkshopAssetVisibility [2/2]

enum EWorkshopAssetVisibility

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

Definition at line 15 of file EWorkshopAssetVisibility.c.

◆ EWorkshopCatalogueOrderBy [1/2]

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

Definition at line 13 of file EWorkshopCatalogueOrderBy.c.

◆ EWorkshopCatalogueOrderBy [2/2]

enum EWorkshopCatalogueOrderBy

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

Definition at line 13 of file EWorkshopCatalogueOrderBy.c.

◆ EWorkshopJobState [1/2]

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

Definition at line 13 of file EWorkshopJobState.c.

◆ EWorkshopJobState [2/2]

enum EWorkshopJobState

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

Definition at line 13 of file EWorkshopJobState.c.

◆ EWorkshopJobTask [1/2]

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

Definition at line 13 of file EWorkshopJobTask.c.

◆ EWorkshopJobTask [2/2]

enum EWorkshopJobTask

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

Definition at line 13 of file EWorkshopJobTask.c.

◆ EWorkshopReportTypes [1/2]

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.
GAMECODE	INTERNAL - first type in gamecode definition should have this value.

Definition at line 17 of file EWorkshopReportTypes.c.

◆ EWorkshopReportTypes [2/2]