Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
SCR_2DOpticsDisplay Interface Reference
Inheritance diagram for SCR_2DOpticsDisplay:
[legend]

Public Member Functions

void SetupOpticImage ()
 Setup images and right texture sizing.
 
void UpdateCurrentFov (bool forceUpdate=false)
 
void UpdateReticleSize ()
 Setup images and right texture sizing.
 
void GetOpticData ()
 Get optic data for quick retrieval later.
 
void UpdateScale (float reticleScale, float vignetteScale, float objectiveScale)
 Update widget sizes according to the screen height and DPI scale.
 
void SetReticleOffset (float x, float y)
 Change reticle texture position with angular offset.
 
- Public Member Functions inherited from SCR_InfoDisplayExtended
void SetEnabled (bool isEnabled)
 
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.
 
- 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)
 
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.
 
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)
 

Static Public Attributes

const string WIDGET_LAYOUT_REAR = "HRearEyePiece"
 
const string WIDGET_LAYOUT_FRONT = "HFrontObjective"
 
const string WIDGET_IMAGE_COVER = "ImgCover"
 
const string WIDGET_SIZE_REAR = "SizeRear"
 
const string WIDGET_SIZE_OBJECTIVE = "SizeFrontObjective"
 
const string WIDGET_IMAGE_PADDING_LEFT = "ImgPaddingLeft"
 
const string WIDGET_IMAGE_PADDING_RIGHT = "ImgPaddingRight"
 
const string WIDGET_IMAGE_PADDING_TOP = "ImgPaddingTop"
 
const string WIDGET_IMAGE_PADDING_BOTTOM = "ImgPaddingBottom"
 
const string WIDGET_OVERLAY_RETICLES = "OverlayReticles"
 
const string WIDGET_IMAGE_RETICLE = "ImgReticle"
 
const string WIDGET_IMAGE_RETICLE_GLOW = "ImgReticleGlow"
 
const string WIDGET_IMAGE_VIGNETTE = "ImgVignette"
 
const string WIDGET_IMAGE_SCRATCHES = "ImgScratches"
 
const string WIDGET_BLUR = "Blur"
 
const string WIDGET_IMAGE_FILTER = "ImgFilter"
 
const string WIDGET_SIZE_LEFT = "SizePaddingLeft"
 
const string WIDGET_SIZE_TOP = "SizePaddingTop"
 
const float OPACITY_INITIAL = 0.75
 

Protected Member Functions

void OnLayoutChanged (SCR_HUDLayout newLayout, SCR_HUDLayout oldLayout, SCR_HUDManagerComponent hudManager)
 
override void DisplayStartDraw (IEntity owner)
 
override void DisplayStopDraw (IEntity owner)
 
override void DisplayUpdate (IEntity owner, float timeSlice)
 
void FindWidgets ()
 Find widget refences.
 
void OnADSChange (notnull SCR_2DOpticsComponent comp, bool inADS)
 
void Activate ()
 
void Deactivate ()
 Stop any running animation for entering Scope and disable the layout after some delay.
 
void PlayEntryAnimation (float animationSpeed)
 Start optics entring animation.
 
void DeactivateWidget ()
 Open optics hud with animation delay.
 
void LowerBlurIntensity (float timeSlice, float speed)
 Bring down lens blur intensity in steps.
 
void ChangeReticleTint (Color color, Color colorGlow)
 Change color of Reticle Image.
 
void MoveScopeWidgets (float timeSlice)
 Apply result movement to scope widgets.
 
void MotionBlur (float posX, float posY)
 
float VignetteDefaultPosition (float screenSize, float vignetteSize)
 
- Protected Member Functions inherited from SCR_InfoDisplayExtended
bool DisplayStartDrawInit (IEntity owner)
 
void DisplayStartDraw (IEntity owner)
 
void DisplayStopDraw (IEntity owner)
 
void DisplayInit (IEntity owner)
 
void DisplayUpdate (IEntity owner, float timeSlice)
 
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 ()
 
void OnSettingsChanged ()
 
- Protected Member Functions inherited from SCR_InfoDisplay
void OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)
 
override void OnStartDraw (IEntity owner)
 
void AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)
 
override void OnStopDraw (IEntity owner)
 
override void UpdateValues (IEntity owner, float timeSlice)
 
override void OnInit (IEntity owner)
 
void OnInit (IEntity owner)
 
void UpdateValues (IEntity owner, float timeSlice)
 
void OnStartDraw (IEntity owner)
 
void OnStopDraw (IEntity owner)
 

Protected Attributes

bool m_bActivated
 
SCR_2DOpticsComponent m_Optic
 
ResourceName m_sReticleTexture
 
ResourceName m_sReticleGlowTexture
 
ResourceName m_sFilterTexture
 
float m_fOpticBaseFov
 
