SCR_AdjustSignalAction Interface Reference

Inheritance diagram for SCR_AdjustSignalAction:

Public Member Functions
bool	IsManuallyAdjusted ()
	Used to tell if this action is meant to be adjustable with usage of the scroll wheel.
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?
void	ToggleActionBypass ()
	Temporary fix for an issue of SetSendActionDataFlag not working properly from PerformAction.
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.
void	HandleAction (float value)
	Increment target value.
void	HandleActionDecrease (float value)
	Decrement target value.
void	PlayMovementAndStopSound (float lerp)
	Plays movement and stop movement sound events.
override bool	HasLocalEffectOnlyScript ()
	Is the script broadcast to the server?
override bool	CanBroadcastScript ()
	If HasLocalEffectOnly() is true this method tells if the server is supposed to broadcast this action to clients.
override float	GetActionProgressScript (float fProgress, float timeSlice)
	Returns the progress of this action in seconds.
Public Member Functions inherited from ScriptedSignalUserAction
proto external float	GetMinimumValue ()
proto external float	GetMaximumValue ()
proto external float	GetCurrentValue ()
proto external void	SetSignalValue (float newValue)
override float	GetActionProgressScript (float fProgress, float timeSlice)
	Returns the progress of this action in seconds.
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 ()

Protected Member Functions
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 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
float	m_fAdjustmentStep
	Adjustment step of normalized value.
bool	m_bManualAdjustment
	Flag for enabling adjustment with scroll wheel.
bool	m_bLoopAction
	Flag for restarting the process when end value is reached.
string	m_sActionIncrease
	Name of action to control the input.
string	m_sActionDecrease
	Name of action to control the input.
string	m_sActionStartSoundEvent
	Action start sound event name.
string	m_sActionCanceledSoundEvent
	Action canceled sound event name.
string	m_sMovementSoundEvent
	Movement sound event name.
string	m_sMovementStopSoundEvent
	Movement stop sound event name.
bool	m_bOnlyInVehicle
	Should action only be Visible when player is inside the vehicle.
bool	m_bPilotOnly
	Should the action only be visible for the Pilot/Driver.
float	m_fTargetValue
	Normalized current value.
bool	m_bIsAdjustedByPlayer
	Interacted with by main entity. Allows reading input actions.
SoundComponent	m_SoundComponent
	Sound component on owner entity.
float	m_fLerpLast
	Last lerp value.
AudioHandle	m_MovementAudioHandle
	Movement sound AudioHandle.
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

CanBeShownScript()

override bool SCR_AdjustSignalAction.CanBeShownScript

(

IEntity

user

)

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

Implements ScriptedUserAction.

Implemented in SCR_AdjustTimedFuzeAction.

CanBroadcastScript()

override bool SCR_AdjustSignalAction.CanBroadcastScript

(

)

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

Implements ScriptedUserAction.

GetActionProgressScript()

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

Returns the progress of this action in seconds.

Implements ScriptedSignalUserAction.

Implemented in SCR_AdjustTimedFuzeAction.

HandleAction()

void SCR_AdjustSignalAction.HandleAction

(

float

value

)

Increment target value.

Parameters

[in]

value

multiplayer which will be applied to the step value

HandleActionDecrease()

void SCR_AdjustSignalAction.HandleActionDecrease

(

float

value

)

Decrement target value.

Parameters

[in]

value

multiplayer which will be applied to the step value

HasLocalEffectOnlyScript()

override bool SCR_AdjustSignalAction.HasLocalEffectOnlyScript

(

)

Is the script broadcast to the server?

Implements ScriptedUserAction.

Init()

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

Called when object is initialized and registered to actions manager.

Implements ScriptedUserAction.

Implemented in SCR_AdjustTimedFuzeAction.

IsManuallyAdjusted()

bool SCR_AdjustSignalAction.IsManuallyAdjusted

(

)

Used to tell if this action is meant to be adjustable with usage of the scroll wheel.

OnActionCanceled()

override void SCR_AdjustSignalAction.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 ScriptedUserAction.

OnActionStart()

override void SCR_AdjustSignalAction.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 ScriptedUserAction.

OnLoadActionData()

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

Implemented in SCR_AdjustTimedFuzeAction.

OnSaveActionData()

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

Implements BaseUserAction.

Implemented in SCR_AdjustTimedFuzeAction.

PerformContinuousAction()

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

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

Implements ScriptedUserAction.

PlayMovementAndStopSound()

void SCR_AdjustSignalAction.PlayMovementAndStopSound

(

float

lerp

)

Plays movement and stop movement sound events.

ToggleActionBypass()

void SCR_AdjustSignalAction.ToggleActionBypass

(

)

Temporary fix for an issue of SetSendActionDataFlag not working properly from PerformAction.

Member Data Documentation

m_bIsAdjustedByPlayer

bool SCR_AdjustSignalAction.m_bIsAdjustedByPlayer

protected

Interacted with by main entity. Allows reading input actions.

m_bLoopAction

bool SCR_AdjustSignalAction.m_bLoopAction

protected

Flag for restarting the process when end value is reached.

m_bManualAdjustment

bool SCR_AdjustSignalAction.m_bManualAdjustment

protected

Flag for enabling adjustment with scroll wheel.

m_bOnlyInVehicle

bool SCR_AdjustSignalAction.m_bOnlyInVehicle

protected

Should action only be Visible when player is inside the vehicle.

m_bPilotOnly

bool SCR_AdjustSignalAction.m_bPilotOnly

protected

Should the action only be visible for the Pilot/Driver.

m_fAdjustmentStep

float SCR_AdjustSignalAction.m_fAdjustmentStep

protected

Adjustment step of normalized value.

m_fLerpLast

float SCR_AdjustSignalAction.m_fLerpLast

protected

Last lerp value.

m_fTargetValue

float SCR_AdjustSignalAction.m_fTargetValue

protected

Normalized current value.

m_MovementAudioHandle

AudioHandle SCR_AdjustSignalAction.m_MovementAudioHandle

protected

Movement sound AudioHandle.

m_sActionCanceledSoundEvent

string SCR_AdjustSignalAction.m_sActionCanceledSoundEvent

protected

Action canceled sound event name.

m_sActionDecrease

string SCR_AdjustSignalAction.m_sActionDecrease

protected

Name of action to control the input.

m_sActionIncrease

string SCR_AdjustSignalAction.m_sActionIncrease

protected

Name of action to control the input.

m_sActionStartSoundEvent

string SCR_AdjustSignalAction.m_sActionStartSoundEvent

protected

Action start sound event name.

m_sMovementSoundEvent

string SCR_AdjustSignalAction.m_sMovementSoundEvent

protected

Movement sound event name.

m_sMovementStopSoundEvent

string SCR_AdjustSignalAction.m_sMovementStopSoundEvent

protected

Movement stop sound event name.

m_SoundComponent

SoundComponent SCR_AdjustSignalAction.m_SoundComponent

protected

Sound component on owner entity.

---

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

• Game/UserActions/SCR_AdjustSignalAction.c