Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_BallisticTableDisplay Interface Reference
Inheritance diagram for SCR_BallisticTableDisplay:
SCR_InfoDisplayExtended SCR_InfoDisplay GroupInfoDisplay BaseInfoDisplay

Public Member Functions

SCR_BaseBallisticConfig GetSelectedBallisticConfig ()
 
int GetNumberOfBallisticConfigs ()
 
bool GetHasDifferentChargeConfigs ()
 Returns true when this display has at least two configs for the same shell with different init speeds.
 
void ChangeShellType (float direction=0)
 Method used to change what ballistic data is shown.
 
void ChangeShellCharge (float direction=0)
 Method used to change what charge ring config is shown for current shell type.
 
override void Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
 Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.
 
override void DisplayUpdate (IEntity owner, float timeSlice)
 
override void DisplayStopDraw (IEntity owner)
 
override void DisplayStartDraw (IEntity owner)
 
- Public Member Functions inherited from SCR_InfoDisplayExtended
void SetEnabled (bool isEnabled)
 
- Public Member Functions inherited from SCR_InfoDisplay
SCR_InfoDisplayHandler GetHandler (TypeName handlerType)
 
SCR_InfoDisplayInvoker GetOnStart ()
 
SCR_InfoDisplayInvoker GetOnStop ()
 
IEntity GetOwnerEntity ()
 
Widget GetContentWidget ()
 
string GetContentWidgetName ()
 
void SetRootWidget (notnull Widget root)
 
void SetContentWidget (notnull Widget content)
 
bool IsShown ()
 
Widget GetRootWidget ()
 
bool GetDimensions (out float width, out float height, bool addSafezones=true)
 Get width and height of the InfoDisplay element, optionally with safezones adjustments.
 
bool GetAnchorPosition (out float x, out float y, EWidgetAnchor anchor=EWidgetAnchor.TOPLEFT, bool addSafezones=true)
 Get width and height of the InfoDisplay element, optionally with safezones adjustments.
 
void RegisterToHudManager ()
 
- Public Member Functions inherited from GroupInfoDisplay
proto external int GetInfoDisplays (out notnull array< BaseInfoDisplay > outInfoDisplays)
 
- Public Member Functions inherited from BaseInfoDisplay
proto external GenericComponent FindComponentInParentContainer (TypeName typeName)
 

Protected Member Functions

void UpdateConfig (bool playSound=true)
 Method used to update currently displayed ballistic config.
 
array< string > GetBallisticInfo (float elevation)
 Set azimuth and elevation info.
 
void UpdateBallisticInfo (vector aimRotation)
 
vector GetMuzzleDirection ()
 Get muzzle rotation vector.
 
void SetupWidgets ()
 
void ShowDelay (bool show, float speed=UIConstants.FADE_RATE_INSTANT)
 Calls the SCR_InfoDisplayExtended.Show method after some delay.
 
override void OnSettingsChanged ()
 
void AddActionListeners ()
 
void RemoveActionListeners ()
 
- Protected Member Functions inherited from SCR_InfoDisplayExtended
bool DisplayStartDrawInit (IEntity owner)
 
void DisplayInit (IEntity owner)
 
void DisplayControlledEntityChanged (IEntity from, IEntity to)
 
void DisplayConsciousnessChanged (bool conscious, bool init=false)
 
void DisplayOnSuspended ()
 Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.
 
void DisplayOnResumed ()
 
void InitializeInterfaceSettings ()
 
- Protected Member Functions inherited from SCR_InfoDisplay
void OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)
 
void AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)
 

Protected Attributes

ref array< string > m_aRangeListWidgetNames
 
int m_iBallisticDataOffset
 
ref array< ref SCR_BaseBallisticConfigm_aBallisticConfigs
 
string m_sShellNameTextWidgetName
 
string m_sShellTypeIconWidgetName
 
string m_sRangeTextFormat
 
float m_fFadeInDelay
 
string m_sChangeShellTypeActionName
 
string m_sChangeShellChargeActionName
 
TextWidget m_wShellNameTextWidget
 
ImageWidget m_wAmmoTypeIcon
 