float m_fOpticCurrentFov
 
float m_fReticleSize
 
float m_fReticleAngularSize
 
float m_fReticlePortion
 
float m_fReticleBaseZoom
 
float m_fReticleOffsetX
 
float m_fReticleOffsetY
 
float m_fVignetteScale
 
float m_fVignetteSize
 
float m_fVignetteMoveSpeed
 
float m_fObjectiveFov
 
float m_fObjectiveScale
 
float m_fObjectiveSize
 
float m_fMisalignmentScale
 
float m_fMisalignmentDampingSpeed
 
float m_fRotationScale
 
float m_fRotationDampingSpeed
 
float m_fMovementScale
 
float m_fMovementDampingSpeed
 
float m_fRollScale
 
float m_fRollDampingSpeed
 
float m_fRollOffset
 
vector m_vMisalignmentOffset
 
vector m_vObjectiveOffset
 
vector m_vVignetteOffset
 
vector m_vRotation
 
vector m_vRotationSpeed
 
vector m_vRotationOffset
 
vector m_vMovement
 
vector m_vMovementSpeed
 
vector m_vMovementOffset
 
bool m_bInitialBlurOver
 
Widget m_wLayoutRear
 
Widget m_wLayoutFront
 
ImageWidget m_wImgCover
 
ImageWidget m_wImgScratches
 
Widget m_wOverlayReticles
 
ImageWidget m_wImgReticle
 
ImageWidget m_wImgReticleGlow
 
BlurWidget m_wBlur
 
ImageWidget m_wImgFilter
 
SizeLayoutWidget m_wRearFillLeft
 
SizeLayoutWidget m_wRearFillTop
 
SizeLayoutWidget m_wFrontFillLeft
 
SizeLayoutWidget m_wFrontFillTop
 
SizeLayoutWidget m_wSizeLayoutRear
 
SizeLayoutWidget m_wSizeLayoutObjective
 
- 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()
 

Additional Inherited Members

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

Member Function Documentation

◆ Activate()

void SCR_2DOpticsDisplay.Activate ( )
protected

◆ ChangeReticleTint()

void SCR_2DOpticsDisplay.ChangeReticleTint ( Color  color,
Color  colorGlow 
)
protected

Change color of Reticle Image.

Parameters
color
colorGlow

◆ Deactivate()

void SCR_2DOpticsDisplay.Deactivate ( )
protected

Stop any running animation for entering Scope and disable the layout after some delay.

◆ DeactivateWidget()

void SCR_2DOpticsDisplay.DeactivateWidget ( )
protected

Open optics hud with animation delay.

◆ DisplayStartDraw()

override void SCR_2DOpticsDisplay.DisplayStartDraw ( IEntity  owner)
protected

◆ DisplayStopDraw()

override void SCR_2DOpticsDisplay.DisplayStopDraw ( IEntity  owner)
protected

◆ DisplayUpdate()

override void SCR_2DOpticsDisplay.DisplayUpdate ( IEntity  owner,
float  timeSlice 
)
protected

◆ FindWidgets()

void SCR_2DOpticsDisplay.FindWidgets ( )
protected

Find widget refences.

◆ GetOpticData()

void SCR_2DOpticsDisplay.GetOpticData ( )

Get optic data for quick retrieval later.

◆ LowerBlurIntensity()

void SCR_2DOpticsDisplay.LowerBlurIntensity ( float  timeSlice,
float  speed 
)
protected

Bring down lens blur intensity in steps.

Parameters
timeSlice
speed

◆ MotionBlur()

void SCR_2DOpticsDisplay.MotionBlur ( float  posX,
float  posY 
)
protected

◆ MoveScopeWidgets()

void SCR_2DOpticsDisplay.MoveScopeWidgets ( float  timeSlice)
protected

Apply result movement to scope widgets.

◆ OnADSChange()

void SCR_2DOpticsDisplay.OnADSChange ( notnull SCR_2DOpticsComponent  comp,
bool  inADS 
)
protected

◆ OnLayoutChanged()

void SCR_2DOpticsDisplay.OnLayoutChanged ( SCR_HUDLayout  newLayout,
SCR_HUDLayout  oldLayout,
SCR_HUDManagerComponent  hudManager 
)
protected

◆ PlayEntryAnimation()

void SCR_2DOpticsDisplay.PlayEntryAnimation ( float  animationSpeed)
protected

Start optics entring animation.

Parameters
animationSpeed

◆ SetReticleOffset()

void SCR_2DOpticsDisplay.SetReticleOffset ( float  x,
float  y 
)

Change reticle texture position with angular offset.

Parameters
xx-axis offset value left (-) / right (+)
yy-axis offset value down (-) / up (+)

◆ SetupOpticImage()

void SCR_2DOpticsDisplay.SetupOpticImage ( )

