Action for reporting an item. More...

Inheritance diagram for SCR_WorkshopItemActionReport:

Public Member Functions
void	SCR_WorkshopItemActionReport (SCR_WorkshopItem wrapper, EWorkshopReportType eReport, string sMessage)

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)

Protected Member Functions
override bool	OnActivateInternal ()

Protected Member Functions inherited from SCR_WorkshopItemActionReportBase
bool	OnActivateInternal ()

override bool	OnActivate ()
	These methods must be overridden in derived classes to implement the functionality.

override bool	OnReactivate ()

void	Callback_OnError ()

void	Callback_OnTimeout ()

void	Callback_OnSuccess ()

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 ()

Protected Attributes
EWorkshopReportType	m_eReportType

string	m_sMessage

Protected Attributes inherited from SCR_WorkshopItemAction
int	m_State

bool	m_bAttached

ref Managed	m_UserData

string	m_sAddonName

string	m_sAddonId

Additional Inherited Members
Public Attributes inherited from SCR_WorkshopItemActionReportBase
ref SCR_WorkshopCallbackBase	m_Callback

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

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 reporting an item.

Constructor & Destructor Documentation

void SCR_WorkshopItemActionReport.SCR_WorkshopItemActionReport	(	SCR_WorkshopItem	wrapper,
		EWorkshopReportType	eReport,
		string	sMessage
	)

override bool SCR_WorkshopItemActionReport.OnActivateInternal ( )

protected

EWorkshopReportType SCR_WorkshopItemActionReport.m_eReportType

protected

string SCR_WorkshopItemActionReport.m_sMessage

protected

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