Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_MortarShellGadgetComponent Interface Reference
Inheritance diagram for SCR_MortarShellGadgetComponent:
SCR_GadgetComponent ScriptGameComponent

Public Member Functions

override EGadgetType GetType ()
 Get gadget type.
 
override bool CanBeRaised ()
 Gadget has a raised animation version.
 
override bool IsVisibleEquipped ()
 Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.
 
ScriptInvokerVoid GetOnShellUsed ()
 
bool IsLoaded ()
 
bool IsUsingTimeFuze ()
 
float GetFuzeTime ()
 
float GetMinFuzeTime ()
 
float GetMaxFuzeTime ()
 
float GetDetonationAltitude ()
 
int GetNumberOfChargeRingConfigurations ()
 
vector GetCurentChargeRingConfig ()
 
int GetCurentChargeRingConfigId ()
 
vector GetChargeRingConfig (int id)
 
int FindDefaultChargeRingConfig ()
 Searches for the first charge ring config that is marked as default.
 
void SetChargeRingConfig (int configId, bool silent=false, bool replicate=true)
 Sets the number of charge rings that are going to be used to fire this projectile.
 
void OnShellFired (notnull BaseMuzzleComponent muzzle)
 Method that is meant to be called when it is firred from a mortar.
 
bool SetLoadedState (bool state, SCR_MortarMuzzleComponent mortarMuzzle=null, string fireActionName="", IEntity user=null)
 
override void OnToggleActive (bool state)
 Event called from SCR_GadgetManagerComponent through RPC request.
 
void SetFuzeTime (float time)
 
SCR_ShellConfig GetSavedConfig (notnull ChimeraCharacter character)
 Retrieves locally saved data about manual adjustment of the fuze that player set for this shell type.
 
float GetTimeToDetonation (float angle, bool isDirectFire)
 Retrieves information about the time of flight for this shell prefab.
 
override bool RplSave (ScriptBitWriter writer)
 
override bool RplLoad (ScriptBitReader reader)
 
- Public Member Functions inherited from SCR_GadgetComponent
EGadgetAnimVariable GetAnimVariable ()
 
float GetWeaponNoFireTime ()
 
bool IsToggledOn ()
 Is gadget toggled on/off.
 
void OnParentSlotChanged (InventoryStorageSlot oldSlot, InventoryStorageSlot newSlot)
 InventoryItemComponent event.
 
void OnModeChanged (EGadgetMode mode, IEntity charOwner)
 Gadget mode change event.
 
void OnSlotOccludedStateChanged (bool occluded)
 Method called when slot to which item is attached to changed its occlusion state.
 
void ActivateGadgetUpdate ()
 Activate gadget frame update.
 
void DeactivateGadgetUpdate ()
 Deactivate gadget frame flag.
 
void UpdateVisibility (EGadgetMode mode)
 Set visibility when show/hide hand animation starts/finishes.
 
void ToggleActive (bool state, SCR_EUseContext context)
 Synchronise gadget state.
 
void ActivateAction ()
 Action listener callback.
 
void ToggleFocused (bool enable)
 Toggle gadget focus state.
 
ChimeraCharacter GetCharacterOwner ()
 Get IEntity in possession of this Gadget.
 
EGadgetMode GetMode ()
 Get gadget mode.
 
bool CanBeHeld ()
 Can be held in hand.
 
SCR_EUseContext GetUseMask ()
 Provides value that contains mask of contexts from which this gadget can be toggled.
 
bool IsUsingADSControls ()
 Gadget uses ADS controls from gadget raisable context.
 
void Update (float timeSlice)
 
override void OnDelete (IEntity owner)
 
override void OnPostInit (IEntity owner)
 

Static Public Member Functions

static array< float > GetPrefabInitSpeedCoef (ResourceName resourceName, out int defaultConfigId)
 Extracts the information about available init speed coef from resource name.
 

Protected Member Functions

void OnChargeRingReplicated ()
 Callback method that will be triggered when m_iChargeRingConfigIndex is bumped for replication.
 
void VisualiseChargeRings (int numberOfChargeRings)
 Shows or hides charge ring visualiastion that are defined in prefab slot manager.
 
void UseShellCB ()
 Callback used to tell if user wants to fire the shell now.
 
override void ModeSwitch (EGadgetMode mode, IEntity charOwner)
 Set gadget mode.
 
override void EOnInit (IEntity owner)
 
- Protected Member Functions inherited from SCR_GadgetComponent
void ModeClear (EGadgetMode mode)
 Clear gadget mode.
 
void ConnectToGadgetsSystem ()
 Starts on frame update event.
 
void DisconnectFromGadgetsSystem ()
 
- Protected Member Functions inherited from ScriptGameComponent
bool OnTicksOnRemoteProxy ()
 

Protected Attributes

bool m_bIsUsingTimeFuze
 
float m_fMinFuzeTime
 
