BaseUserAction Class Reference

Inheritance diagram for BaseUserAction:

Protected Member Functions
void	SetCannotPerformReason (string reason)
string	GetCannotPerformReason ()
proto external int	GetContextIndex (string sContextName)
	Returns the index of the context this action is registered in as or -1 if none.
proto external void	SetActiveContext (UserActionContext context)
	Setter for m_pActiveContext.
proto external UserActionContext	GetActiveContext ()
	Getter for m_pActiveContext.
proto external bool	CanBePerformed (IEntity user)
	Can this action be performed by the user?
proto external bool	CanBeShown (IEntity user)
	Can this action be shown in the UI for the user?
proto external bool	HasLocalEffectOnly ()
	Does this action only have client side effect?
proto external bool	CanBroadcast ()
	If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.
proto external bool	CheckOnServerFirst ()
proto external bool	ShouldPerformPerFrame ()
	Should this action be performed every frame the input action is triggered?
proto external string	GetActionName ()
proto external string	GetActionDescription ()
proto external float	GetVisibilityRange ()
	Returns the visibility range of this action in metres.
proto external float	GetActionDuration ()
	Returns the duration of this action in seconds.
proto external float	GetActionProgress (float fProgress, float timeSlice)
	Returns the progress of this action in seconds.
proto external bool	IsInProgress ()
	Returns true while continuous or timed action is being used.
proto external UIInfo	GetUIInfo ()
	Returns the UIInfo set for this user action or null if none.
proto external IEntity	GetOwner ()
	Returns the parent entity of this action.
proto external bool	CanAggregate ()
	Whether action can be aggregated by name, this is a temp workaround for localization.
proto external int	GetActionID ()
	Returns the ID with which this action is registered in its parent ActionsManagerComponent.
proto external void	SetSendActionDataFlag ()
	Used to ask to send action data again during continuous action.
proto external ActionsManagerComponent	GetActionsManager ()
proto external void	SetActionEnabled_S (bool enable)
	Action can be enabled/disabled by the server. Disabled actions return false for CanBeShown(). Has no effect when called from the client.
proto external bool	WasDisabledByServer ()
	Was the action disabled by the server?
bool	OnRplSave (ScriptBitWriter writer)
bool	OnRplLoad (ScriptBitReader reader)
bool	OnSaveActionData (ScriptBitWriter writer)
bool	OnLoadActionData (ScriptBitReader reader)
event void	OnActionSelected ()
event void	OnActionDeselected ()
void	SetCannotPerformReason (string reason)
string	GetCannotPerformReason ()
proto external int	GetContextIndex (string sContextName)
	Returns the index of the context this action is registered in as or -1 if none.
proto external void	SetActiveContext (UserActionContext context)
	Setter for m_pActiveContext.
proto external UserActionContext	GetActiveContext ()
	Getter for m_pActiveContext.
proto external bool	CanBePerformed (IEntity user)
	Can this action be performed by the user?
proto external bool	CanBeShown (IEntity user)
	Can this action be shown in the UI for the user?
proto external bool	HasLocalEffectOnly ()
	Does this action only have client side effect?
proto external bool	CanBroadcast ()
	If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.
proto external bool	CheckOnServerFirst ()
proto external bool	ShouldPerformPerFrame ()
	Should this action be performed every frame the input action is triggered?
proto external string	GetActionName ()
proto external string	GetActionDescription ()
proto external float	GetVisibilityRange ()
	Returns the visibility range of this action in metres.
proto external float	GetActionDuration ()
	Returns the duration of this action in seconds.
proto external float	GetActionProgress (float fProgress, float timeSlice)
	Returns the progress of this action in seconds.
proto external bool	IsInProgress ()
	Returns true while continuous or timed action is being used.
proto external UIInfo	GetUIInfo ()
	Returns the UIInfo set for this user action or null if none.
proto external IEntity	GetOwner ()
	Returns the parent entity of this action.
proto external bool	CanAggregate ()
	Whether action can be aggregated by name, this is a temp workaround for localization.
proto external int	GetActionID ()
	Returns the ID with which this action is registered in its parent ActionsManagerComponent.
proto external void	SetSendActionDataFlag ()
	Used to ask to send action data again during continuous action.
proto external ActionsManagerComponent	GetActionsManager ()
proto external void	SetActionEnabled_S (bool enable)
	Action can be enabled/disabled by the server. Disabled actions return false for CanBeShown(). Has no effect when called from the client.
