Protected Member Functions
WorkshopItem	GetWorkshopItem ()
	Use these only if absoulutely necessary to intarract with game API.
Dependency	GetDependency ()
bool	GetItemDataLoaded ()
	Getters for loading state.
bool	GetDetailsLoaded ()
bool	GetScenariosLoaded ()
bool	GetRevisionsLoaded ()
bool	GetDependenciesLoaded ()
bool	GetRequestFailed ()
bool	IsDownloadRunning ()
void	LogState ()
	Logs all properties of the object into console.
void	LoadDetails ()
	Loads details from backend, or if they are already loaded, calls the callbacks immediately.
void	GetScenarios (array< MissionWorkshopItem > scenarios)
	Returns array of scenarios.
array< ref SCR_WorkshopItem >	GetLatestDependencies ()
	Returns array of dependencies.
array< ref SCR_WorkshopItem >	GetDependentAddons ()
	Returns array of dependendent addons.
string	GetLatestVersion ()
array< string >	GetVersions ()
	Returns array of versions.
bool	IsDownloadedVersionCompatible ()
	Returns true if downloaded revision was uploded after 1.0.
void	SetMyRating (bool newRating)
void	ResetMyRating ()
void	GetMyRating (out bool ratingSet, out bool rating)
void	SetFavourite (bool favourite)
bool	GetFavourite ()
void	OnFavouriteSuccess ()
void	OnFavouriteFail ()
void	SetSubscribed (bool subscribe)
bool	GetSubscribed ()
void	SetEnabled (bool enable)
void	SetDependenciesEnabled (bool enable)
	Enables/disables all downloaded dependencies.
bool	GetEnabled ()
bool	GetLoaded ()
	True when addon is loaded by engine. It means that the game is already running with this mod.
bool	GetBlocked ()
bool	GetReportedByMe ()
bool	GetModAuthorReportedByMe ()
bool	IsWorldSave ()
bool	GetRestricted ()
	Returns true when item is restricted for any reason (blocked or reported).
bool	DeleteLocally ()
void	DeleteDownloadProgress ()
string	GetName ()
string	GetId ()
string	GetAuthorName ()
bool	GetOnline ()
	True when the item is stored in the backend.
bool	GetOffline ()
	True when we have the item on our local storage.
Revision	GetCurrentLocalRevision ()
	Returns the revision which we currently have on the local storage.
bool	GetCurrentLocalVersionMatchDependency ()
	Returns true if current local version matches version of dependency.
bool	GetCorrupted ()
BackendImage	GetThumbnail ()
array< BackendImage >	GetGallery ()
string	GetDescription ()
string	GetSummary ()
int	GetRatingCount ()
float	GetSizeBytes ()
void	OnPatchComputed ()
void	OnPatchComputedFailed ()
float	GetAverageRating ()
void	GetDownloadState (out bool inProgress, out bool paused, out float progress, out Revision targetRevision)
	Returns state of the download process.
SCR_WorkshopItemActionDownload	GetDownloadAction ()
	Returns current download action.
SCR_WorkshopItemActionComposite	GetDependencyCompositeAction ()
	Returns the current composite action performed for dependencies of this addon.
bool	GetUpdateAvailable ()
	Returns true when we have an old version offline, and the new version.
array< ref SCR_WorkshopItem >	GetMissingDependencies ()
	Returns dependencies which are missing.
bool	GetAnyDependencyMissing ()
bool	GetAnyDependencyUpdateAvailable ()
bool	GetEnabledAndAnyDependencyDisabled ()
	Returns true if any dependency is offline and disabled.
EWorkshopItemProblem	GetHighestPriorityProblem ()
array< ref SCR_WorkshopItem >	GetOutdatedDependencies ()
	Returns dependencies which can be updated.
int	GetTimeSinceLastPlay ()
int	GetTimeSinceFirstDownload ()
SCR_WorkshopItemActionDownload	DownloadRevision (Revision targetRevision, bool isDownloadRunning)
SCR_WorkshopItemActionDownload	Download (notnull Revision targetRevision)
SCR_WorkshopItemActionDownload	DownloadLatestVersion ()
SCR_WorkshopItemActionDownload	RetryDownload (Revision targetRevision)
SCR_WorkshopItemActionDownloadDependenciesLatest	DownloadDependenciesLatest (array< ref SCR_WorkshopItem > dependencies)
bool	PauseDownload ()
	Pauses current download, if possible.
bool	CancelDownload ()
	Cancels current download, if possible.
bool	ResumeDownload ()
	Resumes current download, if it's already started.
SCR_WorkshopItemActionReport	Report (EWorkshopReportType eReport, string sMessage)
void	LoadReport ()
	Loads report of current user from backend. Subscribe to m_OnMyReportLoaded to get result.
void	GetReport (out EWorkshopReportType reportType, out string reportDescription)
SCR_WorkshopItemActionCancelReport	CancelReport ()
	Sends a cancel report about this workshop item.
SCR_WorkshopItemActionAddAuthorBlock	AddAuthorBlock ()
	Add block for workshop author and all author mods.
SCR_WorkshopItemActionRemoveAuthorBlock	RemoveAuthorBlock ()
	Add block for workshop author and all author mods.
Revision	FindRevision (string version)
	Finds revision object by string version.
