Inheritance diagram for SCR_WorkshopItemAction:

Protected Member Functions
void	SCR_WorkshopItemAction (SCR_WorkshopItem wrapper)
void	~SCR_WorkshopItemAction ()
bool	IsInactive ()
bool	IsActive ()
bool	IsCompleted ()
bool	IsCanceled ()
bool	IsPaused ()
bool	IsFailed ()
bool	IsAttached ()
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 ()
	Activates an inactive action, or resumes a paused action.
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	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 ()
bool	OnCancel ()
bool	OnPause ()
bool	OnResume ()
bool	OnReactivate ()
void	OnFail (int reason=-1)
void	OnComplete ()
void	Internal_Update (float timeSlice)
void	Internal_Detach ()
void	_print (string str, LogLevel logLevel=LogLevel.DEBUG)

Protected Attributes
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
int	m_State
SCR_WorkshopItem	m_Wrapper
bool	m_bAttached
ref Managed	m_UserData
string	m_sAddonName
string	m_sAddonId

Detailed Description

Definition at line 16 of file SCR_WorkshopItemAction.c.

Constructor & Destructor Documentation

◆ SCR_WorkshopItemAction()

void SCR_WorkshopItemAction::SCR_WorkshopItemAction ( SCR_WorkshopItem wrapper )

inlineprotected

Definition at line 53 of file SCR_WorkshopItemAction.c.

◆ ~SCR_WorkshopItemAction()

void SCR_WorkshopItemAction::~SCR_WorkshopItemAction ( )

inlineprotected

Definition at line 69 of file SCR_WorkshopItemAction.c.

Member Function Documentation

◆ _print()

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

inlineprotected

Definition at line 410 of file SCR_WorkshopItemAction.c.

◆ Activate()

bool SCR_WorkshopItemAction::Activate ( )

inlineprotected

Activates an inactive action, or resumes a paused action.

Public methods to interact with the action They return true if the operation was successful. If operation was not successful, false is returned, and action is in Failed state.

Definition at line 130 of file SCR_WorkshopItemAction.c.

◆ Cancel()

bool SCR_WorkshopItemAction::Cancel ( )

inlineprotected

Cancels an action. Valid in active, inactive, paused states.

Definition at line 173 of file SCR_WorkshopItemAction.c.

◆ Complete()

void SCR_WorkshopItemAction::Complete ( )

inlineprotected

Action must call this when it is completed.

Definition at line 356 of file SCR_WorkshopItemAction.c.

◆ Fail()

void SCR_WorkshopItemAction::Fail ( int reason = -1 )

inlineprotected

Action must call this when it has failed.

Definition at line 335 of file SCR_WorkshopItemAction.c.

◆ GetAddonId()

string SCR_WorkshopItemAction::GetAddonId ( )

inlineprotected

Returns the cached addon ID, even if WorkshopItem object is already deleted.

Definition at line 114 of file SCR_WorkshopItemAction.c.

◆ GetAddonName()

string SCR_WorkshopItemAction::GetAddonName ( )

inlineprotected

Returns the cached addon name, even if WorkshopItem object is already deleted.

Definition at line 104 of file SCR_WorkshopItemAction.c.

◆ GetUserData()

Managed SCR_WorkshopItemAction::GetUserData ( Managed data )

inlineprotected

Definition at line 100 of file SCR_WorkshopItemAction.c.

◆ GetWorkshopItem()

SCR_WorkshopItem SCR_WorkshopItemAction::GetWorkshopItem ( )

inlineprotected

Definition at line 94 of file SCR_WorkshopItemAction.c.

◆ Internal_Detach()

void SCR_WorkshopItemAction::Internal_Detach ( )

inlineprotected

Definition at line 404 of file SCR_WorkshopItemAction.c.

◆ Internal_Update()

void SCR_WorkshopItemAction::Internal_Update ( float timeSlice )

protected

Called on each frame by the SCR_WorkshopItem which owns it. Here we can perform polling to detect state transitions

◆ InvokeOnChanged()

void SCR_WorkshopItemAction::InvokeOnChanged ( )

inlineprotected

Call this in inherited classes to invoke the OnChanged event handler.

Definition at line 377 of file SCR_WorkshopItemAction.c.

◆ IsActive()

bool SCR_WorkshopItemAction::IsActive ( )

inlineprotected

Definition at line 81 of file SCR_WorkshopItemAction.c.

◆ IsAttached()

bool SCR_WorkshopItemAction::IsAttached ( )

inlineprotected

When action is attached, it means that it wasn't completed or wasn't replaced by another action. It is detached when another action takes its place, when it is completed or canceled. If an action is detached, you can only read its state, but you can't do any operations like activate, restart, pause, etc.

Definition at line 91 of file SCR_WorkshopItemAction.c.

◆ IsCanceled()

bool SCR_WorkshopItemAction::IsCanceled ( )

inlineprotected

Definition at line 83 of file SCR_WorkshopItemAction.c.

◆ IsCompleted()

bool SCR_WorkshopItemAction::IsCompleted ( )

inlineprotected

Definition at line 82 of file SCR_WorkshopItemAction.c.

◆ IsFailed()

bool SCR_WorkshopItemAction::IsFailed ( )

inlineprotected

Definition at line 85 of file SCR_WorkshopItemAction.c.

◆ IsInactive()

bool SCR_WorkshopItemAction::IsInactive ( )

inlineprotected