float m_fMaxFuzeTime
 
float m_fDetonationAltitude
 
float m_fVerticalImpactTimeOffset
 
ref array< vector > m_aChargeRingConfig
 
int m_iChargeRingConfigIndex
 
ref ScriptInvokerVoid m_OnShellUsed
 
SCR_MortarMuzzleComponent m_MortarMuzzleComp
 
SlotManagerComponent m_SlotManagerComp
 
string m_sRegisteredActionName
 
float m_fFuzeTime
 
bool m_bCustomFuzeTimeSet
 
bool m_bCustomChargeRingSet
 
- Protected Attributes inherited from SCR_GadgetComponent
EGadgetAnimVariable m_eAnimVariable
 
SCR_EUseContext m_eUseMask
 
vector m_vEquipmentSlotOffset
 
float m_fWeaponNoFireTime
 
bool m_bCanBeHeld
 
bool m_bActivated = false
 
EGadgetMode m_iMode = EGadgetMode.ON_GROUND
 
ChimeraCharacter m_CharacterOwner
 

Static Protected Attributes

static const string CHARGE_RING_CONFIG_MEMBER_NAME = "m_aChargeRingConfig"
 

Additional Inherited Members

- Public Attributes inherited from SCR_GadgetComponent
bool m_bFocused
 

Member Function Documentation

◆ CanBeRaised()

override bool SCR_MortarShellGadgetComponent.CanBeRaised ( )

Gadget has a raised animation version.

Returns
Returns true if raisable

Implements SCR_GadgetComponent.

◆ EOnInit()

override void SCR_MortarShellGadgetComponent.EOnInit ( IEntity owner)
protected

◆ FindDefaultChargeRingConfig()

int SCR_MortarShellGadgetComponent.FindDefaultChargeRingConfig ( )

Searches for the first charge ring config that is marked as default.

Returns
id of the default config or -1 when such is not found

◆ GetChargeRingConfig()

vector SCR_MortarShellGadgetComponent.GetChargeRingConfig ( int id)
Returns

◆ GetCurentChargeRingConfig()

vector SCR_MortarShellGadgetComponent.GetCurentChargeRingConfig ( )
Returns

◆ GetCurentChargeRingConfigId()

int SCR_MortarShellGadgetComponent.GetCurentChargeRingConfigId ( )
Returns

◆ GetDetonationAltitude()

float SCR_MortarShellGadgetComponent.GetDetonationAltitude ( )
Returns

◆ GetFuzeTime()

float SCR_MortarShellGadgetComponent.GetFuzeTime ( )
Returns

◆ GetMaxFuzeTime()

float SCR_MortarShellGadgetComponent.GetMaxFuzeTime ( )
Returns

◆ GetMinFuzeTime()

float SCR_MortarShellGadgetComponent.GetMinFuzeTime ( )
Returns

◆ GetNumberOfChargeRingConfigurations()

int SCR_MortarShellGadgetComponent.GetNumberOfChargeRingConfigurations ( )
Returns

◆ GetOnShellUsed()

ScriptInvokerVoid SCR_MortarShellGadgetComponent.GetOnShellUsed ( )
Returns

◆ GetPrefabInitSpeedCoef()

static array< float > SCR_MortarShellGadgetComponent.GetPrefabInitSpeedCoef ( ResourceName resourceName,
out int defaultConfigId )
static

Extracts the information about available init speed coef from resource name.

Parameters
[in]resourceNameprefab from data will be extracted
[out]defaultConfigIdid of the entry which is the default init speed coef
Returns
array containing all available init speed coef for this prefab

◆ GetSavedConfig()

SCR_ShellConfig SCR_MortarShellGadgetComponent.GetSavedConfig ( notnull ChimeraCharacter character)

Retrieves locally saved data about manual adjustment of the fuze that player set for this shell type.

◆ GetTimeToDetonation()

float SCR_MortarShellGadgetComponent.GetTimeToDetonation ( float angle,
bool isDirectFire )

Retrieves information about the time of flight for this shell prefab.

◆ GetType()

override EGadgetType SCR_MortarShellGadgetComponent.GetType ( )

Get gadget type.

Returns
Returns gadget type

Implements SCR_GadgetComponent.

◆ IsLoaded()

bool SCR_MortarShellGadgetComponent.IsLoaded ( )
Returns

◆ IsUsingTimeFuze()

bool SCR_MortarShellGadgetComponent.IsUsingTimeFuze ( )
Returns

◆ IsVisibleEquipped()

override bool SCR_MortarShellGadgetComponent.IsVisibleEquipped ( )

Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.

Returns
Returns true if visible in equipment slot

Implements SCR_GadgetComponent.

◆ ModeSwitch()

override void SCR_MortarShellGadgetComponent.ModeSwitch ( EGadgetMode mode,
IEntity charOwner )
protected

Set gadget mode.

