SCR_PushVehicleAction Class Reference

Inheritance diagram for SCR_PushVehicleAction:

Protected Member Functions
override void	Init (IEntity pOwnerEntity, GenericComponent pManagerComponent)
	Called when object is initialized and registered to actions manager.
override bool	CanBeShownScript (IEntity user)
	Can this action be shown in the UI to the provided user entity?
float	GetAdditionalForce ()
float	GetMaxForceToMassFactor ()
void	ApplyForce (IEntity rootEntity, IEntity pUserEntity, float timeSlice, vector forceOffset=vector.Zero)
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 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.

Protected Attributes
const float	FORCE_SCALE = 1.0
const float	COUNTERFORCE_SCALE = -1.5
params	: "0.01 inf 0.01")] protected float m_fMassToForce
params	: "1 100000 1")] protected float m_fForceLimit
float	m_fLinearSpeedLimit
params	: "0 inf")] protected float m_fAngularSpeedLimit
bool	m_bPull
int	m_iForceApplicationFrequency
float	m_fCounterForceOffsetMultiplier
float	m_fApplicationInterval
float	m_fApplicationDeltaTime
RplComponent	m_Rpl

Detailed Description

Definition at line 1 of file SCR_PushVehicleAction.c.

Member Function Documentation

ApplyForce()

void SCR_PushVehicleAction::ApplyForce ( IEntity rootEntity, IEntity pUserEntity, float timeSlice, vector forceOffset = vector.Zero )

inlineprotected

Definition at line 105 of file SCR_PushVehicleAction.c.

CanBeShownScript()

override bool SCR_PushVehicleAction::CanBeShownScript ( IEntity user )

inlineprotected

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

Definition at line 53 of file SCR_PushVehicleAction.c.

CanBroadcastScript()

override bool SCR_PushVehicleAction::CanBroadcastScript ( )

inlineprotected

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

Definition at line 211 of file SCR_PushVehicleAction.c.

GetActionProgressScript()

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

inlineprotected

Returns the progress of this action in seconds.

Definition at line 204 of file SCR_PushVehicleAction.c.

GetAdditionalForce()

float SCR_PushVehicleAction::GetAdditionalForce ( )

protected

Returns

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

GetMaxForceToMassFactor()

float SCR_PushVehicleAction::GetMaxForceToMassFactor ( )

inlineprotected

Returns

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

Definition at line 99 of file SCR_PushVehicleAction.c.

Init()

override void SCR_PushVehicleAction::Init ( IEntity pOwnerEntity, GenericComponent pManagerComponent )

inlineprotected

Called when object is initialized and registered to actions manager.

Definition at line 42 of file SCR_PushVehicleAction.c.

OnActionCanceled()

override void SCR_PushVehicleAction::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 190 of file SCR_PushVehicleAction.c.

OnActionStart()

override void SCR_PushVehicleAction::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 181 of file SCR_PushVehicleAction.c.

PerformContinuousAction()

override void SCR_PushVehicleAction::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 173 of file SCR_PushVehicleAction.c.

Member Data Documentation

__pad0__

params SCR_PushVehicleAction::__pad0__

protected

Definition at line 6 of file SCR_PushVehicleAction.c.

__pad1__

params SCR_PushVehicleAction::__pad1__

protected

Definition at line 9 of file SCR_PushVehicleAction.c.

__pad2__

params SCR_PushVehicleAction::__pad2__

protected

Definition at line 15 of file SCR_PushVehicleAction.c.

COUNTERFORCE_SCALE

const float SCR_PushVehicleAction::COUNTERFORCE_SCALE = -1.5

protected

Definition at line 4 of file SCR_PushVehicleAction.c.

FORCE_SCALE

const float SCR_PushVehicleAction::FORCE_SCALE = 1.0

protected

Definition at line 3 of file SCR_PushVehicleAction.c.

m_bPull

bool SCR_PushVehicleAction::m_bPull

protected

Definition at line 19 of file SCR_PushVehicleAction.c.

m_fApplicationDeltaTime

float SCR_PushVehicleAction::m_fApplicationDeltaTime

protected

Definition at line 28 of file SCR_PushVehicleAction.c.

m_fApplicationInterval

float SCR_PushVehicleAction::m_fApplicationInterval

protected

Definition at line 27 of file SCR_PushVehicleAction.c.

m_fCounterForceOffsetMultiplier

float SCR_PushVehicleAction::m_fCounterForceOffsetMultiplier

protected

Definition at line 25 of file SCR_PushVehicleAction.c.

m_fLinearSpeedLimit

float SCR_PushVehicleAction::m_fLinearSpeedLimit

protected

Definition at line 13 of file SCR_PushVehicleAction.c.

m_iForceApplicationFrequency

int SCR_PushVehicleAction::m_iForceApplicationFrequency

protected

Definition at line 22 of file SCR_PushVehicleAction.c.

m_Rpl

RplComponent SCR_PushVehicleAction::m_Rpl

protected

Definition at line 29 of file SCR_PushVehicleAction.c.

---

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

• scripts/Game/UserActions/SCR_PushVehicleAction.c