SCR_UnflipVehicleAction Interface Reference

Inheritance diagram for SCR_UnflipVehicleAction:

Public Member Functions
override bool	CanBeShownScript (IEntity user)
	Can this action be shown in the UI to the provided user entity?
override void	PerformContinuousAction (IEntity pOwnerEntity, IEntity pUserEntity, float timeSlice)
	Called when someone tries to perform the continuous action, user entity is typically character.
override void	OnActionStart (IEntity pUserEntity)
	Method called from scripted interaction handler when an action is started (progress bar appeared)
override void	OnActionCanceled (IEntity pOwnerEntity, IEntity pUserEntity)
	Method called when the action is interrupted/canceled.
override bool	GetActionNameScript (out string outName)
	If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.
override float	GetActionProgressScript (float fProgress, float timeSlice)
	Returns the progress of this action in seconds.
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_PushVehicleAction
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
Public Member Functions inherited from SCR_ScriptedUserAction
vector	GetLocalPositionAction ()
	Get action local position Used for such things like playing audio at the correct location on action use.
vector	GetWorldPositionAction ()
	Get action world position Used for such things like playing audio at the correct location on action use.
bool	IsActionLooping ()
float	GetLoopActionHoldDuration ()
Public Member Functions inherited from ScriptedUserAction
void	PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
	Called when someone tries to perform the 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.
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	HasLocalEffectOnlyScript ()
	Does this action only have client side effect?
bool	CheckOnServerFirstScript ()
	If SCR_CheckOnServerFirst returns true, the action is first sent to be verified on the server.
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
override float	GetAdditionalForce ()
override float	GetMaxForceToMassFactor ()
void	FindNearbySupportStation ()
	Queries the area around the owner of this action, in order to search for support station, which can provide help for this action.
bool	QueryFilter (IEntity ent)
	Callback method used to quickly filter most of unwanted objects.
bool	EvaluateFoundEntity (IEntity ent)
	Callback method used to evaluate if found is a valid support station.
override void	OnActionSelected ()
	Callback for when action is selected by the local player and the local player ONLY.
override void	OnActionDeselected ()
	Callback for when action is deselected by the local player and the local player ONLY.
Protected Member Functions inherited from SCR_PushVehicleAction
void	ApplyForce (IEntity rootEntity, IEntity pUserEntity, float timeSlice, vector forceOffset=vector.Zero)
Protected Member Functions inherited from SCR_ScriptedUserAction
bool	IsSameVehicleOrNone (notnull IEntity user)
bool	LoopActionUpdate (float timeSlice)
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.

Protected Attributes
float	m_fSuggestedUsersMultiplier
ref array< IEntity >	m_aUsers = {}
SCR_RepairSupportStationComponent	m_HelpingStation
bool	m_bSelected
Protected Attributes inherited from SCR_PushVehicleAction
float	m_fMassToForce
float	m_fForceLimit
float	m_fLinearSpeedLimit
float	m_fAngularSpeedLimit
bool	m_bPull
int	m_iForceApplicationFrequency
float	m_fCounterForceOffsetMultiplier
float	m_fApplicationInterval
float	m_fApplicationDeltaTime
RplComponent	m_Rpl
Protected Attributes inherited from SCR_ScriptedUserAction
bool	m_bLoopAction
float	m_fLoopActionHoldDuration
bool	m_bLowerWeaponOnUse
EUserActionInVehicleState	m_eShownInVehicleState
bool	m_bSameVehicleOnly
UserActionContext	m_LastUserActionContext
float	m_fLoopProgress
float	m_fLoopProgressSmoothVelocity
Protected Attributes inherited from BaseUserAction
string	m_sCannotPerformReason
	The reason why action cannot be performed.

Static Protected Attributes
const float	SUPPORT_STATION_SEARCH_RADIUS_SQ = 100
	squared radius in meters