Revision	GetLatestRevision ()
void	Callback_AskDetails_OnGetAsset ()
void	Callback_AskDetails_OnError (BackendCallback callback)
void	Callback_LoadDependencies_OnSuccess ()
void	Callback_LoadDependencies_OnError (BackendCallback cb)
void	Callback_LoadScenarios_OnSuccess ()
void	Callback_LoadScenarios_OnError (BackendCallback cb)
void	Callback_LoadMyReport_OnSuccess ()
void	Callback_LoadMyReport_OnError ()
void	TryLoadItemFromDependency ()
void	TryLoadRevisions (bool log=true)
array< ref SCR_WorkshopItem >	GetLoadedDependencies ()
void	TryLoadDependencies (bool log=true)
void	TryLoadScenarios (bool log=true)
void	RegisterDependency (SCR_WorkshopItem item)
void	UnregisterDependency (SCR_WorkshopItem item)
void	RegisterDependent (SCR_WorkshopItem item)
void	UnregisterDependent (SCR_WorkshopItem item)
bool	Internal_StartDownload (notnull Revision targetRevision, BackendCallback callback)
bool	Internal_CancelDownload ()
void	OnCancelDownloadResponse (BackendCallback callback)
void	OnCancelDownloadError (BackendCallback callback)
bool	Internal_Report (EWorkshopReportType eReport, string sMessage, BackendCallback callback)
bool	Internal_CancelReport (BackendCallback callback)
bool	Internal_AddAuthorBlock (BackendCallback callback)
bool	Internal_RemoveAuthorBlock (BackendCallback callback)
void	Internal_Update (float timeSlice)
	Called each frame by Addon Manager.
void	UpdateAuthorBlock ()
	Check state of action to add and remove author block in update.
void	Internal_OnChanged ()
	Called by actions when some change happens.
bool	Internal_GetCanBeUnregistered ()
WorkshopItem	Internal_GetWorkshopItem ()
	Returns true when it can be unregistered bu addon manager.
float	Internal_GetDownloadProgress ()
bool	Internal_GetIsProcessing ()
float	Internal_GetProcessingProgress ()
void	Internal_LoadDetails ()
	Creates a callback object, requests workshop API to load details.
void	SetItemTargetRevision (Revision revision)
Revision	GetItemTargetRevision ()
void	SetTargetRevisionPatchSize (float size)
float	GetTargetRevisionPatchSize ()
void	SetChanged ()
bool	Internal_GetUpdateAvailable ()
void	UpdateStateFromWorkshopItem ()
void	_print (string str, LogLevel logLevel=LogLevel.DEBUG)
void	CustomDebugError (string message)

Static Protected Member Functions
static SCR_WorkshopItem	Internal_CreateFromWorkshopItem (WorkshopItem item)
static SCR_WorkshopItem	Internal_CreateFromDependency (Dependency dependency)
static void	_sprint (string str, LogLevel logLevel=LogLevel.DEBUG)

Protected Attributes
ref WorkshopItem	m_Item
ref Dependency	m_Dependency
ref Revision	m_LatestRevision
ref Revision	m_ItemTargetRevision
float	m_fTargetRevisionPatchSize
ref array< MissionWorkshopItem >	m_aMissions
ref array< ref SCR_WorkshopItem >	m_aDependencies
ref array< SCR_WorkshopItem >	m_aDependent = new array<SCR_WorkshopItem>
ref array< Revision >	m_aRevisions
bool	m_bDetailsLoaded
bool	m_bSizeRequesting
ref SCR_WorkshopItemCallback_AskDetails	m_CallbackAskDetails
ref BackendCallback	m_CallbackLoadGallery
ref BackendCallback	m_CallbackLoadDependencies
ref BackendCallback	m_CallbackLoadScenarios
ref BackendCallback	m_CallbackLoadMyReport
ref BackendCallback	m_CallbackRequestFavourite
ref BackendCallback	m_CancelDownloadCallback = new BackendCallback()
ref BackendCallback	m_ComputeCallback
bool	m_bMyRating
bool	m_bMyRatingSet
bool	m_bFavourite
bool	m_bFavouriteRequesting
bool	m_bSubscribed
bool	m_bChanged
bool	m_bRequestFailed
bool	m_bOffline
int	m_iAccessState
bool	m_bWaitingLoadDetails
float	m_fPrevDownloadProgress
ref SCR_WorkshopItemActionDownload	m_ActionDownload
ref SCR_WorkshopItemActionReport	m_ActionReport
ref SCR_WorkshopItemActionCancelReport	m_ActionCancelReport
ref SCR_WorkshopItemActionComposite	m_ActionDependency
ref SCR_WorkshopItemActionAddAuthorBlock	m_ActionAddAuthorBlock
ref SCR_WorkshopItemActionRemoveAuthorBlock	m_ActionRemoveAuthorBlock

Detailed Description

Definition at line 27 of file SCR_WorkshopItem.c.

Member Function Documentation

◆ _print()

void SCR_WorkshopItem::_print	(	string	str,
		LogLevel	logLevel = LogLevel.DEBUG )

inlineprotected

Definition at line 2346 of file SCR_WorkshopItem.c.

◆ _sprint()

void SCR_WorkshopItem::_sprint	(	string	str,
		LogLevel	logLevel = LogLevel.DEBUG )

inlinestaticprotected

Definition at line 2340 of file SCR_WorkshopItem.c.

◆ AddAuthorBlock()

SCR_WorkshopItemActionAddAuthorBlock SCR_WorkshopItem::AddAuthorBlock ( )

inlineprotected

Add block for workshop author and all author mods.

Definition at line 1206 of file SCR_WorkshopItem.c.

◆ Callback_AskDetails_OnError()

void SCR_WorkshopItem::Callback_AskDetails_OnError ( BackendCallback callback )

inlineprotected

Definition at line 1344 of file SCR_WorkshopItem.c.

◆ Callback_AskDetails_OnGetAsset()

void SCR_WorkshopItem::Callback_AskDetails_OnGetAsset ( )

inlineprotected

Definition at line 1278 of file SCR_WorkshopItem.c.

◆ Callback_LoadDependencies_OnError()

void SCR_WorkshopItem::Callback_LoadDependencies_OnError ( BackendCallback cb )

inlineprotected

Definition at line 1379 of file SCR_WorkshopItem.c.

◆ Callback_LoadDependencies_OnSuccess()

void SCR_WorkshopItem::Callback_LoadDependencies_OnSuccess ( )

inlineprotected

Definition at line 1369 of file SCR_WorkshopItem.c.

◆ Callback_LoadMyReport_OnError()

void SCR_WorkshopItem::Callback_LoadMyReport_OnError ( )

