Arma Reforger Script API
|
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) |
![]() | |
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) |
![]() | |
void | ModeClear (EGadgetMode mode) |
Clear gadget mode. | |
void | ConnectToGadgetsSystem () |
Starts on frame update event. | |
void | DisconnectFromGadgetsSystem () |
![]() | |
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 |
![]() | |
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 | |
![]() | |
bool | m_bFocused |
override bool SCR_MortarShellGadgetComponent.CanBeRaised | ( | ) |
Gadget has a raised animation version.
Implements SCR_GadgetComponent.
|
protected |
int SCR_MortarShellGadgetComponent.FindDefaultChargeRingConfig | ( | ) |
Searches for the first charge ring config that is marked as default.
vector SCR_MortarShellGadgetComponent.GetChargeRingConfig | ( | int | id | ) |
vector SCR_MortarShellGadgetComponent.GetCurentChargeRingConfig | ( | ) |
int SCR_MortarShellGadgetComponent.GetCurentChargeRingConfigId | ( | ) |
float SCR_MortarShellGadgetComponent.GetDetonationAltitude | ( | ) |
float SCR_MortarShellGadgetComponent.GetFuzeTime | ( | ) |
float SCR_MortarShellGadgetComponent.GetMaxFuzeTime | ( | ) |
float SCR_MortarShellGadgetComponent.GetMinFuzeTime | ( | ) |
int SCR_MortarShellGadgetComponent.GetNumberOfChargeRingConfigurations | ( | ) |
ScriptInvokerVoid SCR_MortarShellGadgetComponent.GetOnShellUsed | ( | ) |
|
static |
Extracts the information about available init speed coef from resource name.
[in] | resourceName | prefab from data will be extracted |
[out] | defaultConfigId | id of the entry which is the default init speed coef |
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.
float SCR_MortarShellGadgetComponent.GetTimeToDetonation | ( | float | angle, |
bool | isDirectFire ) |
Retrieves information about the time of flight for this shell prefab.
override EGadgetType SCR_MortarShellGadgetComponent.GetType | ( | ) |
bool SCR_MortarShellGadgetComponent.IsLoaded | ( | ) |
bool SCR_MortarShellGadgetComponent.IsUsingTimeFuze | ( | ) |
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.
Implements SCR_GadgetComponent.
|
protected |
Set gadget mode.
[in] | mode | is the target mode being switched to |
[in] | charOwner |
Implements SCR_GadgetComponent.
|
protected |
Callback method that will be triggered when m_iChargeRingConfigIndex is bumped for replication.
void SCR_MortarShellGadgetComponent.OnShellFired | ( | notnull BaseMuzzleComponent | muzzle | ) |
Method that is meant to be called when it is firred from a mortar.
[in] | muzzle | dfrom which this shell was fired |
override void SCR_MortarShellGadgetComponent.OnToggleActive | ( | bool | state | ) |
Event called from SCR_GadgetManagerComponent through RPC request.
[in] | state | is gadget state: true - active / false - inactive |
Implements SCR_GadgetComponent.
override bool SCR_MortarShellGadgetComponent.RplLoad | ( | ScriptBitReader | reader | ) |
Implements SCR_GadgetComponent.
override bool SCR_MortarShellGadgetComponent.RplSave | ( | ScriptBitWriter | writer | ) |
Implements SCR_GadgetComponent.
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.
[in] | configId | id of the config that is going ot be used by the projectile |
[in] | silent | determines if audio should be played |
[in] | replicate | determines if it should attempt to replicate change to the currently selected charge ring config - this can only be done by the owner |
void SCR_MortarShellGadgetComponent.SetFuzeTime | ( | float | time | ) |
[in] | time |
bool SCR_MortarShellGadgetComponent.SetLoadedState | ( | bool | state, |
SCR_MortarMuzzleComponent | mortarMuzzle = null, | ||
string | fireActionName = "", | ||
IEntity | user = null ) |
[in] | state | if shell should be locked and |
[in] | mortarMuzzle | muzzle from which mortar this shell is going to be fired |
[in] | fireActionName | name of the input action for which game should wait with transfering the item to mortar inventory |
[in] | user | one who loads the shell |
|
protected |
Callback used to tell if user wants to fire the shell now.
|
protected |
Shows or hides charge ring visualiastion that are defined in prefab slot manager.
[in] | numberOfChargeRings | determines how many charge rings should be visible |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |