Arma Reforger Script API
|
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? | |
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 | 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. | |
![]() | |
proto external float | GetMinimumValue () |
proto external float | GetMaximumValue () |
proto external float | GetCurrentValue () |
proto external void | SetSignalValue (float newValue) |
![]() | |
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 | 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? | |
![]() | |
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 () |
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 | |
void | ToggleActionBypass () |
Temporary fix for an issue of SetSendActionDataFlag not working properly from PerformAction. | |
void | HandleAction (float value) |
Increment target value. | |
void | HandleActionDecrease (float value) |
Decrement target 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 | 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. | |
![]() | |
bool | OnRplSave (ScriptBitWriter writer) |
bool | OnRplLoad (ScriptBitReader reader) |
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. | |
![]() | |
string | m_sCannotPerformReason |
The reason why action cannot be performed. | |
Additional Inherited Members | |
![]() | |
string | ActionNameParams [9] |
Can be filled in scripts to be used as params when name is being formatted when displayed in UI. | |
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_AdjustCollimatorAction, SCR_AdjustCollimatorElevationAction, SCR_AdjustShellChargeRingsAction, SCR_AdjustShellTimeFuzeAction, SCR_AdjustTimedFuzeAction, and SCR_RippleFireIntervalAction.
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.
override float SCR_AdjustSignalAction.GetActionProgressScript | ( | float | fProgress, |
float | timeSlice ) |
Returns the progress of this action in seconds.
Implements ScriptedSignalUserAction.
Implemented in SCR_AdjustShellTimeFuzeAction, and SCR_AdjustTimedFuzeAction.
|
protected |
Increment target value.
[in] | value | multiplayer which will be applied to the step value |
|
protected |
Decrement target value.
[in] | value | multiplayer which will be applied to the step value |
override bool SCR_AdjustSignalAction.HasLocalEffectOnlyScript | ( | ) |
Is the script broadcast to the server?
Implements ScriptedUserAction.
override void SCR_AdjustSignalAction.Init | ( | IEntity | pOwnerEntity, |
GenericComponent | pManagerComponent ) |
Called when object is initialized and registered to actions manager.
Implements ScriptedUserAction.
Implemented in SCR_AdjustCollimatorAction, SCR_AdjustShellChargeRingsAction, SCR_AdjustShellTimeFuzeAction, SCR_AdjustTimedFuzeAction, SCR_DeployCollimatorAction, and SCR_RippleFireIntervalAction.
bool SCR_AdjustSignalAction.IsManuallyAdjusted | ( | ) |
Used to tell if this action is meant to be adjustable with usage of the scroll wheel.
override void SCR_AdjustSignalAction.OnActionCanceled | ( | IEntity | pOwnerEntity, |
IEntity | pUserEntity ) |
Method called when the action is interrupted/canceled.
pUserEntity | The entity that was performing this action prior to interruption |
Implements ScriptedUserAction.
override void SCR_AdjustSignalAction.OnActionStart | ( | IEntity | pUserEntity | ) |
Method called from scripted interaction handler when an action is started (progress bar appeared)
pUserEntity | The entity that started performing this action |
Implements ScriptedUserAction.
Implemented in SCR_AdjustShellChargeRingsAction, and SCR_AdjustShellTimeFuzeAction.
|
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_AdjustCollimatorElevationAction, SCR_AdjustShellChargeRingsAction, SCR_AdjustShellTimeFuzeAction, SCR_AdjustTimedFuzeAction, SCR_DeployCollimatorAction, and SCR_RippleFireIntervalAction.
|
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_AdjustCollimatorElevationAction, SCR_AdjustShellChargeRingsAction, SCR_AdjustShellTimeFuzeAction, SCR_AdjustTimedFuzeAction, SCR_DeployCollimatorAction, and SCR_RippleFireIntervalAction.
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.
|
protected |
Plays movement and stop movement sound events.
Implemented in SCR_AdjustCollimatorAction.
|
protected |
Scripted version of the GetCurrentValue that can be overriden for custom handling.
Implemented in SCR_AdjustShellChargeRingsAction, and SCR_AdjustShellTimeFuzeAction.
|
protected |
Scripted version of the GetMaximumValue that can be overriden for custom handling.
Implemented in SCR_AdjustShellChargeRingsAction, and SCR_AdjustShellTimeFuzeAction.
|
protected |
Scripted version of the GetMinimumValue that can be overriden for custom handling.
Implemented in SCR_AdjustShellChargeRingsAction, and SCR_AdjustShellTimeFuzeAction.
|
protected |
Temporary fix for an issue of SetSendActionDataFlag not working properly from PerformAction.
|
protected |
Interacted with by main entity. Allows reading input actions.
|
protected |
Flag for restarting the process when end value is reached.
|
protected |
Flag for enabling adjustment with scroll wheel.
|
protected |
Should action only be Visible when player is inside the vehicle.
|
protected |
Should the action only be visible for the Pilot/Driver.
|
protected |
Adjustment step of normalized value.
|
protected |
Last lerp value.
|
protected |
Normalized current value.
|
protected |
Movement sound AudioHandle.
|
protected |
Action canceled sound event name.
|
protected |
Name of action to control the input.
|
protected |
Name of action to control the input.
|
protected |
Action start sound event name.
|
protected |
Movement sound event name.
|
protected |
Movement stop sound event name.
|
protected |
Sound component on owner entity.