inlineprotected

Definition at line 1434 of file SCR_WorkshopItem.c.

◆ Callback_LoadMyReport_OnSuccess()

void SCR_WorkshopItem::Callback_LoadMyReport_OnSuccess ( )

inlineprotected

Definition at line 1428 of file SCR_WorkshopItem.c.

◆ Callback_LoadScenarios_OnError()

void SCR_WorkshopItem::Callback_LoadScenarios_OnError ( BackendCallback cb )

inlineprotected

Definition at line 1409 of file SCR_WorkshopItem.c.

◆ Callback_LoadScenarios_OnSuccess()

void SCR_WorkshopItem::Callback_LoadScenarios_OnSuccess ( )

inlineprotected

Definition at line 1399 of file SCR_WorkshopItem.c.

◆ CancelDownload()

bool SCR_WorkshopItem::CancelDownload ( )

inlineprotected

Cancels current download, if possible.

Definition at line 1095 of file SCR_WorkshopItem.c.

◆ CancelReport()

SCR_WorkshopItemActionCancelReport SCR_WorkshopItem::CancelReport ( )

inlineprotected

Sends a cancel report about this workshop item.

Definition at line 1186 of file SCR_WorkshopItem.c.

◆ CustomDebugError()

void SCR_WorkshopItem::CustomDebugError ( string message )

inlineprotected

Definition at line 2352 of file SCR_WorkshopItem.c.

◆ DeleteDownloadProgress()

void SCR_WorkshopItem::DeleteDownloadProgress ( )

inlineprotected

Definition at line 602 of file SCR_WorkshopItem.c.

◆ DeleteLocally()

bool SCR_WorkshopItem::DeleteLocally ( )

inlineprotected

Definition at line 576 of file SCR_WorkshopItem.c.

◆ Download()

SCR_WorkshopItemActionDownload SCR_WorkshopItem::Download ( notnull Revision targetRevision )

inlineprotected

Starts download of a specific version. Returns an action object, use it to control the download process or To get notified about its events.

!!! If a download of same version is already running, it doesn't create a new action !!! But returns a previous one instead.

! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
! You must call Activate() of the returned action yourself. ! This is done this way so that you can subscribe to events before the action is started. ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !

Definition at line 991 of file SCR_WorkshopItem.c.

◆ DownloadDependenciesLatest()

SCR_WorkshopItemActionDownloadDependenciesLatest SCR_WorkshopItem::DownloadDependenciesLatest ( array< ref SCR_WorkshopItem > dependencies )

inlineprotected

Starts downloading latest version of dependencies which are offline !!! If a previous same action is running, it doesn't create a new action but !!! Returns a previous action instead.

Definition at line 1041 of file SCR_WorkshopItem.c.

◆ DownloadLatestVersion()

SCR_WorkshopItemActionDownload SCR_WorkshopItem::DownloadLatestVersion ( )

inlineprotected

Definition at line 1008 of file SCR_WorkshopItem.c.

◆ DownloadRevision()

SCR_WorkshopItemActionDownload SCR_WorkshopItem::DownloadRevision	(	Revision	targetRevision,
		bool	isDownloadRunning )

inlineprotected

Unified download to target revision There can be different revisions and reasons to setup new download No target revision = latest

Definition at line 946 of file SCR_WorkshopItem.c.

◆ FindRevision()

Revision SCR_WorkshopItem::FindRevision ( string version )

inlineprotected

Finds revision object by string version.

Definition at line 1232 of file SCR_WorkshopItem.c.

◆ GetAnyDependencyMissing()

bool SCR_WorkshopItem::GetAnyDependencyMissing ( )

inlineprotected

Definition at line 858 of file SCR_WorkshopItem.c.

◆ GetAnyDependencyUpdateAvailable()

bool SCR_WorkshopItem::GetAnyDependencyUpdateAvailable ( )

inlineprotected

Definition at line 868 of file SCR_WorkshopItem.c.

◆ GetAuthorName()

string SCR_WorkshopItem::GetAuthorName ( )

inlineprotected

Definition at line 632 of file SCR_WorkshopItem.c.

◆ GetAverageRating()

float SCR_WorkshopItem::GetAverageRating ( )

inlineprotected

Definition at line 788 of file SCR_WorkshopItem.c.

◆ GetBlocked()

bool SCR_WorkshopItem::GetBlocked ( )

inlineprotected

Definition at line 523 of file SCR_WorkshopItem.c.

◆ GetCorrupted()

bool SCR_WorkshopItem::GetCorrupted ( )

inlineprotected

Definition at line 694 of file SCR_WorkshopItem.c.

◆ GetCurrentLocalRevision()

Revision SCR_WorkshopItem::GetCurrentLocalRevision ( )

inlineprotected

Returns the revision which we currently have on the local storage.

Definition at line 670 of file SCR_WorkshopItem.c.

◆ GetCurrentLocalVersionMatchDependency()

bool SCR_WorkshopItem::GetCurrentLocalVersionMatchDependency ( )

inlineprotected

Returns true if current local version matches version of dependency.

Definition at line 680 of file SCR_WorkshopItem.c.

◆ GetDependenciesLoaded()

bool SCR_WorkshopItem::GetDependenciesLoaded ( )

inlineprotected

Definition at line 118 of file SCR_WorkshopItem.c.

◆ GetDependency()

Dependency SCR_WorkshopItem::GetDependency ( )

inlineprotected

Definition at line 111 of file SCR_WorkshopItem.c.

◆ GetDependencyCompositeAction()

SCR_WorkshopItemActionComposite SCR_WorkshopItem::GetDependencyCompositeAction ( )

inlineprotected

Returns the current composite action performed for dependencies of this addon.

Definition at line 824 of file SCR_WorkshopItem.c.

◆ GetDependentAddons()

array< ref SCR_WorkshopItem > SCR_WorkshopItem::GetDependentAddons ( )

inlineprotected

Returns array of dependendent addons.

