SCR_WorkshopItemActionComposite Interface Reference

Composite action which includes multiple subactions. More...

Inheritance diagram for SCR_WorkshopItemActionComposite:

Public Member Functions
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_Update (float timeSlice)
	Called on each frame by the SCR_WorkshopItem which owns it.
void	Internal_Detach ()
void	_print (string str, LogLevel logLevel=LogLevel.DEBUG)

Public Attributes
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
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.
bool	OnActivate ()
	These methods must be overridden in derived classes to implement the functionality.
bool	OnCancel ()
bool	OnPause ()
bool	OnResume ()
bool	OnReactivate ()
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

Composite action which includes multiple subactions.

Member Function Documentation

ActivateAll()

void SCR_WorkshopItemActionComposite.ActivateAll ( )

protected

AllCompleted()

bool SCR_WorkshopItemActionComposite.AllCompleted ( )

protected

AnyFailed()

bool SCR_WorkshopItemActionComposite.AnyFailed ( )

protected

CancelAll()

void SCR_WorkshopItemActionComposite.CancelAll ( )

protected

GetActions()

array< ref SCR_WorkshopItemAction > SCR_WorkshopItemActionComposite.GetActions

(

)

Returns a copy of the internal array of subactions.

PauseAll()

void SCR_WorkshopItemActionComposite.PauseAll ( )

protected

RegisterAction()

void SCR_WorkshopItemActionComposite.RegisterAction ( SCR_WorkshopItemAction  action )

protected

ResumeAll()

void SCR_WorkshopItemActionComposite.ResumeAll ( )

protected

UnregisterAction()

void SCR_WorkshopItemActionComposite.UnregisterAction ( SCR_WorkshopItemAction  action )

protected

UnregisterActions()

void SCR_WorkshopItemActionComposite.UnregisterActions ( array< SCR_WorkshopItemAction >  actions )

protected

Member Data Documentation

m_aActions

ref array<ref SCR_WorkshopItemAction> SCR_WorkshopItemActionComposite.m_aActions = new array<ref SCR_WorkshopItemAction>

---

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

• Game/Workshop/SCR_WorkshopItemAction.c