proto external bool	WasDisabledByServer ()
	Was the action disabled by the server?
bool	OnRplSave (ScriptBitWriter writer)
bool	OnRplLoad (ScriptBitReader reader)
bool	OnSaveActionData (ScriptBitWriter writer)
bool	OnLoadActionData (ScriptBitReader reader)
event void	OnActionSelected ()
event void	OnActionDeselected ()

Protected Attributes
string	m_sCannotPerformReason
string	ActionNameParams [9]
	Can be filled in scripts to be used as params when name is being formatted when displayed in UI.

Detailed Description

Definition at line 12 of file BaseUserAction.c.

Member Function Documentation

CanAggregate() [1/2]

proto external bool BaseUserAction::CanAggregate ( )

protected

Whether action can be aggregated by name, this is a temp workaround for localization.

CanAggregate() [2/2]

proto external bool BaseUserAction::CanAggregate ( )

protected

Whether action can be aggregated by name, this is a temp workaround for localization.

CanBePerformed() [1/2]

proto external bool BaseUserAction::CanBePerformed ( IEntity user )

protected

Can this action be performed by the user?

CanBePerformed() [2/2]

proto external bool BaseUserAction::CanBePerformed ( IEntity user )

protected

Can this action be performed by the user?

CanBeShown() [1/2]

proto external bool BaseUserAction::CanBeShown ( IEntity user )

protected

Can this action be shown in the UI for the user?

CanBeShown() [2/2]

proto external bool BaseUserAction::CanBeShown ( IEntity user )

protected

Can this action be shown in the UI for the user?

CanBroadcast() [1/2]

proto external bool BaseUserAction::CanBroadcast ( )

protected

If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.

CanBroadcast() [2/2]

proto external bool BaseUserAction::CanBroadcast ( )

protected

If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.

CheckOnServerFirst() [1/2]

proto external bool BaseUserAction::CheckOnServerFirst ( )

protected

If CheckOnServerFirst returns true, the action is first sent to be verified on the server. Only if the function succeeds on the server it will can be executed on other machines. This does not mean that actions are not verified on the server otherwise. However, the path the action takes is different. When this function returns true it means OnSaveActionData is evaluated on the server, not where the action is called from. This comes handly in situations when the use action wants to use data that is only available on the server.

CheckOnServerFirst() [2/2]

proto external bool BaseUserAction::CheckOnServerFirst ( )

protected

If CheckOnServerFirst returns true, the action is first sent to be verified on the server. Only if the function succeeds on the server it will can be executed on other machines. This does not mean that actions are not verified on the server otherwise. However, the path the action takes is different. When this function returns true it means OnSaveActionData is evaluated on the server, not where the action is called from. This comes handly in situations when the use action wants to use data that is only available on the server.

GetActionDescription() [1/2]

proto external string BaseUserAction::GetActionDescription ( )

protected

Return the description of this action. By default returns the value in UIInfo or empty string if UIInfo doesn't exist.

GetActionDescription() [2/2]

proto external string BaseUserAction::GetActionDescription ( )

protected

Return the description of this action. By default returns the value in UIInfo or empty string if UIInfo doesn't exist.

GetActionDuration() [1/2]

proto external float BaseUserAction::GetActionDuration ( )

protected

Returns the duration of this action in seconds.

GetActionDuration() [2/2]

proto external float BaseUserAction::GetActionDuration ( )

protected

Returns the duration of this action in seconds.

GetActionID() [1/2]

proto external int BaseUserAction::GetActionID ( )

protected

Returns the ID with which this action is registered in its parent ActionsManagerComponent.

GetActionID() [2/2]

proto external int BaseUserAction::GetActionID ( )

protected

Returns the ID with which this action is registered in its parent ActionsManagerComponent.

GetActionName() [1/2]

proto external string BaseUserAction::GetActionName ( )

protected

Return the name of this action. By default returns the value in UIInfo or empty string if UIInfo doesn't exist.

GetActionName() [2/2]

proto external string BaseUserAction::GetActionName ( )

protected

Return the name of this action. By default returns the value in UIInfo or empty string if UIInfo doesn't exist.

GetActionProgress() [1/2]

proto external float BaseUserAction::GetActionProgress ( float fProgress, float timeSlice )

protected