ref array< TextWidget > m_aRangeListWidgets = {}
 
TurretControllerComponent m_TurretController
 
bool m_bHasDifferentChargeRingConfigs
 
float m_fTopElevationThreshold = -1
 
float m_fBottomElevationThreshold = -1
 
int m_iSelectedBallisticConfig
 
SCR_AdditionalGameModeSettingsComponent m_AdditionalGameSettings
 
- Protected Attributes inherited from SCR_InfoDisplayExtended
bool m_bIsEnabled
 
string m_sInterfaceSettingName
 
SCR_PlayerController m_PlayerController
 
SCR_CharacterControllerComponent m_CharacterController
 
SCR_CharacterCameraHandlerComponent m_CameraHandler
 
MenuManager m_MenuManager
 
EventHandlerManagerComponent m_EventHandlerManager
 
SCR_EditorManagerEntity m_EditorManager
 
bool m_bAttachedToPlayerController
 
bool m_bInThirdPerson
 
bool m_bInADS
 
bool m_bIsUnconscious
 
bool m_bInPauseMenu
 
bool m_bInEditor
 
bool m_bCanShow
 
bool m_bIsEnabledInSettings = true
 
bool m_bShowInAllCameras = true
 
- Protected Attributes inherited from SCR_InfoDisplay
string m_sParentSlot
 
string m_sContentWidget
 
int m_iContentWidthAdjustment
 
int m_iContentHeightAdjustment
 
string m_sAdaptiveOpacityWidgetName
 
ref array< ref SCR_InfoDisplayHandlerm_aHandlers
 
bool m_bShown
 
Widget m_wRoot
 
Widget m_wContent
 
Widget m_wSlot
 
SCR_HUDManagerComponent m_HUDManager
 
int m_iChildDisplays = 0
 
ref array< BaseInfoDisplaym_aChildDisplays = new array<BaseInfoDisplay>
 
SCR_InfoDisplay m_pParentDisplay
 
bool m_bRegistered = false
 
IEntity m_OwnerEntity
 
ref array< ref SCR_InfoDisplayHandlerm_aUpdatableHandlers = {}
 
ref SCR_InfoDisplayInvoker m_OnStart = new SCR_InfoDisplayInvoker()
 
ref SCR_InfoDisplayInvoker m_OnStop = new SCR_InfoDisplayInvoker()
 

Static Protected Attributes

const string TEXT_EMPTY = "-"
 

Additional Inherited Members

- Public Attributes inherited from SCR_InfoDisplay
ResourceName m_LayoutPath
 
EHudLayers m_eLayer
 
int m_iOverrideZOrder
 

Member Function Documentation

◆ AddActionListeners()

void SCR_BallisticTableDisplay.AddActionListeners ( )
protected

◆ ChangeShellCharge()

void SCR_BallisticTableDisplay.ChangeShellCharge ( float direction = 0)

Method used to change what charge ring config is shown for current shell type.

◆ ChangeShellType()

void SCR_BallisticTableDisplay.ChangeShellType ( float direction = 0)

Method used to change what ballistic data is shown.

◆ DisplayStartDraw()

override void SCR_BallisticTableDisplay.DisplayStartDraw ( IEntity owner)

◆ DisplayStopDraw()

override void SCR_BallisticTableDisplay.DisplayStopDraw ( IEntity owner)

◆ DisplayUpdate()

override void SCR_BallisticTableDisplay.DisplayUpdate ( IEntity owner,
float timeSlice )

◆ GetBallisticInfo()

array< string > SCR_BallisticTableDisplay.GetBallisticInfo ( float elevation)
protected

Set azimuth and elevation info.

◆ GetHasDifferentChargeConfigs()

bool SCR_BallisticTableDisplay.GetHasDifferentChargeConfigs ( )

Returns true when this display has at least two configs for the same shell with different init speeds.

◆ GetMuzzleDirection()

vector SCR_BallisticTableDisplay.GetMuzzleDirection ( )
protected

Get muzzle rotation vector.

◆ GetNumberOfBallisticConfigs()

int SCR_BallisticTableDisplay.GetNumberOfBallisticConfigs ( )

◆ GetSelectedBallisticConfig()