Static Protected Attributes inherited from SCR_PushVehicleAction
const float	FORCE_SCALE = 1.0
const float	COUNTERFORCE_SCALE = -1.5

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

CanBeShownScript()

override bool SCR_UnflipVehicleAction.CanBeShownScript

(

IEntity

user

)

Can this action be shown in the UI to the provided user entity?

Implements SCR_PushVehicleAction.

CanBroadcastScript()

override bool SCR_UnflipVehicleAction.CanBroadcastScript

(

)

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

Implements SCR_PushVehicleAction.

EvaluateFoundEntity()

bool SCR_UnflipVehicleAction.EvaluateFoundEntity ( IEntity ent )

protected

Callback method used to evaluate if found is a valid support station.

Parameters

[in]

ent

entity that was found with the query

Returns

true if query should continue fetching more entities

FindNearbySupportStation()

void SCR_UnflipVehicleAction.FindNearbySupportStation ( )

protected

Queries the area around the owner of this action, in order to search for support station, which can provide help for this action.

GetActionNameScript()

override bool SCR_UnflipVehicleAction.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.

GetActionProgressScript()

override float SCR_UnflipVehicleAction.GetActionProgressScript	(	float	fProgress,
		float	timeSlice )

Returns the progress of this action in seconds.

Implements SCR_PushVehicleAction.

GetAdditionalForce()

override float SCR_UnflipVehicleAction.GetAdditionalForce ( )

protected

Returns

amount of force which should be added to the force which is going to be applied to the vehicle

Implements SCR_PushVehicleAction.

GetMaxForceToMassFactor()

override float SCR_UnflipVehicleAction.GetMaxForceToMassFactor ( )

protected

Returns

factor which determines how much force can be used in relation to the vehicle mass

Implements SCR_PushVehicleAction.

OnActionCanceled()

override void SCR_UnflipVehicleAction.OnActionCanceled	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity )

Method called when the action is interrupted/canceled.

Parameters

pUserEntity

The entity that was performing this action prior to interruption

Implements SCR_PushVehicleAction.

OnActionDeselected()

override void SCR_UnflipVehicleAction.OnActionDeselected ( )

protected

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

Implements BaseUserAction.

OnActionSelected()

override void SCR_UnflipVehicleAction.OnActionSelected ( )

protected

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

Implements SCR_ScriptedUserAction.

OnActionStart()

override void SCR_UnflipVehicleAction.OnActionStart

(

IEntity

pUserEntity

)

Method called from scripted interaction handler when an action is started (progress bar appeared)

Parameters

pUserEntity

The entity that started performing this action

Implements SCR_PushVehicleAction.

PerformContinuousAction()

override void SCR_UnflipVehicleAction.PerformContinuousAction	(	IEntity	pOwnerEntity,
		IEntity	pUserEntity,
		float	timeSlice )

Called when someone tries to perform the continuous action, user entity is typically character.

Implements SCR_PushVehicleAction.

QueryFilter()

bool SCR_UnflipVehicleAction.QueryFilter ( IEntity ent )

protected

Callback method used to quickly filter most of unwanted objects.

Parameters

[in]

ent

entity that was found with the query

Returns

true if entity should be evaluated further, otherwise false

Member Data Documentation

m_aUsers

ref array<IEntity> SCR_UnflipVehicleAction.m_aUsers = {}

protected

m_bSelected

bool SCR_UnflipVehicleAction.m_bSelected

protected

m_fSuggestedUsersMultiplier

float SCR_UnflipVehicleAction.m_fSuggestedUsersMultiplier

protected

m_HelpingStation

SCR_RepairSupportStationComponent SCR_UnflipVehicleAction.m_HelpingStation

protected

SUPPORT_STATION_SEARCH_RADIUS_SQ

const float SCR_UnflipVehicleAction.SUPPORT_STATION_SEARCH_RADIUS_SQ = 100

staticprotected

squared radius in meters

---

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

• Game/UserActions/SCR_UnflipVehicleAction.c