Returns the progress of this action in seconds.

GetActionProgress() [2/2]

proto external float BaseUserAction::GetActionProgress ( float fProgress, float timeSlice )

protected

Returns the progress of this action in seconds.

GetActionsManager() [1/2]

proto external ActionsManagerComponent BaseUserAction::GetActionsManager ( )

protected

GetActionsManager() [2/2]

proto external ActionsManagerComponent BaseUserAction::GetActionsManager ( )

protected

GetActiveContext() [1/2]

proto external UserActionContext BaseUserAction::GetActiveContext ( )

protected

Getter for m_pActiveContext.

GetActiveContext() [2/2]

proto external UserActionContext BaseUserAction::GetActiveContext ( )

protected

Getter for m_pActiveContext.

GetCannotPerformReason() [1/2]

string BaseUserAction::GetCannotPerformReason ( )

inlineprotected

Returns the reason why action couldn't be performed. It is valid only within and after CanBePerformed is called

Definition at line 28 of file BaseUserAction.c.

GetCannotPerformReason() [2/2]

string BaseUserAction::GetCannotPerformReason ( )

inlineprotected

Returns the reason why action couldn't be performed. It is valid only within and after CanBePerformed is called

Definition at line 28 of file BaseUserAction.c.

GetContextIndex() [1/2]

proto external int BaseUserAction::GetContextIndex ( string sContextName )

protected

Returns the index of the context this action is registered in as or -1 if none.

GetContextIndex() [2/2]

proto external int BaseUserAction::GetContextIndex ( string sContextName )

protected

Returns the index of the context this action is registered in as or -1 if none.

GetOwner() [1/2]

proto external IEntity BaseUserAction::GetOwner ( )

protected

Returns the parent entity of this action.

GetOwner() [2/2]

proto external IEntity BaseUserAction::GetOwner ( )

protected

Returns the parent entity of this action.

GetUIInfo() [1/2]

proto external UIInfo BaseUserAction::GetUIInfo ( )

protected

Returns the UIInfo set for this user action or null if none.

GetUIInfo() [2/2]

proto external UIInfo BaseUserAction::GetUIInfo ( )

protected

Returns the UIInfo set for this user action or null if none.

GetVisibilityRange() [1/2]

proto external float BaseUserAction::GetVisibilityRange ( )

protected

Returns the visibility range of this action in metres.

GetVisibilityRange() [2/2]

proto external float BaseUserAction::GetVisibilityRange ( )

protected

Returns the visibility range of this action in metres.

HasLocalEffectOnly() [1/2]

proto external bool BaseUserAction::HasLocalEffectOnly ( )

protected

Does this action only have client side effect?

HasLocalEffectOnly() [2/2]

proto external bool BaseUserAction::HasLocalEffectOnly ( )

protected

Does this action only have client side effect?

IsInProgress() [1/2]

proto external bool BaseUserAction::IsInProgress ( )

protected

Returns true while continuous or timed action is being used.

IsInProgress() [2/2]

proto external bool BaseUserAction::IsInProgress ( )

protected

Returns true while continuous or timed action is being used.

OnActionDeselected() [1/2]

event void BaseUserAction::OnActionDeselected ( )

protected

Callback for when action is deselected by the local player and the local player ONLY.

OnActionDeselected() [2/2]

event void BaseUserAction::OnActionDeselected ( )

protected

Callback for when action is deselected by the local player and the local player ONLY.

OnActionSelected() [1/2]

event void BaseUserAction::OnActionSelected ( )

protected

Callback for when action is selected by the local player and the local player ONLY.

OnActionSelected() [2/2]

event void BaseUserAction::OnActionSelected ( )

protected

Callback for when action is selected by the local player and the local player ONLY.

OnLoadActionData() [1/2]

bool BaseUserAction::OnLoadActionData ( ScriptBitReader reader )

inlineprotected

If the one performing the action packed some data in it everybody receiving the action. Only available for actions for which HasLocalEffectOnly returns false. Only triggered if the sender wrote anyting to the buffer.

Definition at line 100 of file BaseUserAction.c.

OnLoadActionData() [2/2]

bool BaseUserAction::OnLoadActionData ( ScriptBitReader reader )

inlineprotected

If the one performing the action packed some data in it everybody receiving the action. Only available for actions for which HasLocalEffectOnly returns false. Only triggered if the sender wrote anyting to the buffer.

