|
ScriptInvokerBase< ScriptInvoker_ActionDownloadProgress > | GetOnDownloadProgress () |
|
ScriptInvokerBase< ScriptInvoker_ActionDownloadFullStorage > | GetOnFullStorageError () |
|
void | SCR_WorkshopItemActionDownload (SCR_WorkshopItem wrapper, bool latestVersion, Revision revision=null) |
|
Revision | GetTargetRevision () |
| Returns the target version.
|
|
Revision | GetStartRevision () |
| Returns the version which was at the moment when the download was started.
|
|
bool | GetTargetedAtLatestVersion () |
|
bool | GetUpdate () |
| Returns true when this is an update, false when regular download.
|
|
float | GetProgress () |
| Returns current download progress if active or paused, 1 if complete, otherwise 0.
|
|
float | GetProcessingProgress () |
|
float | GetSizeBytes () |
| Returns download size. Might return 0 until the actiion is activated.
|
|
bool | GetRunningAsync () |
|
bool | IsRunningAsyncSolved () |
|
bool | IsPauseAsyncSolved () |
|
override void | Internal_Update (float timeSlice) |
| Called on each frame by the SCR_WorkshopItem which owns it.
|
|
void | FullStorageFail () |
|
SCR_WorkshopItemActionDownload | RetryDownload () |
| Try redownload failed addon.
|
|
void | ForceFail () |
|
float | GetDownloadSize () |
|
bool | IsProcessing () |
|
void | SCR_WorkshopItemAction (SCR_WorkshopItem wrapper) |
|
void | ~SCR_WorkshopItemAction () |
|
bool | IsInactive () |
|
bool | IsActive () |
|
bool | IsCompleted () |
|
bool | IsCanceled () |
|
bool | IsPaused () |
|
bool | IsFailed () |
|
bool | IsAttached () |
| When action is attached, it means that it wasn't completed or wasn't replaced by another action.
|
|
SCR_WorkshopItem | GetWorkshopItem () |
|
void | SetUserData (Managed data) |
|
Managed | GetUserData (Managed data) |
|
string | GetAddonName () |
| Returns the cached addon name, even if WorkshopItem object is already deleted.
|
|
string | GetAddonId () |
| Returns the cached addon ID, even if WorkshopItem object is already deleted.
|
|
bool | Activate () |
| Public methods to interact with the action They return true if the operation was successful.
|
|
bool | Cancel () |
| Cancels an action. Valid in active, inactive, paused states.
|
|
bool | Pause () |
| Pauses an active action.
|
|
bool | Resume () |
| Resumes a paused action.
|
|
bool | Reactivate () |
| Starts action again Only valid in failed state.
|
|
void | Internal_Detach () |
|
void | _print (string str, LogLevel logLevel=LogLevel.DEBUG) |
|
◆ SCR_WorkshopItemActionDownload()
void SCR_WorkshopItemActionDownload.SCR_WorkshopItemActionDownload |
( |
SCR_WorkshopItem | wrapper, |
|
|
bool | latestVersion, |
|
|
Revision | revision = null ) |
◆ Callback_OnError()
void SCR_WorkshopItemActionDownload.Callback_OnError |
( |
SCR_BackendCallback | callback, |
|
|
int | code, |
|
|
int | restCode, |
|
|
int | apiCode ) |
|
protected |
◆ Callback_OnTimeout()
◆ ForceFail()
void SCR_WorkshopItemActionDownload.ForceFail |
( |
| ) |
|
◆ FullStorageFail()
void SCR_WorkshopItemActionDownload.FullStorageFail |
( |
| ) |
|
◆ GetDownloadSize()
float SCR_WorkshopItemActionDownload.GetDownloadSize |
( |
| ) |
|
◆ GetOnDownloadProgress()
ScriptInvokerBase< ScriptInvoker_ActionDownloadProgress > SCR_WorkshopItemActionDownload.GetOnDownloadProgress |
( |
| ) |
|
◆ GetOnFullStorageError()
ScriptInvokerBase< ScriptInvoker_ActionDownloadFullStorage > SCR_WorkshopItemActionDownload.GetOnFullStorageError |
( |
| ) |
|
◆ GetProcessingProgress()
float SCR_WorkshopItemActionDownload.GetProcessingProgress |
( |
| ) |
|
◆ GetProgress()
float SCR_WorkshopItemActionDownload.GetProgress |
( |
| ) |
|
Returns current download progress if active or paused, 1 if complete, otherwise 0.
◆ GetRunningAsync()
bool SCR_WorkshopItemActionDownload.GetRunningAsync |
( |
| ) |
|
◆ GetSizeBytes()
float SCR_WorkshopItemActionDownload.GetSizeBytes |
( |
| ) |
|
Returns download size. Might return 0 until the actiion is activated.
◆ GetStartRevision()
Revision SCR_WorkshopItemActionDownload.GetStartRevision |
( |
| ) |
|
Returns the version which was at the moment when the download was started.
◆ GetTargetedAtLatestVersion()
bool SCR_WorkshopItemActionDownload.GetTargetedAtLatestVersion |
( |
| ) |
|
◆ GetTargetRevision()
Revision SCR_WorkshopItemActionDownload.GetTargetRevision |
( |
| ) |
|
Returns the target version.
!! If you were targeting latest version, but the actual download has not started because it is waiting for more data from backend, then this will return an empty string until the data is fetched from backend.
◆ GetUpdate()
bool SCR_WorkshopItemActionDownload.GetUpdate |
( |
| ) |
|
Returns true when this is an update, false when regular download.
◆ Internal_Update()
override void SCR_WorkshopItemActionDownload.Internal_Update |
( |
float | timeSlice | ) |
|
◆ IsPauseAsyncSolved()
bool SCR_WorkshopItemActionDownload.IsPauseAsyncSolved |
( |
| ) |
|
◆ IsProcessing()
bool SCR_WorkshopItemActionDownload.IsProcessing |
( |
| ) |
|
◆ IsRunningAsyncSolved()
bool SCR_WorkshopItemActionDownload.IsRunningAsyncSolved |
( |
| ) |
|
◆ OnActivate()
override bool SCR_WorkshopItemActionDownload.OnActivate |
( |
| ) |
|
|
protected |
These methods must be overridden in derived classes to implement the functionality.
If the specific action can't be paused, canceled, or resumed, the methods must return false.
Implements SCR_WorkshopItemAction.
◆ OnCancel()
override bool SCR_WorkshopItemActionDownload.OnCancel |
( |
| ) |
|
|
protected |
◆ OnComplete()
override void SCR_WorkshopItemActionDownload.OnComplete |
( |
| ) |
|
|
protected |
◆ OnPause()
override bool SCR_WorkshopItemActionDownload.OnPause |
( |
| ) |
|
|
protected |
◆ OnPauseResponse()
◆ OnReactivate()
override bool SCR_WorkshopItemActionDownload.OnReactivate |
( |
| ) |
|
|
protected |
◆ OnResume()
override bool SCR_WorkshopItemActionDownload.OnResume |
( |
| ) |
|
|
protected |
◆ OnResumeResponse()
◆ RetryDownload()
Try redownload failed addon.
◆ StartDownloadOrLoadDetails()
bool SCR_WorkshopItemActionDownload.StartDownloadOrLoadDetails |
( |
| ) |
|
|
protected |
We can't start download before details are loaded, because details have the revisions.
Starts download immediately or loads details of workshop item.
◆ m_bAddonEnabledAtStart
bool SCR_WorkshopItemActionDownload.m_bAddonEnabledAtStart |
|
protected |
◆ m_bDownloadStarted
bool SCR_WorkshopItemActionDownload.m_bDownloadStarted |
|
protected |
◆ m_bRunningAsync
bool SCR_WorkshopItemActionDownload.m_bRunningAsync |
|
protected |
◆ m_bRunningImmediate
bool SCR_WorkshopItemActionDownload.m_bRunningImmediate |
|
protected |
◆ m_bTargetVersionLatest
bool SCR_WorkshopItemActionDownload.m_bTargetVersionLatest |
|
protected |
◆ m_bWaitingForRevisions
bool SCR_WorkshopItemActionDownload.m_bWaitingForRevisions |
|
protected |
◆ m_Callback
◆ m_fDownloadedSize
float SCR_WorkshopItemActionDownload.m_fDownloadedSize |
|
protected |
◆ m_fProcessingProgress
float SCR_WorkshopItemActionDownload.m_fProcessingProgress |
|
protected |
◆ m_fProgress
float SCR_WorkshopItemActionDownload.m_fProgress |
|
protected |
◆ m_fSizeBytes
float SCR_WorkshopItemActionDownload.m_fSizeBytes |
|
protected |
◆ m_OnDownloadProgress
ref ScriptInvokerBase<ScriptInvoker_ActionDownloadProgress> SCR_WorkshopItemActionDownload.m_OnDownloadProgress |
|
protected |
◆ m_OnFullStorageError
ref ScriptInvokerBase<ScriptInvoker_ActionDownloadFullStorage> SCR_WorkshopItemActionDownload.m_OnFullStorageError |
|
protected |
◆ m_PauseDownloadCallback
◆ m_StartVersion
ref Revision SCR_WorkshopItemActionDownload.m_StartVersion |
|
protected |
◆ m_TargetRevision
ref Revision SCR_WorkshopItemActionDownload.m_TargetRevision |
|
protected |
The documentation for this interface was generated from the following file:
- Game/Workshop/Actions/SCR_WorkshopItemActionDownload.c