SCR_BaseBallisticConfig SCR_BallisticTableDisplay.GetSelectedBallisticConfig ( )

◆ OnSettingsChanged()

override void SCR_BallisticTableDisplay.OnSettingsChanged ( )
protected

◆ RemoveActionListeners()

void SCR_BallisticTableDisplay.RemoveActionListeners ( )
protected

◆ SetupWidgets()

void SCR_BallisticTableDisplay.SetupWidgets ( )
protected

◆ Show()

override void SCR_BallisticTableDisplay.Show ( bool show,
float speed = UIConstants::FADE_RATE_INSTANT,
EAnimationCurve curve = EAnimationCurve::LINEAR )

Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.

Use this method instead of SetVisible/SetOpacity.

Parameters
showtrue to show, false to hide
speedfade rate, default 0
curvehiding interpolation, default linear

Implements SCR_InfoDisplayExtended.

◆ ShowDelay()

void SCR_BallisticTableDisplay.ShowDelay ( bool show,
float speed = UIConstants::FADE_RATE_INSTANT )
protected

Calls the SCR_InfoDisplayExtended.Show method after some delay.

Parameters
[in]bool,Trueif it can be shown, false otherwise
[in]float,Fadespeed

◆ UpdateBallisticInfo()

void SCR_BallisticTableDisplay.UpdateBallisticInfo ( vector aimRotation)
protected

◆ UpdateConfig()

void SCR_BallisticTableDisplay.UpdateConfig ( bool playSound = true)
protected

Method used to update currently displayed ballistic config.

Member Data Documentation

◆ m_aBallisticConfigs

ref array<ref SCR_BaseBallisticConfig> SCR_BallisticTableDisplay.m_aBallisticConfigs
protected

◆ m_AdditionalGameSettings

SCR_AdditionalGameModeSettingsComponent SCR_BallisticTableDisplay.m_AdditionalGameSettings
protected

◆ m_aRangeListWidgetNames

ref array<string> SCR_BallisticTableDisplay.m_aRangeListWidgetNames
protected

◆ m_aRangeListWidgets

ref array<TextWidget> SCR_BallisticTableDisplay.m_aRangeListWidgets = {}
protected

◆ m_bHasDifferentChargeRingConfigs

bool SCR_BallisticTableDisplay.m_bHasDifferentChargeRingConfigs
protected

◆ m_fBottomElevationThreshold

float SCR_BallisticTableDisplay.m_fBottomElevationThreshold = -1
protected

◆ m_fFadeInDelay

float SCR_BallisticTableDisplay.m_fFadeInDelay
protected

◆ m_fTopElevationThreshold

float SCR_BallisticTableDisplay.m_fTopElevationThreshold = -1
protected

◆ m_iBallisticDataOffset

int SCR_BallisticTableDisplay.m_iBallisticDataOffset
protected

◆ m_iSelectedBallisticConfig

int SCR_BallisticTableDisplay.m_iSelectedBallisticConfig
protected

◆ m_sChangeShellChargeActionName

string SCR_BallisticTableDisplay.m_sChangeShellChargeActionName
protected

◆ m_sChangeShellTypeActionName

string SCR_BallisticTableDisplay.m_sChangeShellTypeActionName
protected

◆ m_sRangeTextFormat

string SCR_BallisticTableDisplay.m_sRangeTextFormat
protected

◆ m_sShellNameTextWidgetName

string SCR_BallisticTableDisplay.m_sShellNameTextWidgetName
protected

◆ m_sShellTypeIconWidgetName

string SCR_BallisticTableDisplay.m_sShellTypeIconWidgetName
protected

◆ m_TurretController

TurretControllerComponent SCR_BallisticTableDisplay.m_TurretController
protected

◆ m_wAmmoTypeIcon

ImageWidget SCR_BallisticTableDisplay.m_wAmmoTypeIcon
protected

◆ m_wShellNameTextWidget

TextWidget SCR_BallisticTableDisplay.m_wShellNameTextWidget
protected

◆ TEXT_EMPTY

const string SCR_BallisticTableDisplay.TEXT_EMPTY = "-"
staticprotected

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