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

Public Member Functions

int GetNumberOfPages ()
 
void ChangePage (int direction=0)
 Interface for changing pages that are being displayed.
 
void ChangeShellType (int direction=0)
 Interface for changing page to a different shell type.
 
void ClearBallisticData ()
 Clears the content of the ROW_HOLDER_NAME from any non STATIC elements F.e.
 
override EGadgetType GetType ()
 Get gadget type.
 
override void EOnInit (IEntity owner)
 
override void OnDelete (IEntity owner)
 
void RpcDo_SyncPageChange (int selectedPage)
 Authority method for replicating change of currently displayed page.
 
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 OnToggleActive (bool state)
 Event called from SCR_GadgetManagerComponent through RPC request.
 
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 CanBeRaised ()
 Gadget has a raised animation version.
 
bool IsUsingADSControls ()
 Gadget uses ADS controls from gadget raisable context.
 
bool IsVisibleEquipped ()
 Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.
 
void Update (float timeSlice)
 
override void OnPostInit (IEntity owner)
 

Public Attributes

int m_iOpacityMapId
 
- Public Attributes inherited from SCR_GadgetComponent
bool m_bFocused
 

Protected Member Functions

void UpdateData ()
 Method used to update currently displayed ballistic data.
 
void LoadBallisticData ()
 Method used to add widgets with ballistic data for currently selected page.
 
Widget AddRow (notnull Widget parentWidget, int rowID=0)
 Meant to add a single row.
 
Widget AddCell (notnull Widget parentWidget, string text, int columnID=0)
 Meant to add a single cell.
 
override void ModeSwitch (EGadgetMode mode, IEntity charOwner)
 Set gadget mode.
 
override void ModeClear (EGadgetMode mode)
 Clear gadget mode.
 
void ClearRenderTarget ()
 
- Protected Member Functions inherited from SCR_GadgetComponent
void ConnectToGadgetsSystem ()
 Starts on frame update event.
 
void DisconnectFromGadgetsSystem ()
 
- Protected Member Functions inherited from ScriptGameComponent
bool OnTicksOnRemoteProxy ()
 

Protected Attributes

RTTextureWidget m_wRenderTargetTexture Widget m_wRootWidget
 
int m_iNumberOfPages
 
int m_iCurrentPageID
 
- 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

const string EMPTY_CELL_TEXT = "-"
 
const string ROW_HOLDER_NAME = "ContentLayout"
 
const string CONTENT_HOLDER_NAME = "ContentHolder"
 
const string CONTENT_LABEL_NAME = "Label"
 
const string TITLE_LABEL_NAME = "Title"
 
const string AMMO_TYPE_NAME = "AmmoTypeIcon"
 
const string PAGE_NUMBER_NAME = "PageNumber"
 
const string DISPERSION_VALUE_CONTAINER_NAME = "DispersionValue"
 
const string PAGE_NUMBER_FORMAT = "%1 / %2"
 
const string STATIC_WIDGET_INDICATOR = "STATIC"
 

Member Function Documentation

◆ AddCell()

Widget SCR_BallisticTableComponent.AddCell ( notnull Widget parentWidget,
string text,
int columnID = 0 )
protected

Meant to add a single cell.

◆ AddRow()

Widget SCR_BallisticTableComponent.AddRow ( notnull Widget parentWidget,
int rowID = 0 )
protected

Meant to add a single row.

◆ ChangePage()

void SCR_BallisticTableComponent.ChangePage ( int direction = 0)

Interface for changing pages that are being displayed.

Parameters
[in]direction-1 == previous | +1 == next

◆ ChangeShellType()

void SCR_BallisticTableComponent.ChangeShellType ( int direction = 0)

Interface for changing page to a different shell type.

Parameters
[in]direction-1 == previous | +1 == next

◆ ClearBallisticData()

void SCR_BallisticTableComponent.ClearBallisticData ( )

Clears the content of the ROW_HOLDER_NAME from any non STATIC elements F.e.

to be used when we will want to load different data when we change page