Setup images and right texture sizing.

◆ UpdateCurrentFov()

void SCR_2DOpticsDisplay.UpdateCurrentFov ( bool  forceUpdate = false)

◆ UpdateReticleSize()

void SCR_2DOpticsDisplay.UpdateReticleSize ( )

Setup images and right texture sizing.

◆ UpdateScale()

void SCR_2DOpticsDisplay.UpdateScale ( float  reticleScale,
float  vignetteScale,
float  objectiveScale 
)

Update widget sizes according to the screen height and DPI scale.

◆ VignetteDefaultPosition()

float SCR_2DOpticsDisplay.VignetteDefaultPosition ( float  screenSize,
float  vignetteSize 
)
protected

Member Data Documentation

◆ m_bActivated

bool SCR_2DOpticsDisplay.m_bActivated
protected

◆ m_bInitialBlurOver

bool SCR_2DOpticsDisplay.m_bInitialBlurOver
protected

◆ m_fMisalignmentDampingSpeed

float SCR_2DOpticsDisplay.m_fMisalignmentDampingSpeed
protected

◆ m_fMisalignmentScale

float SCR_2DOpticsDisplay.m_fMisalignmentScale
protected

◆ m_fMovementDampingSpeed

float SCR_2DOpticsDisplay.m_fMovementDampingSpeed
protected

◆ m_fMovementScale

float SCR_2DOpticsDisplay.m_fMovementScale
protected

◆ m_fObjectiveFov

float SCR_2DOpticsDisplay.m_fObjectiveFov
protected

◆ m_fObjectiveScale

float SCR_2DOpticsDisplay.m_fObjectiveScale
protected

◆ m_fObjectiveSize

float SCR_2DOpticsDisplay.m_fObjectiveSize
protected

◆ m_fOpticBaseFov

float SCR_2DOpticsDisplay.m_fOpticBaseFov
protected

◆ m_fOpticCurrentFov

float SCR_2DOpticsDisplay.m_fOpticCurrentFov
protected

◆ m_fReticleAngularSize

float SCR_2DOpticsDisplay.m_fReticleAngularSize
protected

◆ m_fReticleBaseZoom

float SCR_2DOpticsDisplay.m_fReticleBaseZoom
protected

◆ m_fReticleOffsetX

float SCR_2DOpticsDisplay.m_fReticleOffsetX
protected

◆ m_fReticleOffsetY

float SCR_2DOpticsDisplay.m_fReticleOffsetY
protected

◆ m_fReticlePortion

float SCR_2DOpticsDisplay.m_fReticlePortion
protected

◆ m_fReticleSize

float SCR_2DOpticsDisplay.m_fReticleSize
protected

◆ m_fRollDampingSpeed

float SCR_2DOpticsDisplay.m_fRollDampingSpeed
protected

◆ m_fRollOffset

float SCR_2DOpticsDisplay.m_fRollOffset
protected

◆ m_fRollScale

float SCR_2DOpticsDisplay.m_fRollScale
protected

◆ m_fRotationDampingSpeed

float SCR_2DOpticsDisplay.m_fRotationDampingSpeed
protected

◆ m_fRotationScale

float SCR_2DOpticsDisplay.m_fRotationScale
protected

◆ m_fVignetteMoveSpeed

float SCR_2DOpticsDisplay.m_fVignetteMoveSpeed
protected

◆ m_fVignetteScale

float SCR_2DOpticsDisplay.m_fVignetteScale
protected

◆ m_fVignetteSize

float SCR_2DOpticsDisplay.m_fVignetteSize
protected

◆ m_Optic

SCR_2DOpticsComponent SCR_2DOpticsDisplay.m_Optic
protected

◆ m_sFilterTexture

ResourceName SCR_2DOpticsDisplay.m_sFilterTexture
protected

◆ m_sReticleGlowTexture

ResourceName SCR_2DOpticsDisplay.m_sReticleGlowTexture
protected

◆ m_sReticleTexture

ResourceName SCR_2DOpticsDisplay.m_sReticleTexture
protected

◆ m_vMisalignmentOffset

vector SCR_2DOpticsDisplay.m_vMisalignmentOffset
protected

◆ m_vMovement

vector SCR_2DOpticsDisplay.m_vMovement
protected

◆ m_vMovementOffset

vector SCR_2DOpticsDisplay.m_vMovementOffset
protected

◆ m_vMovementSpeed

vector SCR_2DOpticsDisplay.m_vMovementSpeed
protected

◆ m_vObjectiveOffset

vector SCR_2DOpticsDisplay.m_vObjectiveOffset
protected

◆ m_vRotation

vector SCR_2DOpticsDisplay.m_vRotation
protected

◆ m_vRotationOffset