Definition at line 253 of file SCR_WorkshopItem.c.

◆ GetDescription()

string SCR_WorkshopItem::GetDescription ( )

inlineprotected

Definition at line 726 of file SCR_WorkshopItem.c.

◆ GetDetailsLoaded()

bool SCR_WorkshopItem::GetDetailsLoaded ( )

inlineprotected

Definition at line 115 of file SCR_WorkshopItem.c.

◆ GetDownloadAction()

SCR_WorkshopItemActionDownload SCR_WorkshopItem::GetDownloadAction ( )

inlineprotected

Returns current download action.

Definition at line 817 of file SCR_WorkshopItem.c.

◆ GetDownloadState()

void SCR_WorkshopItem::GetDownloadState	(	out bool	inProgress,
		out bool	paused,
		out float	progress,
		out Revision	targetRevision )

inlineprotected

Returns state of the download process.

Definition at line 798 of file SCR_WorkshopItem.c.

◆ GetEnabled()

bool SCR_WorkshopItem::GetEnabled ( )

inlineprotected

Definition at line 500 of file SCR_WorkshopItem.c.

◆ GetEnabledAndAnyDependencyDisabled()

bool SCR_WorkshopItem::GetEnabledAndAnyDependencyDisabled ( )

inlineprotected

Returns true if any dependency is offline and disabled.

Definition at line 879 of file SCR_WorkshopItem.c.

◆ GetFavourite()

bool SCR_WorkshopItem::GetFavourite ( )

inlineprotected

Definition at line 406 of file SCR_WorkshopItem.c.

◆ GetGallery()

array< BackendImage > SCR_WorkshopItem::GetGallery ( )

inlineprotected

Definition at line 714 of file SCR_WorkshopItem.c.

◆ GetHighestPriorityProblem()

EWorkshopItemProblem SCR_WorkshopItem::GetHighestPriorityProblem ( )

inlineprotected

Returns highest priority issue of this addon if it's downloaded, Addon might have all issue types at once, but this method returns only the most important issue In the order most suitable for UI

Definition at line 895 of file SCR_WorkshopItem.c.

◆ GetId()

string SCR_WorkshopItem::GetId ( )

inlineprotected

Definition at line 621 of file SCR_WorkshopItem.c.

◆ GetItemDataLoaded()

bool SCR_WorkshopItem::GetItemDataLoaded ( )

inlineprotected

Getters for loading state.

Definition at line 114 of file SCR_WorkshopItem.c.

◆ GetItemTargetRevision()

Revision SCR_WorkshopItem::GetItemTargetRevision ( )

inlineprotected

Definition at line 2164 of file SCR_WorkshopItem.c.

◆ GetLatestDependencies()

array< ref SCR_WorkshopItem > SCR_WorkshopItem::GetLatestDependencies ( )

inlineprotected

Returns array of dependencies.

Definition at line 238 of file SCR_WorkshopItem.c.

◆ GetLatestRevision()

Revision SCR_WorkshopItem::GetLatestRevision ( )

inlineprotected

Definition at line 1252 of file SCR_WorkshopItem.c.

◆ GetLatestVersion()

string SCR_WorkshopItem::GetLatestVersion ( )

inlineprotected

Definition at line 270 of file SCR_WorkshopItem.c.

◆ GetLoaded()

bool SCR_WorkshopItem::GetLoaded ( )

inlineprotected

True when addon is loaded by engine. It means that the game is already running with this mod.

Definition at line 514 of file SCR_WorkshopItem.c.

◆ GetLoadedDependencies()

array< ref SCR_WorkshopItem > SCR_WorkshopItem::GetLoadedDependencies ( )

inlineprotected

Definition at line 1488 of file SCR_WorkshopItem.c.

◆ GetMissingDependencies()

array< ref SCR_WorkshopItem > SCR_WorkshopItem::GetMissingDependencies ( )

inlineprotected

Returns dependencies which are missing.

Definition at line 850 of file SCR_WorkshopItem.c.

◆ GetModAuthorReportedByMe()

bool SCR_WorkshopItem::GetModAuthorReportedByMe ( )

inlineprotected

Definition at line 544 of file SCR_WorkshopItem.c.

◆ GetMyRating()

void SCR_WorkshopItem::GetMyRating	(	out bool	ratingSet,
		out bool	rating )

inlineprotected

Definition at line 372 of file SCR_WorkshopItem.c.

◆ GetName()

string SCR_WorkshopItem::GetName ( )

inlineprotected

Definition at line 610 of file SCR_WorkshopItem.c.

◆ GetOffline()

bool SCR_WorkshopItem::GetOffline ( )

inlineprotected

True when we have the item on our local storage.

Definition at line 658 of file SCR_WorkshopItem.c.

◆ GetOnline()

bool SCR_WorkshopItem::GetOnline ( )

inlineprotected

True when the item is stored in the backend.

Definition at line 647 of file SCR_WorkshopItem.c.

◆ GetOutdatedDependencies()

array< ref SCR_WorkshopItem > SCR_WorkshopItem::GetOutdatedDependencies ( )

inlineprotected

Returns dependencies which can be updated.

Definition at line 914 of file SCR_WorkshopItem.c.

◆ GetRatingCount()

int SCR_WorkshopItem::GetRatingCount ( )

inlineprotected

Definition at line 744 of file SCR_WorkshopItem.c.

◆ GetReport()

void SCR_WorkshopItem::GetReport	(	out EWorkshopReportType	reportType,
		out string	reportDescription )

inlineprotected

Returns our own report. We must load it first with LoadMyReport. How the function behaves immediately relative to data passed through Report() is undefined.

Definition at line 1170 of file SCR_WorkshopItem.c.

◆ GetReportedByMe()

bool SCR_WorkshopItem::GetReportedByMe ( )

inlineprotected

Definition at line 535 of file SCR_WorkshopItem.c.

◆ GetRequestFailed()

bool SCR_WorkshopItem::GetRequestFailed ( )

inlineprotected