Definition at line 80 of file SCR_WorkshopItemAction.c.

◆ IsPaused()

bool SCR_WorkshopItemAction::IsPaused ( )

inlineprotected

Definition at line 84 of file SCR_WorkshopItemAction.c.

◆ OnActivate()

bool SCR_WorkshopItemAction::OnActivate ( )

inlineprotected

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.

Definition at line 388 of file SCR_WorkshopItemAction.c.

◆ OnCancel()

bool SCR_WorkshopItemAction::OnCancel ( )

inlineprotected

Definition at line 389 of file SCR_WorkshopItemAction.c.

◆ OnComplete()

void SCR_WorkshopItemAction::OnComplete ( )

protected

◆ OnFail()

void SCR_WorkshopItemAction::OnFail ( int reason = -1 )

protected

◆ OnPause()

bool SCR_WorkshopItemAction::OnPause ( )

inlineprotected

Definition at line 390 of file SCR_WorkshopItemAction.c.

◆ OnReactivate()

bool SCR_WorkshopItemAction::OnReactivate ( )

inlineprotected

Definition at line 392 of file SCR_WorkshopItemAction.c.

◆ OnResume()

bool SCR_WorkshopItemAction::OnResume ( )

inlineprotected

Definition at line 391 of file SCR_WorkshopItemAction.c.

◆ Pause()

bool SCR_WorkshopItemAction::Pause ( )

inlineprotected

Pauses an active action.

Definition at line 213 of file SCR_WorkshopItemAction.c.

◆ Reactivate()

bool SCR_WorkshopItemAction::Reactivate ( )

inlineprotected

Starts action again Only valid in failed state.

Definition at line 296 of file SCR_WorkshopItemAction.c.

◆ Resume()

bool SCR_WorkshopItemAction::Resume ( )

inlineprotected

Resumes a paused action.

Definition at line 253 of file SCR_WorkshopItemAction.c.

◆ SetUserData()

void SCR_WorkshopItemAction::SetUserData ( Managed data )

inlineprotected

Definition at line 97 of file SCR_WorkshopItemAction.c.

Member Data Documentation

◆ m_bAttached

bool SCR_WorkshopItemAction::m_bAttached

protected

Definition at line 44 of file SCR_WorkshopItemAction.c.

◆ m_sAddonId

string SCR_WorkshopItemAction::m_sAddonId

protected

Definition at line 49 of file SCR_WorkshopItemAction.c.

◆ m_sAddonName

string SCR_WorkshopItemAction::m_sAddonName

protected

Definition at line 48 of file SCR_WorkshopItemAction.c.

◆ m_State

int SCR_WorkshopItemAction::m_State

protected

Definition at line 38 of file SCR_WorkshopItemAction.c.

◆ m_UserData

ref Managed SCR_WorkshopItemAction::m_UserData

protected

Definition at line 45 of file SCR_WorkshopItemAction.c.

◆ m_Wrapper

SCR_WorkshopItem SCR_WorkshopItemAction::m_Wrapper

protected

Definition at line 40 of file SCR_WorkshopItemAction.c.

◆ STATE_ACTIVE

const int SCR_WorkshopItemAction::STATE_ACTIVE = 1

protected

Definition at line 31 of file SCR_WorkshopItemAction.c.

◆ STATE_CANCELED

const int SCR_WorkshopItemAction::STATE_CANCELED = 4

protected

Definition at line 34 of file SCR_WorkshopItemAction.c.

◆ STATE_COMPLETED

const int SCR_WorkshopItemAction::STATE_COMPLETED = 2

protected

Definition at line 32 of file SCR_WorkshopItemAction.c.

◆ STATE_FAILED

const int SCR_WorkshopItemAction::STATE_FAILED = 3

protected

Definition at line 33 of file SCR_WorkshopItemAction.c.

◆ STATE_INACTIVE

const int SCR_WorkshopItemAction::STATE_INACTIVE = 0

protected

Definition at line 30 of file SCR_WorkshopItemAction.c.

◆ STATE_PAUSED

const int SCR_WorkshopItemAction::STATE_PAUSED = 5

protected

Definition at line 35 of file SCR_WorkshopItemAction.c.

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

scripts/Game/Workshop/SCR_WorkshopItemAction.c

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_WorkshopItemAction()

◆ ~SCR_WorkshopItemAction()

Member Function Documentation

◆ _print()

◆ Activate()

◆ Cancel()

◆ Complete()

◆ Fail()

◆ GetAddonId()

◆ GetAddonName()

◆ GetUserData()

◆ GetWorkshopItem()

◆ Internal_Detach()

◆ Internal_Update()

◆ InvokeOnChanged()

◆ IsActive()

◆ IsAttached()

◆ IsCanceled()

◆ IsCompleted()

◆ IsFailed()

◆ IsInactive()

◆ IsPaused()

◆ OnActivate()

◆ OnCancel()

◆ OnComplete()

◆ OnFail()

◆ OnPause()

◆ OnReactivate()

◆ OnResume()

◆ Pause()

◆ Reactivate()

◆ Resume()

◆ SetUserData()

Member Data Documentation

◆ m_bAttached

◆ m_sAddonId

◆ m_sAddonName

◆ m_State

◆ m_UserData

◆ m_Wrapper

◆ STATE_ACTIVE

◆ STATE_CANCELED

◆ STATE_COMPLETED

◆ STATE_FAILED

◆ STATE_INACTIVE

◆ STATE_PAUSED