Definition at line 100 of file BaseUserAction.c.

OnRplLoad() [1/2]

bool BaseUserAction::OnRplLoad ( ScriptBitReader reader )

inlineprotected

Definition at line 92 of file BaseUserAction.c.

OnRplLoad() [2/2]

bool BaseUserAction::OnRplLoad ( ScriptBitReader reader )

inlineprotected

Definition at line 92 of file BaseUserAction.c.

OnRplSave() [1/2]

bool BaseUserAction::OnRplSave ( ScriptBitWriter writer )

inlineprotected

Definition at line 91 of file BaseUserAction.c.

OnRplSave() [2/2]

bool BaseUserAction::OnRplSave ( ScriptBitWriter writer )

inlineprotected

Definition at line 91 of file BaseUserAction.c.

OnSaveActionData() [1/2]

bool BaseUserAction::OnSaveActionData ( ScriptBitWriter writer )

inlineprotected

Before performing the action the caller can store some data in it which is delivered to others. Only available for actions for which HasLocalEffectOnly returns false. Evaluate where the action is called. However, if CheckOnServerFirst is true, it is always run from the server.

Definition at line 96 of file BaseUserAction.c.

OnSaveActionData() [2/2]

bool BaseUserAction::OnSaveActionData ( ScriptBitWriter writer )

inlineprotected

Before performing the action the caller can store some data in it which is delivered to others. Only available for actions for which HasLocalEffectOnly returns false. Evaluate where the action is called. However, if CheckOnServerFirst is true, it is always run from the server.

Definition at line 96 of file BaseUserAction.c.

SetActionEnabled_S() [1/2]

proto external void BaseUserAction::SetActionEnabled_S ( bool enable )

protected

Action can be enabled/disabled by the server. Disabled actions return false for CanBeShown(). Has no effect when called from the client.

SetActionEnabled_S() [2/2]

proto external void BaseUserAction::SetActionEnabled_S ( bool enable )

protected

Action can be enabled/disabled by the server. Disabled actions return false for CanBeShown(). Has no effect when called from the client.

SetActiveContext() [1/2]

proto external void BaseUserAction::SetActiveContext ( UserActionContext context )

protected

Setter for m_pActiveContext.

SetActiveContext() [2/2]

proto external void BaseUserAction::SetActiveContext ( UserActionContext context )

protected

Setter for m_pActiveContext.

SetCannotPerformReason() [1/2]

void BaseUserAction::SetCannotPerformReason ( string reason )

inlineprotected

Sets the reason why action couldn't be performed. Should be done in CanBePerformed check

Definition at line 21 of file BaseUserAction.c.

SetCannotPerformReason() [2/2]

void BaseUserAction::SetCannotPerformReason ( string reason )

inlineprotected

Sets the reason why action couldn't be performed. Should be done in CanBePerformed check

Definition at line 21 of file BaseUserAction.c.

SetSendActionDataFlag() [1/2]

proto external void BaseUserAction::SetSendActionDataFlag ( )

protected

Used to ask to send action data again during continuous action.

SetSendActionDataFlag() [2/2]

proto external void BaseUserAction::SetSendActionDataFlag ( )

protected

Used to ask to send action data again during continuous action.

ShouldPerformPerFrame() [1/2]

proto external bool BaseUserAction::ShouldPerformPerFrame ( )

protected

Should this action be performed every frame the input action is triggered?

ShouldPerformPerFrame() [2/2]

proto external bool BaseUserAction::ShouldPerformPerFrame ( )

protected

Should this action be performed every frame the input action is triggered?

WasDisabledByServer() [1/2]

proto external bool BaseUserAction::WasDisabledByServer ( )

protected

Was the action disabled by the server?

WasDisabledByServer() [2/2]

proto external bool BaseUserAction::WasDisabledByServer ( )

protected

Was the action disabled by the server?

Member Data Documentation

ActionNameParams

string BaseUserAction::ActionNameParams

protected

Can be filled in scripts to be used as params when name is being formatted when displayed in UI.

Definition at line 34 of file BaseUserAction.c.

m_sCannotPerformReason

string BaseUserAction::m_sCannotPerformReason

protected

The reason why action cannot be performed. Should be set in CanBePerformed check

Definition at line 17 of file BaseUserAction.c.

---

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

• scripts/Game/generated/UserAction/BaseUserAction.c