Definition at line 119 of file SCR_WorkshopItem.c.

◆ GetRestricted()

bool SCR_WorkshopItem::GetRestricted ( )

inlineprotected

Returns true when item is restricted for any reason (blocked or reported).

Definition at line 570 of file SCR_WorkshopItem.c.

◆ GetRevisionsLoaded()

bool SCR_WorkshopItem::GetRevisionsLoaded ( )

inlineprotected

Definition at line 117 of file SCR_WorkshopItem.c.

◆ GetScenarios()

void SCR_WorkshopItem::GetScenarios ( array< MissionWorkshopItem > scenarios )

inlineprotected

Returns array of scenarios.

Definition at line 226 of file SCR_WorkshopItem.c.

◆ GetScenariosLoaded()

bool SCR_WorkshopItem::GetScenariosLoaded ( )

inlineprotected

Definition at line 116 of file SCR_WorkshopItem.c.

◆ GetSizeBytes()

float SCR_WorkshopItem::GetSizeBytes ( )

inlineprotected

Definition at line 753 of file SCR_WorkshopItem.c.

◆ GetSubscribed()

bool SCR_WorkshopItem::GetSubscribed ( )

inlineprotected

Definition at line 450 of file SCR_WorkshopItem.c.

◆ GetSummary()

string SCR_WorkshopItem::GetSummary ( )

inlineprotected

Definition at line 735 of file SCR_WorkshopItem.c.

◆ GetTargetRevisionPatchSize()

float SCR_WorkshopItem::GetTargetRevisionPatchSize ( )

inlineprotected

Get dependency target revision patch size Dependency has to be define and patch has to be computed

Definition at line 2178 of file SCR_WorkshopItem.c.

◆ GetThumbnail()

BackendImage SCR_WorkshopItem::GetThumbnail ( )

inlineprotected

Definition at line 705 of file SCR_WorkshopItem.c.

◆ GetTimeSinceFirstDownload()

int SCR_WorkshopItem::GetTimeSinceFirstDownload ( )

inlineprotected

Definition at line 934 of file SCR_WorkshopItem.c.

◆ GetTimeSinceLastPlay()

int SCR_WorkshopItem::GetTimeSinceLastPlay ( )

inlineprotected

Definition at line 925 of file SCR_WorkshopItem.c.

◆ GetUpdateAvailable()

bool SCR_WorkshopItem::GetUpdateAvailable ( )

inlineprotected

Returns true when we have an old version offline, and the new version.

Definition at line 831 of file SCR_WorkshopItem.c.

◆ GetVersions()

array< string > SCR_WorkshopItem::GetVersions ( )

inlineprotected

Returns array of versions.

Definition at line 282 of file SCR_WorkshopItem.c.

◆ GetWorkshopItem()

WorkshopItem SCR_WorkshopItem::GetWorkshopItem ( )

inlineprotected

Use these only if absoulutely necessary to intarract with game API.

Definition at line 110 of file SCR_WorkshopItem.c.

◆ Internal_AddAuthorBlock()

bool SCR_WorkshopItem::Internal_AddAuthorBlock ( BackendCallback callback )

inlineprotected

Definition at line 1778 of file SCR_WorkshopItem.c.

◆ Internal_CancelDownload()

bool SCR_WorkshopItem::Internal_CancelDownload ( )

inlineprotected

Definition at line 1651 of file SCR_WorkshopItem.c.

◆ Internal_CancelReport()

bool SCR_WorkshopItem::Internal_CancelReport ( BackendCallback callback )

inlineprotected

Definition at line 1757 of file SCR_WorkshopItem.c.

◆ Internal_CreateFromDependency()

SCR_WorkshopItem SCR_WorkshopItem::Internal_CreateFromDependency ( Dependency dependency )

inlinestaticprotected

Definition at line 2306 of file SCR_WorkshopItem.c.

◆ Internal_CreateFromWorkshopItem()

SCR_WorkshopItem SCR_WorkshopItem::Internal_CreateFromWorkshopItem ( WorkshopItem item )

inlinestaticprotected

Definition at line 2298 of file SCR_WorkshopItem.c.

◆ Internal_GetCanBeUnregistered()

bool SCR_WorkshopItem::Internal_GetCanBeUnregistered ( )

inlineprotected

Returns true when it can be unregistered bu addon manager We don't unregister items if they are offline or have any actions in progress, or if we have reported them (to avoid flushing item cache)

Definition at line 2073 of file SCR_WorkshopItem.c.

◆ Internal_GetDownloadProgress()

float SCR_WorkshopItem::Internal_GetDownloadProgress ( )

inlineprotected

Definition at line 2093 of file SCR_WorkshopItem.c.

◆ Internal_GetIsProcessing()

bool SCR_WorkshopItem::Internal_GetIsProcessing ( )

inlineprotected

Definition at line 2102 of file SCR_WorkshopItem.c.

◆ Internal_GetProcessingProgress()

float SCR_WorkshopItem::Internal_GetProcessingProgress ( )

inlineprotected

Definition at line 2115 of file SCR_WorkshopItem.c.

◆ Internal_GetUpdateAvailable()

bool SCR_WorkshopItem::Internal_GetUpdateAvailable ( )

inlineprotected

Definition at line 2289 of file SCR_WorkshopItem.c.

◆ Internal_GetWorkshopItem()

WorkshopItem SCR_WorkshopItem::Internal_GetWorkshopItem ( )

inlineprotected

Returns true when it can be unregistered bu addon manager.

Definition at line 2085 of file SCR_WorkshopItem.c.

◆ Internal_LoadDetails()

void SCR_WorkshopItem::Internal_LoadDetails ( )

inlineprotected

Creates a callback object, requests workshop API to load details.

Definition at line 2129 of file SCR_WorkshopItem.c.

◆ Internal_OnChanged()

void SCR_WorkshopItem::Internal_OnChanged ( )

inlineprotected

Called by actions when some change happens.

Definition at line 2064 of file SCR_WorkshopItem.c.