Parameters
[in]modeis the target mode being switched to
[in]charOwner

Implements SCR_GadgetComponent.

◆ OnChargeRingReplicated()

void SCR_MortarShellGadgetComponent.OnChargeRingReplicated ( )
protected

Callback method that will be triggered when m_iChargeRingConfigIndex is bumped for replication.

◆ OnShellFired()

void SCR_MortarShellGadgetComponent.OnShellFired ( notnull BaseMuzzleComponent muzzle)

Method that is meant to be called when it is firred from a mortar.

Parameters
[in]muzzledfrom which this shell was fired

◆ OnToggleActive()

override void SCR_MortarShellGadgetComponent.OnToggleActive ( bool state)

Event called from SCR_GadgetManagerComponent through RPC request.

Parameters
[in]stateis gadget state: true - active / false - inactive

Implements SCR_GadgetComponent.

◆ RplLoad()

override bool SCR_MortarShellGadgetComponent.RplLoad ( ScriptBitReader reader)

Implements SCR_GadgetComponent.

◆ RplSave()

override bool SCR_MortarShellGadgetComponent.RplSave ( ScriptBitWriter writer)

Implements SCR_GadgetComponent.

◆ SetChargeRingConfig()

void SCR_MortarShellGadgetComponent.SetChargeRingConfig ( int configId,
bool silent = false,
bool replicate = true )

Sets the number of charge rings that are going to be used to fire this projectile.

Parameters
[in]configIdid of the config that is going ot be used by the projectile
[in]silentdetermines if audio should be played
[in]replicatedetermines if it should attempt to replicate change to the currently selected charge ring config - this can only be done by the owner

◆ SetFuzeTime()

void SCR_MortarShellGadgetComponent.SetFuzeTime ( float time)
Parameters
[in]time

◆ SetLoadedState()

bool SCR_MortarShellGadgetComponent.SetLoadedState ( bool state,
SCR_MortarMuzzleComponent mortarMuzzle = null,
string fireActionName = "",
IEntity user = null )
Parameters
[in]stateif shell should be locked and
[in]mortarMuzzlemuzzle from which mortar this shell is going to be fired
[in]fireActionNamename of the input action for which game should wait with transfering the item to mortar inventory
[in]userone who loads the shell
Returns
true if caller should wait for user to activate the gadget

◆ UseShellCB()

void SCR_MortarShellGadgetComponent.UseShellCB ( )
protected

Callback used to tell if user wants to fire the shell now.

◆ VisualiseChargeRings()

void SCR_MortarShellGadgetComponent.VisualiseChargeRings ( int numberOfChargeRings)
protected

Shows or hides charge ring visualiastion that are defined in prefab slot manager.

Parameters
[in]numberOfChargeRingsdetermines how many charge rings should be visible

Member Data Documentation

◆ CHARGE_RING_CONFIG_MEMBER_NAME

const string SCR_MortarShellGadgetComponent.CHARGE_RING_CONFIG_MEMBER_NAME = "m_aChargeRingConfig"
staticprotected

◆ m_aChargeRingConfig

ref array<vector> SCR_MortarShellGadgetComponent.m_aChargeRingConfig
protected

◆ m_bCustomChargeRingSet

bool SCR_MortarShellGadgetComponent.m_bCustomChargeRingSet
protected

◆ m_bCustomFuzeTimeSet

bool SCR_MortarShellGadgetComponent.m_bCustomFuzeTimeSet
protected

◆ m_bIsUsingTimeFuze

bool SCR_MortarShellGadgetComponent.m_bIsUsingTimeFuze
protected

◆ m_fDetonationAltitude

float SCR_MortarShellGadgetComponent.m_fDetonationAltitude
protected

◆ m_fFuzeTime

float SCR_MortarShellGadgetComponent.m_fFuzeTime
protected

◆ m_fMaxFuzeTime

float SCR_MortarShellGadgetComponent.m_fMaxFuzeTime
protected

◆ m_fMinFuzeTime

float SCR_MortarShellGadgetComponent.m_fMinFuzeTime
protected

◆ m_fVerticalImpactTimeOffset

float SCR_MortarShellGadgetComponent.m_fVerticalImpactTimeOffset
protected

◆ m_iChargeRingConfigIndex

int SCR_MortarShellGadgetComponent.m_iChargeRingConfigIndex
protected

◆ m_MortarMuzzleComp

SCR_MortarMuzzleComponent SCR_MortarShellGadgetComponent.m_MortarMuzzleComp
protected

◆ m_OnShellUsed

ref ScriptInvokerVoid SCR_MortarShellGadgetComponent.m_OnShellUsed
protected

◆ m_SlotManagerComp

SlotManagerComponent SCR_MortarShellGadgetComponent.m_SlotManagerComp
protected

◆ m_sRegisteredActionName

string SCR_MortarShellGadgetComponent.m_sRegisteredActionName
protected

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