vector SCR_2DOpticsDisplay.m_vRotationOffset
protected

◆ m_vRotationSpeed

vector SCR_2DOpticsDisplay.m_vRotationSpeed
protected

◆ m_vVignetteOffset

vector SCR_2DOpticsDisplay.m_vVignetteOffset
protected

◆ m_wBlur

BlurWidget SCR_2DOpticsDisplay.m_wBlur
protected

◆ m_wFrontFillLeft

SizeLayoutWidget SCR_2DOpticsDisplay.m_wFrontFillLeft
protected

◆ m_wFrontFillTop

SizeLayoutWidget SCR_2DOpticsDisplay.m_wFrontFillTop
protected

◆ m_wImgCover

ImageWidget SCR_2DOpticsDisplay.m_wImgCover
protected

◆ m_wImgFilter

ImageWidget SCR_2DOpticsDisplay.m_wImgFilter
protected

◆ m_wImgReticle

ImageWidget SCR_2DOpticsDisplay.m_wImgReticle
protected

◆ m_wImgReticleGlow

ImageWidget SCR_2DOpticsDisplay.m_wImgReticleGlow
protected

◆ m_wImgScratches

ImageWidget SCR_2DOpticsDisplay.m_wImgScratches
protected

◆ m_wLayoutFront

Widget SCR_2DOpticsDisplay.m_wLayoutFront
protected

◆ m_wLayoutRear

Widget SCR_2DOpticsDisplay.m_wLayoutRear
protected

◆ m_wOverlayReticles

Widget SCR_2DOpticsDisplay.m_wOverlayReticles
protected

◆ m_wRearFillLeft

SizeLayoutWidget SCR_2DOpticsDisplay.m_wRearFillLeft
protected

◆ m_wRearFillTop

SizeLayoutWidget SCR_2DOpticsDisplay.m_wRearFillTop
protected

◆ m_wSizeLayoutObjective

SizeLayoutWidget SCR_2DOpticsDisplay.m_wSizeLayoutObjective
protected

◆ m_wSizeLayoutRear

SizeLayoutWidget SCR_2DOpticsDisplay.m_wSizeLayoutRear
protected

◆ OPACITY_INITIAL

const float SCR_2DOpticsDisplay.OPACITY_INITIAL = 0.75
static

◆ WIDGET_BLUR

const string SCR_2DOpticsDisplay.WIDGET_BLUR = "Blur"
static

◆ WIDGET_IMAGE_COVER

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_COVER = "ImgCover"
static

◆ WIDGET_IMAGE_FILTER

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_FILTER = "ImgFilter"
static

◆ WIDGET_IMAGE_PADDING_BOTTOM

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_PADDING_BOTTOM = "ImgPaddingBottom"
static

◆ WIDGET_IMAGE_PADDING_LEFT

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_PADDING_LEFT = "ImgPaddingLeft"
static

◆ WIDGET_IMAGE_PADDING_RIGHT

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_PADDING_RIGHT = "ImgPaddingRight"
static

◆ WIDGET_IMAGE_PADDING_TOP

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_PADDING_TOP = "ImgPaddingTop"
static

◆ WIDGET_IMAGE_RETICLE

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_RETICLE = "ImgReticle"
static

◆ WIDGET_IMAGE_RETICLE_GLOW

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_RETICLE_GLOW = "ImgReticleGlow"
static

◆ WIDGET_IMAGE_SCRATCHES

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_SCRATCHES = "ImgScratches"
static

◆ WIDGET_IMAGE_VIGNETTE

const string SCR_2DOpticsDisplay.WIDGET_IMAGE_VIGNETTE = "ImgVignette"
static

◆ WIDGET_LAYOUT_FRONT

const string SCR_2DOpticsDisplay.WIDGET_LAYOUT_FRONT = "HFrontObjective"
static

◆ WIDGET_LAYOUT_REAR

const string SCR_2DOpticsDisplay.WIDGET_LAYOUT_REAR = "HRearEyePiece"
static

◆ WIDGET_OVERLAY_RETICLES

const string SCR_2DOpticsDisplay.WIDGET_OVERLAY_RETICLES = "OverlayReticles"
static

◆ WIDGET_SIZE_LEFT

const string SCR_2DOpticsDisplay.WIDGET_SIZE_LEFT = "SizePaddingLeft"
static

◆ WIDGET_SIZE_OBJECTIVE

const string SCR_2DOpticsDisplay.WIDGET_SIZE_OBJECTIVE = "SizeFrontObjective"
static

◆ WIDGET_SIZE_REAR

const string SCR_2DOpticsDisplay.WIDGET_SIZE_REAR = "SizeRear"
static

◆ WIDGET_SIZE_TOP

const string SCR_2DOpticsDisplay.WIDGET_SIZE_TOP = "SizePaddingTop"
static

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