◆ Internal_RemoveAuthorBlock()

bool SCR_WorkshopItem::Internal_RemoveAuthorBlock ( BackendCallback callback )

inlineprotected

Definition at line 1803 of file SCR_WorkshopItem.c.

◆ Internal_Report()

bool SCR_WorkshopItem::Internal_Report	(	EWorkshopReportType	eReport,
		string	sMessage,
		BackendCallback	callback )

inlineprotected

Definition at line 1735 of file SCR_WorkshopItem.c.

◆ Internal_StartDownload()

bool SCR_WorkshopItem::Internal_StartDownload	(	notnull Revision	targetRevision,
		BackendCallback	callback )

inlineprotected

Definition at line 1608 of file SCR_WorkshopItem.c.

◆ Internal_Update()

void SCR_WorkshopItem::Internal_Update ( float timeSlice )

inlineprotected

Called each frame by Addon Manager.

Definition at line 1829 of file SCR_WorkshopItem.c.

◆ IsDownloadedVersionCompatible()

bool SCR_WorkshopItem::IsDownloadedVersionCompatible ( )

inlineprotected

Returns true if downloaded revision was uploded after 1.0.

Definition at line 299 of file SCR_WorkshopItem.c.

◆ IsDownloadRunning()

bool SCR_WorkshopItem::IsDownloadRunning ( )

inlineprotected

Definition at line 122 of file SCR_WorkshopItem.c.

◆ IsWorldSave()

bool SCR_WorkshopItem::IsWorldSave ( )

inlineprotected

Definition at line 560 of file SCR_WorkshopItem.c.

◆ LoadDetails()

void SCR_WorkshopItem::LoadDetails ( )

inlineprotected

Loads details from backend, or if they are already loaded, calls the callbacks immediately.

Definition at line 212 of file SCR_WorkshopItem.c.

◆ LoadReport()

void SCR_WorkshopItem::LoadReport ( )

inlineprotected

Loads report of current user from backend. Subscribe to m_OnMyReportLoaded to get result.

Definition at line 1151 of file SCR_WorkshopItem.c.

◆ LogState()

void SCR_WorkshopItem::LogState ( )

inlineprotected

Logs all properties of the object into console.

Definition at line 132 of file SCR_WorkshopItem.c.

◆ OnCancelDownloadError()

void SCR_WorkshopItem::OnCancelDownloadError ( BackendCallback callback )

inlineprotected

Definition at line 1679 of file SCR_WorkshopItem.c.

◆ OnCancelDownloadResponse()

void SCR_WorkshopItem::OnCancelDownloadResponse ( BackendCallback callback )

inlineprotected

Definition at line 1673 of file SCR_WorkshopItem.c.

◆ OnFavouriteFail()

void SCR_WorkshopItem::OnFavouriteFail ( )

inlineprotected

Definition at line 422 of file SCR_WorkshopItem.c.

◆ OnFavouriteSuccess()

void SCR_WorkshopItem::OnFavouriteSuccess ( )

inlineprotected

Definition at line 415 of file SCR_WorkshopItem.c.

◆ OnPatchComputed()

void SCR_WorkshopItem::OnPatchComputed ( )

inlineprotected

Definition at line 774 of file SCR_WorkshopItem.c.

◆ OnPatchComputedFailed()

void SCR_WorkshopItem::OnPatchComputedFailed ( )

inlineprotected

Definition at line 782 of file SCR_WorkshopItem.c.

◆ PauseDownload()

bool SCR_WorkshopItem::PauseDownload ( )

inlineprotected

Pauses current download, if possible.

Definition at line 1080 of file SCR_WorkshopItem.c.

◆ RegisterDependency()

void SCR_WorkshopItem::RegisterDependency ( SCR_WorkshopItem item )

inlineprotected

Definition at line 1560 of file SCR_WorkshopItem.c.

◆ RegisterDependent()

void SCR_WorkshopItem::RegisterDependent ( SCR_WorkshopItem item )

inlineprotected

Definition at line 1576 of file SCR_WorkshopItem.c.

◆ RemoveAuthorBlock()

SCR_WorkshopItemActionRemoveAuthorBlock SCR_WorkshopItem::RemoveAuthorBlock ( )

inlineprotected

Add block for workshop author and all author mods.

Definition at line 1219 of file SCR_WorkshopItem.c.

◆ Report()

SCR_WorkshopItemActionReport SCR_WorkshopItem::Report	(	EWorkshopReportType	eReport,
		string	sMessage )

inlineprotected

Sends a report about this workshop item

! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
! You must call Activate() of the returned action yourself. ! This is done this way so that you can subscribe to events before the action is started. ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !

Definition at line 1131 of file SCR_WorkshopItem.c.

◆ ResetMyRating()

void SCR_WorkshopItem::ResetMyRating ( )

inlineprotected

Definition at line 350 of file SCR_WorkshopItem.c.

◆ ResumeDownload()

bool SCR_WorkshopItem::ResumeDownload ( )

inlineprotected

Resumes current download, if it's already started.

Definition at line 1110 of file SCR_WorkshopItem.c.

◆ RetryDownload()

SCR_WorkshopItemActionDownload SCR_WorkshopItem::RetryDownload ( Revision targetRevision )

inlineprotected

Definition at line 1025 of file SCR_WorkshopItem.c.

◆ SetChanged()

void SCR_WorkshopItem::SetChanged ( )

inlineprotected

Definition at line 2184 of file SCR_WorkshopItem.c.

◆ SetDependenciesEnabled()

void SCR_WorkshopItem::SetDependenciesEnabled ( bool enable )

inlineprotected

Enables/disables all downloaded dependencies.

Definition at line 476 of file SCR_WorkshopItem.c.

◆ SetEnabled()

void SCR_WorkshopItem::SetEnabled ( bool enable )

inlineprotected

Definition at line 456 of file SCR_WorkshopItem.c.

◆ SetFavourite()

void SCR_WorkshopItem::SetFavourite ( bool favourite )

