Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_MortarShootAction Interface Reference
Inheritance diagram for SCR_MortarShootAction:
SCR_ScriptedUserAction ScriptedUserAction BaseUserAction

Public 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 entity be shown in the UI by the provided user entity?
 
override bool CanBePerformedScript (IEntity user)
 Can this action be performed by the provided user entity?
 
override void PerformAction (IEntity pOwnerEntity, IEntity pUserEntity)
 Called when someone tries to perform the action, user entity is typically character.
 
override bool GetActionNameScript (out string outName)
 If overridden and true is returned, outName is returned when BaseUserAction.GetActionName is called.
 
override void OnActionStart (IEntity pUserEntity)
 Method called from scripted interaction handler when an action is started (progress bar appeared)
 
- Public Member Functions inherited from SCR_ScriptedUserAction
vector GetLocalPositionAction ()
 Get action local position Used for such things like playing audio at the correct location on action use.
 
vector GetWorldPositionAction ()
 Get action world position Used for such things like playing audio at the correct location on action use.
 
override float GetActionProgressScript (float fProgress, float timeSlice)
 
bool IsActionLooping ()
 
float GetLoopActionHoldDuration ()
 
- Public Member Functions inherited from ScriptedUserAction
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.
 
bool GetActionDescriptionScript (out string outName)
 If overridden and true is returned, outName is returned when BaseUserAction.GetActionDescription is called.
 
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.
 
- 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 ()
 
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

SCR_MortarShellGadgetComponent GetHeldShellGadgetComp (notnull ChimeraCharacter character)
 
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 SCR_ScriptedUserAction
bool IsSameVehicleOrNone (notnull IEntity user)
 
bool LoopActionUpdate (float timeSlice)
 
override void OnActionSelected ()
 Callback for when action is selected by the local player and the local player ONLY.
 
- Protected Member Functions inherited from BaseUserAction
bool OnRplSave (ScriptBitWriter writer)
 
bool OnRplLoad (ScriptBitReader reader)
 
void OnActionDeselected ()
 Callback for when action is deselected by the local player and the local player ONLY.
 

Protected Attributes

bool m_bPerformFromTheLeftSide
 
bool m_bCheckIfTurretIsEmpty
 
BaseMagazineWell m_MortarMagWell
 
SCR_MortarMuzzleComponent m_MortarMuzzleComponent
 
SCR_MortarShellGadgetComponent m_ShellComp
 
ChimeraCharacter m_Loader
 
float m_fFuzeTime = -1
 
- Protected Attributes inherited from SCR_ScriptedUserAction
bool m_bLoopAction
 
float m_fLoopActionHoldDuration
 
bool m_bLowerWeaponOnUse
 
EUserActionInVehicleState m_eShownInVehicleState
 
bool m_bSameVehicleOnly
 
UserActionContext m_LastUserActionContext
 
float m_fLoopProgress
 
float m_fLoopProgressSmoothVelocity
 
- Protected Attributes inherited from BaseUserAction
string m_sCannotPerformReason
 The reason why action cannot be performed.
 

Static Protected Attributes

const LocalizedString WRONG_SHELL_TYPE = "#AR-UserAction_WrongShellType"
 
const LocalizedString ALREADY_LOADED = "#AR-UserAction_AlreadyLoaded"
 
const LocalizedString FIRE_WITH_MANUAL_FUZE = "#AR-UserAction_MortarFire_ManualFuze"
 
const LocalizedString FIRE_WITH_AUTOMATIC_FUZE = "#AR-UserAction_MortarFire_AutomaticFuze"
 
const LocalizedString AREA_OBSTRUCTED = "#AR-UserAction_SeatObstructed"
 

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

◆ CanBePerformedScript()

override bool SCR_MortarShootAction.CanBePerformedScript ( IEntity user)

Can this action be performed by the provided user entity?

Implements ScriptedUserAction.

◆ CanBeShownScript()

override bool SCR_MortarShootAction.CanBeShownScript ( IEntity user)

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

Implements SCR_ScriptedUserAction.

◆ GetActionNameScript()

override bool SCR_MortarShootAction.GetActionNameScript ( out string outName)

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)

Implements ScriptedUserAction.

◆ GetHeldShellGadgetComp()

SCR_MortarShellGadgetComponent SCR_MortarShootAction.GetHeldShellGadgetComp ( notnull ChimeraCharacter character)
protected

◆ Init()

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

Called when object is initialized and registered to actions manager.

Implements ScriptedUserAction.

◆ OnActionStart()

override void SCR_MortarShootAction.OnActionStart ( IEntity pUserEntity)

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

Parameters
pUserEntityThe entity that started performing this action

Implements SCR_ScriptedUserAction.

◆ OnLoadActionData()

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

◆ OnSaveActionData()

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

◆ PerformAction()

override void SCR_MortarShootAction.PerformAction ( IEntity pOwnerEntity,
IEntity pUserEntity )

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

Implements ScriptedUserAction.

Member Data Documentation

◆ ALREADY_LOADED

const LocalizedString SCR_MortarShootAction.ALREADY_LOADED = "#AR-UserAction_AlreadyLoaded"
staticprotected

◆ AREA_OBSTRUCTED

const LocalizedString SCR_MortarShootAction.AREA_OBSTRUCTED = "#AR-UserAction_SeatObstructed"
staticprotected

◆ FIRE_WITH_AUTOMATIC_FUZE

const LocalizedString SCR_MortarShootAction.FIRE_WITH_AUTOMATIC_FUZE = "#AR-UserAction_MortarFire_AutomaticFuze"
staticprotected

◆ FIRE_WITH_MANUAL_FUZE

const LocalizedString SCR_MortarShootAction.FIRE_WITH_MANUAL_FUZE = "#AR-UserAction_MortarFire_ManualFuze"
staticprotected

◆ m_bCheckIfTurretIsEmpty

bool SCR_MortarShootAction.m_bCheckIfTurretIsEmpty
protected

◆ m_bPerformFromTheLeftSide

bool SCR_MortarShootAction.m_bPerformFromTheLeftSide
protected

◆ m_fFuzeTime

float SCR_MortarShootAction.m_fFuzeTime = -1
protected

◆ m_Loader

ChimeraCharacter SCR_MortarShootAction.m_Loader
protected

◆ m_MortarMagWell

BaseMagazineWell SCR_MortarShootAction.m_MortarMagWell
protected

◆ m_MortarMuzzleComponent

SCR_MortarMuzzleComponent SCR_MortarShootAction.m_MortarMuzzleComponent
protected

◆ m_ShellComp

SCR_MortarShellGadgetComponent SCR_MortarShootAction.m_ShellComp
protected

◆ WRONG_SHELL_TYPE

const LocalizedString SCR_MortarShootAction.WRONG_SHELL_TYPE = "#AR-UserAction_WrongShellType"
staticprotected

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