Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_AdjustSignalAction Class Reference
Inheritance diagram for SCR_AdjustSignalAction:
ScriptedSignalUserAction SCR_AdjustCollimatorAction SCR_AdjustShellChargeRingsAction SCR_AdjustShellTimeFuzeAction SCR_AdjustTimedFuzeAction SCR_RippleFireIntervalAction SCR_AdjustCollimatorElevationAction SCR_DeployCollimatorAction

Protected 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)
override bool CanBeShownScript (IEntity user)
void ToggleActionBypass ()
 Temporary fix for an issue of SetSendActionDataFlag not working properly from PerformAction.
override void PerformContinuousAction (IEntity pOwnerEntity, IEntity pUserEntity, float timeSlice)
override void OnActionStart (IEntity pUserEntity)
override void OnActionCanceled (IEntity pOwnerEntity, IEntity pUserEntity)
void HandleAction (float value)
void HandleActionDecrease (float value)
float SCR_GetCurrentValue ()
 Scripted version of the GetCurrentValue that can be overriden for custom handling.
float SCR_GetMinimumValue ()
 Scripted version of the GetMinimumValue that can be overriden for custom handling.
float SCR_GetMaximumValue ()
 Scripted version of the GetMaximumValue that can be overriden for custom handling.
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.
bool OnSaveActionData (ScriptBitWriter writer)
bool OnLoadActionData (ScriptBitReader reader)
override float GetActionProgressScript (float fProgress, float timeSlice)

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.

Detailed Description

Definition at line 1 of file SCR_AdjustSignalAction.c.

Member Function Documentation

◆ CanBeShownScript()

override bool SCR_AdjustSignalAction::CanBeShownScript ( IEntity user)
inlineprotected

Definition at line 80 of file SCR_AdjustSignalAction.c.

◆ CanBroadcastScript()

override bool SCR_AdjustSignalAction::CanBroadcastScript ( )
inlineprotected

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

Definition at line 306 of file SCR_AdjustSignalAction.c.

◆ GetActionProgressScript()

override float SCR_AdjustSignalAction::GetActionProgressScript ( float fProgress,
float timeSlice )
inlineprotected

Definition at line 343 of file SCR_AdjustSignalAction.c.

◆ HandleAction()

void SCR_AdjustSignalAction::HandleAction ( float value)
inlineprotected

Increment target value

Parameters
[in]valuemultiplayer which will be applied to the step value

Definition at line 199 of file SCR_AdjustSignalAction.c.

◆ HandleActionDecrease()

void SCR_AdjustSignalAction::HandleActionDecrease ( float value)
inlineprotected

Decrement target value

Parameters
[in]valuemultiplayer which will be applied to the step value

Definition at line 231 of file SCR_AdjustSignalAction.c.

◆ HasLocalEffectOnlyScript()

override bool SCR_AdjustSignalAction::HasLocalEffectOnlyScript ( )
inlineprotected

Is the script broadcast to the server?

Definition at line 299 of file SCR_AdjustSignalAction.c.

◆ Init()

override void SCR_AdjustSignalAction::Init ( IEntity pOwnerEntity,
GenericComponent pManagerComponent )
inlineprotected

Definition at line 70 of file SCR_AdjustSignalAction.c.

◆ IsManuallyAdjusted()

bool SCR_AdjustSignalAction::IsManuallyAdjusted ( )
inlineprotected

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

Definition at line 64 of file SCR_AdjustSignalAction.c.

◆ OnActionCanceled()

override void SCR_AdjustSignalAction::OnActionCanceled ( IEntity pOwnerEntity,
IEntity pUserEntity )
inlineprotected

Definition at line 175 of file SCR_AdjustSignalAction.c.

◆ OnActionStart()

override void SCR_AdjustSignalAction::OnActionStart ( IEntity pUserEntity)
inlineprotected

Definition at line 148 of file SCR_AdjustSignalAction.c.

◆ OnLoadActionData()

bool SCR_AdjustSignalAction::OnLoadActionData ( ScriptBitReader reader)
inlineprotected

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.

Definition at line 327 of file SCR_AdjustSignalAction.c.

◆ OnSaveActionData()

bool SCR_AdjustSignalAction::OnSaveActionData ( ScriptBitWriter writer)
inlineprotected

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.

Definition at line 314 of file SCR_AdjustSignalAction.c.

◆ PerformContinuousAction()

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

Definition at line 141 of file SCR_AdjustSignalAction.c.

◆ PlayMovementAndStopSound()

void SCR_AdjustSignalAction::PlayMovementAndStopSound ( float lerp)
inlineprotected

