Inheritance diagram for PickupAction:

Additional Inherited Members
Public Member Functions inherited from BaseUserAction
void	SetCannotPerformReason (string reason)
	Sets the reason why action couldn't be performed.

string	GetCannotPerformReason ()
	Returns the reason why action couldn't be performed.

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	ShouldPerformPerFrame ()
	Should this action be performed every frame the input action is triggered?

proto external string	GetActionName ()
	Return the name of this action.

proto external string	GetActionDescription ()
	Return the description of this action.

proto external float	GetVisibilityRange ()
	Returns the visibility range of this action in metres.

proto external void	SetActionDuration (float duration)
	Sets the duration of this action in seconds.

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?

Public Attributes inherited from BaseUserAction
string	ActionNameParams [9]
	Can be filled in scripts to be used as params when name is being formatted when displayed in UI.

Protected Member Functions inherited from BaseUserAction
bool	OnRplSave (ScriptBitWriter writer)

bool	OnRplLoad (ScriptBitReader reader)

bool	OnSaveActionData (ScriptBitWriter writer)
	Before performing the action the caller can store some data in it which is delivered to others.

bool	OnLoadActionData (ScriptBitReader reader)
	If the one performing the action packed some data in it everybody receiving the action.

void	OnActionSelected ()
	Callback for when action is selected by the local player and the local player ONLY.

void	OnActionDeselected ()
	Callback for when action is deselected by the local player and the local player ONLY.

Protected Attributes inherited from BaseUserAction
string	m_sCannotPerformReason
	The reason why action cannot be performed.

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

Game/UserActions/PickupAction.c

Additional Inherited Members