◆ ClearRenderTarget()

void SCR_BallisticTableComponent.ClearRenderTarget ( )
protected

◆ EOnInit()

override void SCR_BallisticTableComponent.EOnInit ( IEntity owner)

◆ GetNumberOfPages()

int SCR_BallisticTableComponent.GetNumberOfPages ( )
Returns

◆ GetType()

override EGadgetType SCR_BallisticTableComponent.GetType ( )

Get gadget type.

Returns
Returns gadget type

Implements SCR_GadgetComponent.

◆ LoadBallisticData()

void SCR_BallisticTableComponent.LoadBallisticData ( )
protected

Method used to add widgets with ballistic data for currently selected page.

◆ ModeClear()

override void SCR_BallisticTableComponent.ModeClear ( EGadgetMode mode)
protected

Clear gadget mode.

Parameters
[in]modeis the mode being cleared

Implements SCR_GadgetComponent.

◆ ModeSwitch()

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

Set gadget mode.

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

Implements SCR_GadgetComponent.

◆ OnDelete()

override void SCR_BallisticTableComponent.OnDelete ( IEntity owner)

Implements SCR_GadgetComponent.

◆ RpcDo_SyncPageChange()

void SCR_BallisticTableComponent.RpcDo_SyncPageChange ( int selectedPage)

Authority method for replicating change of currently displayed page.

Parameters
[in]selectedPageid of newly displayed page

◆ RplLoad()

override bool SCR_BallisticTableComponent.RplLoad ( ScriptBitReader reader)

Implements SCR_GadgetComponent.

◆ RplSave()

override bool SCR_BallisticTableComponent.RplSave ( ScriptBitWriter writer)

Implements SCR_GadgetComponent.

◆ UpdateData()

void SCR_BallisticTableComponent.UpdateData ( )
protected

Method used to update currently displayed ballistic data.

Member Data Documentation

◆ AMMO_TYPE_NAME

const string SCR_BallisticTableComponent.AMMO_TYPE_NAME = "AmmoTypeIcon"
staticprotected

◆ CONTENT_HOLDER_NAME

const string SCR_BallisticTableComponent.CONTENT_HOLDER_NAME = "ContentHolder"
staticprotected

◆ CONTENT_LABEL_NAME

const string SCR_BallisticTableComponent.CONTENT_LABEL_NAME = "Label"
staticprotected

◆ DISPERSION_VALUE_CONTAINER_NAME

const string SCR_BallisticTableComponent.DISPERSION_VALUE_CONTAINER_NAME = "DispersionValue"
staticprotected

◆ EMPTY_CELL_TEXT

const string SCR_BallisticTableComponent.EMPTY_CELL_TEXT = "-"
staticprotected

◆ m_iCurrentPageID

int SCR_BallisticTableComponent.m_iCurrentPageID
protected

◆ m_iNumberOfPages

int SCR_BallisticTableComponent.m_iNumberOfPages
protected

◆ m_iOpacityMapId

int SCR_BallisticTableComponent.m_iOpacityMapId

◆ m_wRootWidget

RTTextureWidget m_wRenderTargetTexture Widget SCR_BallisticTableComponent.m_wRootWidget
protected

◆ PAGE_NUMBER_FORMAT

const string SCR_BallisticTableComponent.PAGE_NUMBER_FORMAT = "%1 / %2"
staticprotected

◆ PAGE_NUMBER_NAME

const string SCR_BallisticTableComponent.PAGE_NUMBER_NAME = "PageNumber"
staticprotected

◆ ROW_HOLDER_NAME

const string SCR_BallisticTableComponent.ROW_HOLDER_NAME = "ContentLayout"
staticprotected

◆ STATIC_WIDGET_INDICATOR

const string SCR_BallisticTableComponent.STATIC_WIDGET_INDICATOR = "STATIC"
staticprotected

◆ TITLE_LABEL_NAME

const string SCR_BallisticTableComponent.TITLE_LABEL_NAME = "Title"
staticprotected

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