Plays movement and stop movement sound events.

Definition at line 259 of file SCR_AdjustSignalAction.c.

◆ SCR_GetCurrentValue()

float SCR_AdjustSignalAction::SCR_GetCurrentValue ( )
inlineprotected

Scripted version of the GetCurrentValue that can be overriden for custom handling.

Definition at line 238 of file SCR_AdjustSignalAction.c.

◆ SCR_GetMaximumValue()

float SCR_AdjustSignalAction::SCR_GetMaximumValue ( )
inlineprotected

Scripted version of the GetMaximumValue that can be overriden for custom handling.

Definition at line 252 of file SCR_AdjustSignalAction.c.

◆ SCR_GetMinimumValue()

float SCR_AdjustSignalAction::SCR_GetMinimumValue ( )
inlineprotected

Scripted version of the GetMinimumValue that can be overriden for custom handling.

Definition at line 245 of file SCR_AdjustSignalAction.c.

◆ ToggleActionBypass()

void SCR_AdjustSignalAction::ToggleActionBypass ( )
inlineprotected

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

Definition at line 135 of file SCR_AdjustSignalAction.c.

Member Data Documentation

◆ m_bIsAdjustedByPlayer

bool SCR_AdjustSignalAction::m_bIsAdjustedByPlayer
protected

Interacted with by main entity. Allows reading input actions.

Definition at line 51 of file SCR_AdjustSignalAction.c.

◆ m_bLoopAction

bool SCR_AdjustSignalAction::m_bLoopAction
protected

Flag for restarting the process when end value is reached.

Definition at line 13 of file SCR_AdjustSignalAction.c.

◆ m_bManualAdjustment

bool SCR_AdjustSignalAction::m_bManualAdjustment
protected

Flag for enabling adjustment with scroll wheel.

Definition at line 9 of file SCR_AdjustSignalAction.c.

◆ m_bOnlyInVehicle

bool SCR_AdjustSignalAction::m_bOnlyInVehicle
protected

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

Definition at line 41 of file SCR_AdjustSignalAction.c.

◆ m_bPilotOnly

bool SCR_AdjustSignalAction::m_bPilotOnly
protected

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

Definition at line 45 of file SCR_AdjustSignalAction.c.

◆ m_fAdjustmentStep

float SCR_AdjustSignalAction::m_fAdjustmentStep
protected

Adjustment step of normalized value.

Definition at line 5 of file SCR_AdjustSignalAction.c.

◆ m_fLerpLast

float SCR_AdjustSignalAction::m_fLerpLast
protected

Last lerp value.

Definition at line 57 of file SCR_AdjustSignalAction.c.

◆ m_fTargetValue

float SCR_AdjustSignalAction::m_fTargetValue
protected

Normalized current value.

Definition at line 48 of file SCR_AdjustSignalAction.c.

◆ m_MovementAudioHandle

AudioHandle SCR_AdjustSignalAction::m_MovementAudioHandle
protected

Movement sound AudioHandle.

Definition at line 60 of file SCR_AdjustSignalAction.c.

◆ m_sActionCanceledSoundEvent

string SCR_AdjustSignalAction::m_sActionCanceledSoundEvent
protected

Action canceled sound event name.

Definition at line 29 of file SCR_AdjustSignalAction.c.

◆ m_sActionDecrease

string SCR_AdjustSignalAction::m_sActionDecrease
protected

Name of action to control the input.

Definition at line 21 of file SCR_AdjustSignalAction.c.

◆ m_sActionIncrease

string SCR_AdjustSignalAction::m_sActionIncrease
protected

Name of action to control the input.

Definition at line 17 of file SCR_AdjustSignalAction.c.

◆ m_sActionStartSoundEvent

string SCR_AdjustSignalAction::m_sActionStartSoundEvent
protected

Action start sound event name.

Definition at line 25 of file SCR_AdjustSignalAction.c.

◆ m_sMovementSoundEvent

string SCR_AdjustSignalAction::m_sMovementSoundEvent
protected

Movement sound event name.

Definition at line 33 of file SCR_AdjustSignalAction.c.

◆ m_sMovementStopSoundEvent

string SCR_AdjustSignalAction::m_sMovementStopSoundEvent
protected

Movement stop sound event name.

Definition at line 37 of file SCR_AdjustSignalAction.c.

◆ m_SoundComponent

SoundComponent SCR_AdjustSignalAction::m_SoundComponent
protected

Sound component on owner entity.

Definition at line 54 of file SCR_AdjustSignalAction.c.

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