SCR_WorkshopItemActionDownloadDependenciesLatest Interface Reference

Action for downloading latest dependencies. Doesn't download this addon, but only downloads dependencies. More...

Inheritance diagram for SCR_WorkshopItemActionDownloadDependenciesLatest:

Public Member Functions
void	SCR_WorkshopItemActionDownloadDependenciesLatest (SCR_WorkshopItem wrapper, array< ref SCR_WorkshopItem > dependencies)
	You must provide an array of dependencies to download.
override void	Internal_Update (float timeSlice)
	Called on each frame by the SCR_WorkshopItem which owns it.
Public Member Functions inherited from SCR_WorkshopItemActionComposite
array< ref SCR_WorkshopItemAction >	GetActions ()
	Returns a copy of the internal array of subactions.
Public Member Functions inherited from SCR_WorkshopItemAction
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)

Public Attributes
ref array< ref SCR_WorkshopItem >	m_aProvidedDependencies
Public Attributes inherited from SCR_WorkshopItemActionComposite
ref array< ref SCR_WorkshopItemAction >	m_aActions = new array<ref SCR_WorkshopItemAction>
Public Attributes inherited from SCR_WorkshopItemAction
ref ScriptInvoker	m_OnActivated = new ScriptInvoker
ref ScriptInvoker	m_OnCompleted = new ScriptInvoker
ref ScriptInvoker	m_OnCanceled = new ScriptInvoker
ref ScriptInvoker	m_OnResumed = new ScriptInvoker
ref ScriptInvoker	m_OnPaused = new ScriptInvoker
ref ScriptInvoker	m_OnFailed = new ScriptInvoker
ref ScriptInvoker	m_OnChanged = new ScriptInvoker
SCR_WorkshopItem	m_Wrapper

Protected Member Functions
override bool	OnActivate ()
	These methods must be overridden in derived classes to implement the functionality.
override bool	OnReactivate ()
override bool	OnCancel ()
override bool	OnPause ()
override bool	OnResume ()
Protected Member Functions inherited from SCR_WorkshopItemActionComposite
void	RegisterAction (SCR_WorkshopItemAction action)
void	UnregisterAction (SCR_WorkshopItemAction action)
void	UnregisterActions (array< SCR_WorkshopItemAction > actions)
bool	AllCompleted ()
bool	AnyFailed ()
void	CancelAll ()
void	PauseAll ()
void	ResumeAll ()
void	ActivateAll ()
Protected Member Functions inherited from SCR_WorkshopItemAction
void	Fail (int reason=-1)
	Action must call this when it has failed.
void	Complete ()
	Action must call this when it is completed.
void	InvokeOnChanged ()
	Call this in inherited classes to invoke the OnChanged event handler.
void	OnFail (int reason=-1)
void	OnComplete ()

Additional Inherited Members
Protected Attributes inherited from SCR_WorkshopItemAction
int	m_State
bool	m_bAttached
ref Managed	m_UserData
string	m_sAddonName
string	m_sAddonId
Static Protected Attributes inherited from SCR_WorkshopItemAction
const int	STATE_INACTIVE = 0
const int	STATE_ACTIVE = 1
const int	STATE_COMPLETED = 2
const int	STATE_FAILED = 3
const int	STATE_CANCELED = 4
const int	STATE_PAUSED = 5

Detailed Description

Action for downloading latest dependencies. Doesn't download this addon, but only downloads dependencies.

Constructor & Destructor Documentation

SCR_WorkshopItemActionDownloadDependenciesLatest()

void SCR_WorkshopItemActionDownloadDependenciesLatest.SCR_WorkshopItemActionDownloadDependenciesLatest	(	SCR_WorkshopItem	wrapper,
		array< ref SCR_WorkshopItem >	dependencies )

You must provide an array of dependencies to download.

Member Function Documentation

Internal_Update()

override void SCR_WorkshopItemActionDownloadDependenciesLatest.Internal_Update

(

float

timeSlice

)

Called on each frame by the SCR_WorkshopItem which owns it.

Here we can perform polling to detect state transitions

Implements SCR_WorkshopItemAction.

OnActivate()

override bool SCR_WorkshopItemActionDownloadDependenciesLatest.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_WorkshopItemActionDownloadDependenciesLatest.OnCancel ( )

protected

Implements SCR_WorkshopItemAction.

OnPause()

override bool SCR_WorkshopItemActionDownloadDependenciesLatest.OnPause ( )

protected

Implements SCR_WorkshopItemAction.

OnReactivate()

override bool SCR_WorkshopItemActionDownloadDependenciesLatest.OnReactivate ( )

protected

Implements SCR_WorkshopItemAction.

OnResume()

override bool SCR_WorkshopItemActionDownloadDependenciesLatest.OnResume ( )

protected

Implements SCR_WorkshopItemAction.

Member Data Documentation

m_aProvidedDependencies

ref array<ref SCR_WorkshopItem> SCR_WorkshopItemActionDownloadDependenciesLatest.m_aProvidedDependencies

---

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

• Game/Workshop/WorkshopItemActions.c