SCR_VehicleLockControlsAction Interface Reference

Inheritance diagram for SCR_VehicleLockControlsAction:

Public Member Functions
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	By default toggle the current state of the interaction.
override bool	GetState ()
	Current state of the feature.
Public Member Functions inherited from SCR_VehicleActionBase
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
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?
bool	GetState ()
	Current state of the feature.
void	SetState (bool enable)
	Script to change state of the feature.
override void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	By default toggle the current state of the interaction.
override bool	GetActionNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.
Public Member Functions inherited from ScriptedUserAction
void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the action, user entity is typically character.
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	GetActionNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.
bool	GetActionDescriptionScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionDescription is called.
bool	CanBePerformedScript (IEntity user)
	Can this action be performed by the provided user entity?
bool	CanBeShownScript (IEntity user)
	Can this entity be shown in the UI by the provided user entity?
bool	HasLocalEffectOnlyScript ()
	Does this action only have client side effect?
bool	CanBroadcastScript ()
	If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.
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	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 ()

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.
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 SCR_VehicleActionBase
bool	m_bIsToggle
	Should action behave as a toggle.
bool	m_bTargetState
	Target state of the action, ignored if toggle.
string	m_sActionStateOn
	Description of action to toggle on.
string	m_sActionStateOff
	Description of action to toggle off.
bool	m_bPilotOnly
	Available only for entities seated in pilot compartment.
bool	m_bInteriorOnly
	Available only for entities seated in a vehicle.
ref array< int >	m_aDefinedCompartmentSectionsOnly
ref array< int >	m_aExcludeDefinedCompartmentSections
CompartmentControllerComponent	m_VehicleController
Protected Attributes inherited from BaseUserAction
string	m_sCannotPerformReason
	The reason why action cannot be performed.

Member Function Documentation

GetState()

override bool SCR_VehicleLockControlsAction.GetState

(

)

Current state of the feature.

Implements SCR_VehicleActionBase.

PerformAction()

override void SCR_VehicleLockControlsAction.PerformAction	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity
	)

By default toggle the current state of the interaction.

Implements SCR_VehicleActionBase.

---

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

• Game/UserActions/SCR_VehicleLockControlsAction.c