SCR_LoiterUserAction Interface Reference

Inheritance diagram for SCR_LoiterUserAction:

Public Member Functions
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
override void	StartAction (IEntity pUserEntity)
override void	StopAction (IEntity pUserEntity)
override bool	CanBeShownScript (IEntity user)
	Can this entity be shown in the UI by the provided user entity?
override bool	CanBePerformedScript (IEntity user)
	Can this action be performed by the provided user entity?
override bool	GetActionNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.
override bool	HasLocalEffectOnlyScript ()
	Does this action only have client side effect?
override bool	CheckOnServerFirstScript ()
	If SCR_CheckOnServerFirst returns true, the action is first sent to be verified on the server.
override bool	CanBroadcastScript ()
	If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.
Public Member Functions inherited from SCR_UserActionWithOccupancy
bool	IsOccupied ()
bool	IsOccupiedBy (IEntity ent)
void	ReleaseOccupant ()
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the action, user entity is typically character.
Public Member Functions inherited from ScriptedUserAction
void	PerformContinuousAction (IEntity pOwnerEntity, IEntity pUserEntity, float timeSlice)
	Called when someone tries to perform the continuous action, user entity is typically character.
void	OnConfirmed (IEntity pUserEntity)
	If action passed as callback OnConfirmed will be called when reached execution, user entity is typically character.
void	OnRejected (IEntity pUserEntity)
	If action passed as callback OnRejected will be called when execution was rejected, user entity is typically character.
void	OnActionCanceled (IEntity pOwnerEntity, IEntity pUserEntity)
	Method called when the action is interrupted/canceled.
void	OnActionStart (IEntity pUserEntity)
	Method called from scripted interaction handler when an action is started (progress bar appeared)
bool	GetActionDescriptionScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionDescription is called.
float	GetActionProgressScript (float fProgress, float timeSlice)
	Returns the progress of this action in seconds.
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	CheckOnServerFirst ()
	If CheckOnServerFirst returns true, the action is first sent to be verified on the server.
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 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?

Protected Member Functions
vector m_targetPosition[4] void	GetLoiteringPosition (SCR_AISmartActionSentinelComponent smartAction, out vector loiteringPosition[4])
	Calculates the position of loitering.
override bool	OnSaveActionData (ScriptBitWriter writer)
	Before performing the action the caller can store some data in it which is delivered to others.
override bool	OnLoadActionData (ScriptBitReader reader)
	If the one performing the action packed some data in it everybody receiving the action.
Protected Member Functions inherited from SCR_UserActionWithOccupancy
bool	SaveOccupant (ScriptBitWriter writer)
bool	LoadOccupant (ScriptBitReader reader)
override bool	OnRplSave (ScriptBitWriter writer)
override bool	OnRplLoad (ScriptBitReader reader)
Protected Member Functions inherited from BaseUserAction
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
int	m_iSmartActionId
bool	m_isValid
bool	m_bHolsterWeapon
ELoiteringType	m_eLoiteringType
Protected Attributes inherited from SCR_UserActionWithOccupancy
IEntity	m_Occupant
RplId	m_OccupantRplId
Protected Attributes inherited from BaseUserAction
string	m_sCannotPerformReason
	The reason why action cannot be performed.

Additional Inherited Members
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.

Member Function Documentation

CanBePerformedScript()

override bool SCR_LoiterUserAction.CanBePerformedScript

(

IEntity

user

)

Can this action be performed by the provided user entity?

Implements ScriptedUserAction.

CanBeShownScript()

override bool SCR_LoiterUserAction.CanBeShownScript

(

IEntity

user

)

Can this entity be shown in the UI by the provided user entity?

Implements ScriptedUserAction.

CanBroadcastScript()

override bool SCR_LoiterUserAction.CanBroadcastScript

(

)

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

Implements ScriptedUserAction.

CheckOnServerFirstScript()

override bool SCR_LoiterUserAction.CheckOnServerFirstScript

(

)

If SCR_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.

Implements ScriptedUserAction.

GetActionNameScript()

override bool SCR_LoiterUserAction.GetActionNameScript

(

out string

outName

)

If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.

If not overridden or false is returned the default value from UIInfo is taken (or empty string if no UI info exists)

Implements ScriptedUserAction.

GetLoiteringPosition()

vector m_targetPosition[4] void SCR_LoiterUserAction.GetLoiteringPosition ( SCR_AISmartActionSentinelComponent smartAction, out vector loiteringPosition[4] )

protected

Calculates the position of loitering.

HasLocalEffectOnlyScript()

override bool SCR_LoiterUserAction.HasLocalEffectOnlyScript

(

)

Does this action only have client side effect?

Implements ScriptedUserAction.

Init()

override void SCR_LoiterUserAction.Init	(	IEntity	pOwnerEntity,
		GenericComponent	pManagerComponent )

Called when object is initialized and registered to actions manager.

Implements ScriptedUserAction.

OnLoadActionData()

override bool SCR_LoiterUserAction.OnLoadActionData ( ScriptBitReader reader )

protected

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.

Implements BaseUserAction.

OnSaveActionData()

override bool SCR_LoiterUserAction.OnSaveActionData ( ScriptBitWriter writer )

protected

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.

Implements BaseUserAction.

StartAction()

override void SCR_LoiterUserAction.StartAction

(

IEntity

pUserEntity

)

Implements SCR_UserActionWithOccupancy.

StopAction()

override void SCR_LoiterUserAction.StopAction

(

IEntity

pUserEntity

)

Implements SCR_UserActionWithOccupancy.

Member Data Documentation

m_bHolsterWeapon

bool SCR_LoiterUserAction.m_bHolsterWeapon

protected

m_eLoiteringType

ELoiteringType SCR_LoiterUserAction.m_eLoiteringType

protected

m_iSmartActionId

int SCR_LoiterUserAction.m_iSmartActionId

protected

m_isValid

bool SCR_LoiterUserAction.m_isValid

protected

---

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

• Game/AI/UserActions/SCR_LoiterUserAction.c