inlineprotected

Definition at line 380 of file SCR_WorkshopItem.c.

◆ SetItemTargetRevision()

void SCR_WorkshopItem::SetItemTargetRevision ( Revision revision )

inlineprotected

Definition at line 2158 of file SCR_WorkshopItem.c.

◆ SetMyRating()

void SCR_WorkshopItem::SetMyRating ( bool newRating )

inlineprotected

Definition at line 327 of file SCR_WorkshopItem.c.

◆ SetSubscribed()

void SCR_WorkshopItem::SetSubscribed ( bool subscribe )

inlineprotected

Definition at line 430 of file SCR_WorkshopItem.c.

◆ SetTargetRevisionPatchSize()

void SCR_WorkshopItem::SetTargetRevisionPatchSize ( float size )

inlineprotected

Definition at line 2170 of file SCR_WorkshopItem.c.

◆ TryLoadDependencies()

void SCR_WorkshopItem::TryLoadDependencies ( bool log = true )

inlineprotected

Definition at line 1494 of file SCR_WorkshopItem.c.

◆ TryLoadItemFromDependency()

void SCR_WorkshopItem::TryLoadItemFromDependency ( )

inlineprotected

Definition at line 1440 of file SCR_WorkshopItem.c.

◆ TryLoadRevisions()

void SCR_WorkshopItem::TryLoadRevisions ( bool log = true )

inlineprotected

Definition at line 1461 of file SCR_WorkshopItem.c.

◆ TryLoadScenarios()

void SCR_WorkshopItem::TryLoadScenarios ( bool log = true )

inlineprotected

Definition at line 1532 of file SCR_WorkshopItem.c.

◆ UnregisterDependency()

void SCR_WorkshopItem::UnregisterDependency ( SCR_WorkshopItem item )

inlineprotected

Definition at line 1569 of file SCR_WorkshopItem.c.

◆ UnregisterDependent()

void SCR_WorkshopItem::UnregisterDependent ( SCR_WorkshopItem item )

inlineprotected

Definition at line 1585 of file SCR_WorkshopItem.c.

◆ UpdateAuthorBlock()

void SCR_WorkshopItem::UpdateAuthorBlock ( )

inlineprotected

Check state of action to add and remove author block in update.

Definition at line 2021 of file SCR_WorkshopItem.c.

◆ UpdateStateFromWorkshopItem()

void SCR_WorkshopItem::UpdateStateFromWorkshopItem ( )

inlineprotected

Definition at line 2314 of file SCR_WorkshopItem.c.

Member Data Documentation

◆ m_ActionAddAuthorBlock

ref SCR_WorkshopItemActionAddAuthorBlock SCR_WorkshopItem::m_ActionAddAuthorBlock

protected

Definition at line 101 of file SCR_WorkshopItem.c.

◆ m_ActionCancelReport

ref SCR_WorkshopItemActionCancelReport SCR_WorkshopItem::m_ActionCancelReport

protected

Definition at line 99 of file SCR_WorkshopItem.c.

◆ m_ActionDependency

ref SCR_WorkshopItemActionComposite SCR_WorkshopItem::m_ActionDependency

protected

Definition at line 100 of file SCR_WorkshopItem.c.

◆ m_ActionDownload

ref SCR_WorkshopItemActionDownload SCR_WorkshopItem::m_ActionDownload

protected

Definition at line 97 of file SCR_WorkshopItem.c.

◆ m_ActionRemoveAuthorBlock

ref SCR_WorkshopItemActionRemoveAuthorBlock SCR_WorkshopItem::m_ActionRemoveAuthorBlock

protected

Definition at line 102 of file SCR_WorkshopItem.c.

◆ m_ActionReport

ref SCR_WorkshopItemActionReport SCR_WorkshopItem::m_ActionReport

protected

Definition at line 98 of file SCR_WorkshopItem.c.

◆ m_aDependencies

ref array<ref SCR_WorkshopItem> SCR_WorkshopItem::m_aDependencies

protected

Definition at line 57 of file SCR_WorkshopItem.c.

◆ m_aDependent

ref array<SCR_WorkshopItem> SCR_WorkshopItem::m_aDependent = new array<SCR_WorkshopItem>

protected

Definition at line 58 of file SCR_WorkshopItem.c.

◆ m_aMissions

ref array<MissionWorkshopItem> SCR_WorkshopItem::m_aMissions

protected

Definition at line 56 of file SCR_WorkshopItem.c.

◆ m_aRevisions

ref array<Revision> SCR_WorkshopItem::m_aRevisions

protected

Definition at line 59 of file SCR_WorkshopItem.c.

◆ m_bChanged

bool SCR_WorkshopItem::m_bChanged

protected

Definition at line 87 of file SCR_WorkshopItem.c.

◆ m_bDetailsLoaded

bool SCR_WorkshopItem::m_bDetailsLoaded

protected

Definition at line 68 of file SCR_WorkshopItem.c.

◆ m_bFavourite

bool SCR_WorkshopItem::m_bFavourite

protected

Definition at line 84 of file SCR_WorkshopItem.c.

◆ m_bFavouriteRequesting

bool SCR_WorkshopItem::m_bFavouriteRequesting

protected

Definition at line 85 of file SCR_WorkshopItem.c.

◆ m_bMyRating

bool SCR_WorkshopItem::m_bMyRating

protected

Definition at line 82 of file SCR_WorkshopItem.c.

◆ m_bMyRatingSet

bool SCR_WorkshopItem::m_bMyRatingSet

protected

Definition at line 83 of file SCR_WorkshopItem.c.

◆ m_bOffline

bool SCR_WorkshopItem::m_bOffline

protected

Definition at line 89 of file SCR_WorkshopItem.c.

◆ m_bRequestFailed

bool SCR_WorkshopItem::m_bRequestFailed

protected

Definition at line 88 of file SCR_WorkshopItem.c.

◆ m_bSizeRequesting

bool SCR_WorkshopItem::m_bSizeRequesting

