SCR_UnflipVehicleAction Class Reference

Inheritance diagram for SCR_UnflipVehicleAction:

Protected 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)
override void	OnActionCanceled (IEntity pOwnerEntity, IEntity pUserEntity)
override bool	GetActionNameScript (out string outName)
override float	GetActionProgressScript (float fProgress, float timeSlice)
	Returns the progress of this action in seconds.
float	GetAdditionalForce ()
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)
bool	EvaluateFoundEntity (IEntity ent)
event void	OnActionSelected ()
event void	OnActionDeselected ()
override bool	CanBroadcastScript ()
	If HasLocalEffectOnly() is false this method tells if the server is supposed to broadcast this action to clients.

Protected Attributes
float	m_fSuggestedUsersMultiplier
ref array< IEntity >	m_aUsers = {}
SCR_RepairSupportStationComponent	m_HelpingStation
bool	m_bSelected
const float	SUPPORT_STATION_SEARCH_RADIUS_SQ = 100
	squared radius in meters

Detailed Description

Definition at line 1 of file SCR_UnflipVehicleAction.c.

Member Function Documentation

CanBeShownScript()

override bool SCR_UnflipVehicleAction::CanBeShownScript ( IEntity user )

inlineprotected

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

Definition at line 15 of file SCR_UnflipVehicleAction.c.

CanBroadcastScript()

override bool SCR_UnflipVehicleAction::CanBroadcastScript ( )

inlineprotected

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

Definition at line 227 of file SCR_UnflipVehicleAction.c.

EvaluateFoundEntity()

bool SCR_UnflipVehicleAction::EvaluateFoundEntity ( IEntity ent )

inlineprotected

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

Definition at line 192 of file SCR_UnflipVehicleAction.c.

FindNearbySupportStation()

void SCR_UnflipVehicleAction::FindNearbySupportStation ( )

inlineprotected

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

Definition at line 149 of file SCR_UnflipVehicleAction.c.

GetActionNameScript()

override bool SCR_UnflipVehicleAction::GetActionNameScript ( out string outName )

inlineprotected

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)

Definition at line 64 of file SCR_UnflipVehicleAction.c.

GetActionProgressScript()

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

inlineprotected

Returns the progress of this action in seconds.

Definition at line 96 of file SCR_UnflipVehicleAction.c.

GetAdditionalForce()

float SCR_UnflipVehicleAction::GetAdditionalForce ( )

inlineprotected

Definition at line 117 of file SCR_UnflipVehicleAction.c.

GetMaxForceToMassFactor()

float SCR_UnflipVehicleAction::GetMaxForceToMassFactor ( )

inlineprotected

Definition at line 137 of file SCR_UnflipVehicleAction.c.

OnActionCanceled()

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

inlineprotected

Method called when the action is interrupted/canceled.

Parameters

pUserEntity

The entity that was performing this action prior to interruption

Definition at line 54 of file SCR_UnflipVehicleAction.c.

OnActionDeselected()

event void SCR_UnflipVehicleAction::OnActionDeselected ( )

inlineprotected

Definition at line 220 of file SCR_UnflipVehicleAction.c.

OnActionSelected()

event void SCR_UnflipVehicleAction::OnActionSelected ( )

inlineprotected

Definition at line 213 of file SCR_UnflipVehicleAction.c.

OnActionStart()

override void SCR_UnflipVehicleAction::OnActionStart ( IEntity pUserEntity )

inlineprotected

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

Parameters

pUserEntity

The entity that started performing this action

Definition at line 43 of file SCR_UnflipVehicleAction.c.

PerformContinuousAction()

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

inlineprotected

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

Definition at line 29 of file SCR_UnflipVehicleAction.c.

QueryFilter()

bool SCR_UnflipVehicleAction::QueryFilter ( IEntity ent )

inlineprotected

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

Definition at line 160 of file SCR_UnflipVehicleAction.c.

Member Data Documentation

m_aUsers

ref array<IEntity> SCR_UnflipVehicleAction::m_aUsers = {}

protected

Definition at line 6 of file SCR_UnflipVehicleAction.c.

m_bSelected

bool SCR_UnflipVehicleAction::m_bSelected

protected

Definition at line 8 of file SCR_UnflipVehicleAction.c.

m_fSuggestedUsersMultiplier

float SCR_UnflipVehicleAction::m_fSuggestedUsersMultiplier

protected

Definition at line 4 of file SCR_UnflipVehicleAction.c.

m_HelpingStation

SCR_RepairSupportStationComponent SCR_UnflipVehicleAction::m_HelpingStation

protected

Definition at line 7 of file SCR_UnflipVehicleAction.c.

SUPPORT_STATION_SEARCH_RADIUS_SQ

const float SCR_UnflipVehicleAction::SUPPORT_STATION_SEARCH_RADIUS_SQ = 100

protected

squared radius in meters

Definition at line 11 of file SCR_UnflipVehicleAction.c.

---

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

• scripts/Game/UserActions/SCR_UnflipVehicleAction.c