protected

Definition at line 69 of file SCR_WorkshopItem.c.

◆ m_bSubscribed

bool SCR_WorkshopItem::m_bSubscribed

protected

Definition at line 86 of file SCR_WorkshopItem.c.

◆ m_bWaitingLoadDetails

bool SCR_WorkshopItem::m_bWaitingLoadDetails

protected

Definition at line 93 of file SCR_WorkshopItem.c.

◆ m_CallbackAskDetails

ref SCR_WorkshopItemCallback_AskDetails SCR_WorkshopItem::m_CallbackAskDetails

protected

Definition at line 72 of file SCR_WorkshopItem.c.

◆ m_CallbackLoadDependencies

ref BackendCallback SCR_WorkshopItem::m_CallbackLoadDependencies

protected

Definition at line 74 of file SCR_WorkshopItem.c.

◆ m_CallbackLoadGallery

ref BackendCallback SCR_WorkshopItem::m_CallbackLoadGallery

protected

Definition at line 73 of file SCR_WorkshopItem.c.

◆ m_CallbackLoadMyReport

ref BackendCallback SCR_WorkshopItem::m_CallbackLoadMyReport

protected

Definition at line 76 of file SCR_WorkshopItem.c.

◆ m_CallbackLoadScenarios

ref BackendCallback SCR_WorkshopItem::m_CallbackLoadScenarios

protected

Definition at line 75 of file SCR_WorkshopItem.c.

◆ m_CallbackRequestFavourite

ref BackendCallback SCR_WorkshopItem::m_CallbackRequestFavourite

protected

Definition at line 77 of file SCR_WorkshopItem.c.

◆ m_CancelDownloadCallback

ref BackendCallback SCR_WorkshopItem::m_CancelDownloadCallback = new BackendCallback()

protected

Definition at line 78 of file SCR_WorkshopItem.c.

◆ m_ComputeCallback

ref BackendCallback SCR_WorkshopItem::m_ComputeCallback

protected

Definition at line 79 of file SCR_WorkshopItem.c.

◆ m_Dependency

ref Dependency SCR_WorkshopItem::m_Dependency

protected

Definition at line 49 of file SCR_WorkshopItem.c.

◆ m_fPrevDownloadProgress

float SCR_WorkshopItem::m_fPrevDownloadProgress

protected

Definition at line 94 of file SCR_WorkshopItem.c.

◆ m_fTargetRevisionPatchSize

float SCR_WorkshopItem::m_fTargetRevisionPatchSize

protected

Definition at line 54 of file SCR_WorkshopItem.c.

◆ m_iAccessState

int SCR_WorkshopItem::m_iAccessState

protected

Definition at line 90 of file SCR_WorkshopItem.c.

◆ m_Item

ref WorkshopItem SCR_WorkshopItem::m_Item

protected

Definition at line 48 of file SCR_WorkshopItem.c.

◆ m_ItemTargetRevision

ref Revision SCR_WorkshopItem::m_ItemTargetRevision

protected

Definition at line 53 of file SCR_WorkshopItem.c.

◆ m_LatestRevision

ref Revision SCR_WorkshopItem::m_LatestRevision

protected

Definition at line 50 of file SCR_WorkshopItem.c.

The documentation for this class was generated from the following file:

scripts/Game/Workshop/SCR_WorkshopItem.c

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _print()

◆ _sprint()

◆ AddAuthorBlock()

◆ Callback_AskDetails_OnError()

◆ Callback_AskDetails_OnGetAsset()

◆ Callback_LoadDependencies_OnError()

◆ Callback_LoadDependencies_OnSuccess()

◆ Callback_LoadMyReport_OnError()

◆ Callback_LoadMyReport_OnSuccess()

◆ Callback_LoadScenarios_OnError()

◆ Callback_LoadScenarios_OnSuccess()

◆ CancelDownload()

◆ CancelReport()

◆ CustomDebugError()

◆ DeleteDownloadProgress()

◆ DeleteLocally()

◆ Download()

◆ DownloadDependenciesLatest()

◆ DownloadLatestVersion()

◆ DownloadRevision()

◆ FindRevision()

◆ GetAnyDependencyMissing()

◆ GetAnyDependencyUpdateAvailable()

◆ GetAuthorName()

◆ GetAverageRating()

◆ GetBlocked()

◆ GetCorrupted()

◆ GetCurrentLocalRevision()

◆ GetCurrentLocalVersionMatchDependency()

◆ GetDependenciesLoaded()

◆ GetDependency()

◆ GetDependencyCompositeAction()

◆ GetDependentAddons()

◆ GetDescription()

◆ GetDetailsLoaded()

◆ GetDownloadAction()

◆ GetDownloadState()

◆ GetEnabled()

◆ GetEnabledAndAnyDependencyDisabled()

◆ GetFavourite()

◆ GetGallery()

◆ GetHighestPriorityProblem()

◆ GetId()

◆ GetItemDataLoaded()

◆ GetItemTargetRevision()

◆ GetLatestDependencies()

◆ GetLatestRevision()

◆ GetLatestVersion()

◆ GetLoaded()

◆ GetLoadedDependencies()

◆ GetMissingDependencies()

◆ GetModAuthorReportedByMe()

◆ GetMyRating()

◆ GetName()

◆ GetOffline()

◆ GetOnline()

◆ GetOutdatedDependencies()

◆ GetRatingCount()

◆ GetReport()

◆ GetReportedByMe()

◆ GetRequestFailed()

◆ GetRestricted()

◆ GetRevisionsLoaded()

◆ GetScenarios()

◆ GetScenariosLoaded()

◆ GetSizeBytes()

◆ GetSubscribed()

◆ GetSummary()

◆ GetTargetRevisionPatchSize()

◆ GetThumbnail()

◆ GetTimeSinceFirstDownload()

◆ GetTimeSinceLastPlay()

◆ GetUpdateAvailable()

◆ GetVersions()

◆ GetWorkshopItem()