Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_InputButtonDisplay Class Reference
Inheritance diagram for SCR_InputButtonDisplay:
ScriptedWidgetComponent

Protected Member Functions

override void HandlerAttached (Widget w)
void Init (Widget parent)
bool SetAction (BaseContainer data, BaseContainer filter)
void ForceSetHoldAction (bool state)
void OverrideTexture (string imagePath, string image=string.Empty, Color color=Color.White, SCR_EButtonSize buttonType=SCR_EButtonSize.KEYBOARD_MEDIUM, bool setOverride=true)
void ChangeInputVisibility (bool visible)
void Resize ()
void GetFilter (BaseContainer filter)
bool ApplyTextureToButton ()
void GetWidth ()
bool CreateAdditionalWidgets ()
bool DeleteAdditionalWidgets ()
 Go through all previosly created Widgets and delete them, to keep the widget clean.
void ActionPressed (bool isHoldAction=false)
void ActionReleased ()
void SetToggled (bool toggled, bool animate=true, bool invokeChange=true)
void OnDoubleTap ()
ImageWidget GetOutlineWidget ()
ImageWidget GetBackgroundWidget ()
void AnimateHover ()
 Animate Widget when mouse hovers over it.
void AnimateClick ()
 Animate Widget when action is performed.
void AnimateHold ()
void AnimateHoldComplete ()
void AnimateHoldForceEnd ()
void AnimateDoubleTab ()
void AnimateToggle ()
void AnimateContinous ()
void ResetColor ()
void UpdateEnableColor ()
 Sets the correct color when Widget is initialized. (Active or disabled).
float GetTextSizeModifier ()
bool GetIsOverwritten ()
void SetIsOverwritten (bool setOverride)

Protected Attributes

const float HOLD_ANIMATION_FAILED_ANIMATION_SPEED = -2.5
string m_sButtonText
ref array< ref SCR_ButtonTexture > m_aButtonTextures = {}
SCR_EButtonSize m_eButtonType
ResourceName m_sButtonLayoutConfig
SCR_InputButtonStyle m_ButtonLayout
ref array< ImageWidget > m_aAdditionalWidgets = {}
int m_iWidth
float m_fMediumButtonWidhtModifier = 1.5
float m_fLargeButtonWidhtModifier = 1.78
float m_fButtonTextSizeModifier = 3
float m_fAnimationRate
float m_fAnimationTime
float m_fMaxHoldtime
float m_fDoubleTapTime
float m_fHoldIndicatorDefaultPosition [2]
float m_fHoldIndicatorAnimationPosition [2]
bool m_bIsHoldAction
bool m_bIsHoldActionOnce
bool m_bIsDoubleTapAction
bool m_bPressedInput
bool m_bCanBeToggled
bool m_bIsContinuous
bool m_bIsToggled
bool m_bIsOverwritten
bool m_bIsUsingImage
bool m_bIsUsingImageGlow
bool m_bIsUsingText
bool m_bKeybindActive = true
SCR_InputButtonComponent m_InputButtonComp
WidgetAnimationAlphaMask m_HoldingAnimation
WidgetAnimationPosition m_HoldIndicatorAnimation
Widget m_wRoot
Widget m_wParent
OverlayWidget m_wOverlay
OverlayWidget m_wShadowOverlay
ImageWidget m_wGlow
ImageWidget m_wOutlineClear
ImageWidget m_wOutline
ImageWidget m_wKeyBG
ImageWidget m_wDoubleTabIndicator
ImageWidget m_wButtonImgGlow
ImageWidget m_wButtonImg
ImageWidget m_wHoldIndicator
RichTextWidget m_wButtonText

Detailed Description

Definition at line 1 of file SCR_InputButtonDisplay.c.

Member Function Documentation

◆ ActionPressed()

void SCR_InputButtonDisplay::ActionPressed ( bool isHoldAction = false)
inlineprotected
Parameters
isHoldAction

Definition at line 479 of file SCR_InputButtonDisplay.c.

◆ ActionReleased()

void SCR_InputButtonDisplay::ActionReleased ( )
inlineprotected

Check if the animation is still running and it's value is below 1 (1 = animation done)

Reverse the animation speed so it's going backwards fast then it went forward to show the hold action has failed

Definition at line 513 of file SCR_InputButtonDisplay.c.

◆ AnimateClick()

void SCR_InputButtonDisplay::AnimateClick ( )
inlineprotected

Animate Widget when action is performed.

Using CallLater to give the animation time to complete before it's being reset to default state

Definition at line 619 of file SCR_InputButtonDisplay.c.

◆ AnimateContinous()

void SCR_InputButtonDisplay::AnimateContinous ( )
inlineprotected

Definition at line 691 of file SCR_InputButtonDisplay.c.

◆ AnimateDoubleTab()

void SCR_InputButtonDisplay::AnimateDoubleTab ( )
inlineprotected

Using CallLater to give the animation time to complete before it's being reset to default state

Using CallLater to give the animation time to complete before it's being reset to default state

Definition at line 665 of file SCR_InputButtonDisplay.c.

◆ AnimateHold()

void SCR_InputButtonDisplay::AnimateHold ( )
inlineprotected

Definition at line 635 of file SCR_InputButtonDisplay.c.

◆ AnimateHoldComplete()

void SCR_InputButtonDisplay::AnimateHoldComplete ( )
inlineprotected

Definition at line 648 of file SCR_InputButtonDisplay.c.

◆ AnimateHoldForceEnd()

void SCR_InputButtonDisplay::AnimateHoldForceEnd ( )
inlineprotected

Definition at line 659 of file SCR_InputButtonDisplay.c.

◆ AnimateHover()

void SCR_InputButtonDisplay::AnimateHover ( )
inlineprotected

Animate Widget when mouse hovers over it.

Definition at line 599 of file SCR_InputButtonDisplay.c.

◆ AnimateToggle()

void SCR_InputButtonDisplay::AnimateToggle ( )
inlineprotected

Definition at line 685 of file SCR_InputButtonDisplay.c.

◆ ApplyTextureToButton()

bool SCR_InputButtonDisplay::ApplyTextureToButton ( )
inlineprotected

Apply textures from set SCR_InputButtonLayout config to ImageWidgets Set the correct size for every widget by using set Height

Checks if button has a Image defined in config otherwise it uses the text//

If the button has more than 1 image assigned, we create as many ImageWidgets as we need

Lets just clean up the Images if we dont need them anymore

Definition at line 332 of file SCR_InputButtonDisplay.c.

◆ ChangeInputVisibility()

void SCR_InputButtonDisplay::ChangeInputVisibility ( bool visible)
inlineprotected

Change the visibility of the Button Image & Text

Parameters
[in]visibility

Definition at line 226 of file SCR_InputButtonDisplay.c.

◆ CreateAdditionalWidgets()

bool SCR_InputButtonDisplay::CreateAdditionalWidgets ( )
inlineprotected

Create temporary ImageWidgets if the Button has more than one texture applied in the config. For each entry in the "inputButton.m_aTextures" array a new ImageWidget will be created to save a lot of space in the widget.

Is the texture has a glow/shadow create that first so it's behind the actual texture

Definition at line 439 of file SCR_InputButtonDisplay.c.

◆ DeleteAdditionalWidgets()

bool SCR_InputButtonDisplay::DeleteAdditionalWidgets ( )
inlineprotected

Go through all previosly created Widgets and delete them, to keep the widget clean.

Definition at line 464 of file SCR_InputButtonDisplay.c.

◆ ForceSetHoldAction()

void SCR_InputButtonDisplay::ForceSetHoldAction ( bool state)
inlineprotected

Definition at line 150 of file SCR_InputButtonDisplay.c.

◆ GetBackgroundWidget()

ImageWidget SCR_InputButtonDisplay::GetBackgroundWidget ( )
inlineprotected

Definition at line 592 of file SCR_InputButtonDisplay.c.

◆ GetFilter()

void SCR_InputButtonDisplay::GetFilter ( BaseContainer filter)
inlineprotected

Definition at line 291 of file SCR_InputButtonDisplay.c.

◆ GetIsOverwritten()

bool SCR_InputButtonDisplay::GetIsOverwritten ( )
inlineprotected

Definition at line 755 of file SCR_InputButtonDisplay.c.

◆ GetOutlineWidget()

ImageWidget SCR_InputButtonDisplay::GetOutlineWidget ( )
inlineprotected

Definition at line 586 of file SCR_InputButtonDisplay.c.

◆ GetTextSizeModifier()

float SCR_InputButtonDisplay::GetTextSizeModifier ( )
inlineprotected

Definition at line 749 of file SCR_InputButtonDisplay.c.

◆ GetWidth()

void SCR_InputButtonDisplay::GetWidth ( )
inlineprotected

Apply correct size to all images

Definition at line 418 of file SCR_InputButtonDisplay.c.

◆ HandlerAttached()

override void SCR_InputButtonDisplay::HandlerAttached ( Widget w)
inlineprotected

Definition at line 59 of file SCR_InputButtonDisplay.c.

◆ Init()

void SCR_InputButtonDisplay::Init ( Widget parent)
inlineprotected

Initialise Widget and subscribe to needed ScriptInvokers

Parameters
Parentwidget

Definition at line 81 of file SCR_InputButtonDisplay.c.

◆ OnDoubleTap()

void SCR_InputButtonDisplay::OnDoubleTap ( )
inlineprotected

Definition at line 559 of file SCR_InputButtonDisplay.c.

◆ OverrideTexture()

void SCR_InputButtonDisplay::OverrideTexture ( string imagePath,
string image = string.Empty,
Color color = Color.White,
SCR_EButtonSize buttonType = SCR_EButtonSize.KEYBOARD_MEDIUM,
bool setOverride = true )
inlineprotected

Overrides Texture of the Button USE SCR_InputButtonComponent.SetTexture() to call

Definition at line 161 of file SCR_InputButtonDisplay.c.

◆ ResetColor()

void SCR_InputButtonDisplay::ResetColor ( )
inlineprotected

Definition at line 699 of file SCR_InputButtonDisplay.c.

◆ Resize()

void SCR_InputButtonDisplay::Resize ( )
inlineprotected

Trigger resizing of Button Use SCR_InputButtonComponent.SetSize() to call

Definition at line 258 of file SCR_InputButtonDisplay.c.

◆ SetAction()

bool SCR_InputButtonDisplay::SetAction ( BaseContainer data,
BaseContainer filter )
inlineprotected

Get all visual information about the button and apply them

Parameters
data
filter
Returns

Lets apply all gathered textures from the config to the correct ImageWidgets

Update the color 1 frame later in case the parent gets updated the same frame

Definition at line 104 of file SCR_InputButtonDisplay.c.

◆ SetIsOverwritten()

void SCR_InputButtonDisplay::SetIsOverwritten ( bool setOverride)
inlineprotected

Definition at line 761 of file SCR_InputButtonDisplay.c.

◆ SetToggled()

void SCR_InputButtonDisplay::SetToggled ( bool toggled,
bool animate = true,
bool invokeChange = true )
inlineprotected

Definition at line 541 of file SCR_InputButtonDisplay.c.

◆ UpdateEnableColor()

void SCR_InputButtonDisplay::UpdateEnableColor ( )
inlineprotected

Sets the correct color when Widget is initialized. (Active or disabled).

Definition at line 721 of file SCR_InputButtonDisplay.c.

Member Data Documentation

◆ HOLD_ANIMATION_FAILED_ANIMATION_SPEED

const float SCR_InputButtonDisplay::HOLD_ANIMATION_FAILED_ANIMATION_SPEED = -2.5
protected

Definition at line 3 of file SCR_InputButtonDisplay.c.

◆ m_aAdditionalWidgets

ref array<ImageWidget> SCR_InputButtonDisplay::m_aAdditionalWidgets = {}
protected

Definition at line 11 of file SCR_InputButtonDisplay.c.

◆ m_aButtonTextures

ref array<ref SCR_ButtonTexture> SCR_InputButtonDisplay::m_aButtonTextures = {}
protected

Definition at line 6 of file SCR_InputButtonDisplay.c.

◆ m_bCanBeToggled

bool SCR_InputButtonDisplay::m_bCanBeToggled
protected

Definition at line 29 of file SCR_InputButtonDisplay.c.

◆ m_bIsContinuous

bool SCR_InputButtonDisplay::m_bIsContinuous
protected

Definition at line 30 of file SCR_InputButtonDisplay.c.

◆ m_bIsDoubleTapAction

bool SCR_InputButtonDisplay::m_bIsDoubleTapAction
protected

Definition at line 27 of file SCR_InputButtonDisplay.c.

◆ m_bIsHoldAction

bool SCR_InputButtonDisplay::m_bIsHoldAction
protected

Definition at line 25 of file SCR_InputButtonDisplay.c.

◆ m_bIsHoldActionOnce

bool SCR_InputButtonDisplay::m_bIsHoldActionOnce
protected

Definition at line 26 of file SCR_InputButtonDisplay.c.

◆ m_bIsOverwritten

bool SCR_InputButtonDisplay::m_bIsOverwritten
protected

Definition at line 32 of file SCR_InputButtonDisplay.c.

◆ m_bIsToggled

bool SCR_InputButtonDisplay::m_bIsToggled
protected

Definition at line 31 of file SCR_InputButtonDisplay.c.

◆ m_bIsUsingImage

bool SCR_InputButtonDisplay::m_bIsUsingImage
protected

Definition at line 33 of file SCR_InputButtonDisplay.c.

◆ m_bIsUsingImageGlow

bool SCR_InputButtonDisplay::m_bIsUsingImageGlow
protected

Definition at line 34 of file SCR_InputButtonDisplay.c.

◆ m_bIsUsingText

bool SCR_InputButtonDisplay::m_bIsUsingText
protected

Definition at line 35 of file SCR_InputButtonDisplay.c.

◆ m_bKeybindActive

bool SCR_InputButtonDisplay::m_bKeybindActive = true
protected

Definition at line 37 of file SCR_InputButtonDisplay.c.

◆ m_bPressedInput

bool SCR_InputButtonDisplay::m_bPressedInput
protected

Definition at line 28 of file SCR_InputButtonDisplay.c.

◆ m_ButtonLayout

SCR_InputButtonStyle SCR_InputButtonDisplay::m_ButtonLayout
protected

Definition at line 9 of file SCR_InputButtonDisplay.c.

◆ m_eButtonType

SCR_EButtonSize SCR_InputButtonDisplay::m_eButtonType
protected

Definition at line 7 of file SCR_InputButtonDisplay.c.

◆ m_fAnimationRate

float SCR_InputButtonDisplay::m_fAnimationRate
protected

Definition at line 18 of file SCR_InputButtonDisplay.c.

◆ m_fAnimationTime

float SCR_InputButtonDisplay::m_fAnimationTime
protected

Definition at line 19 of file SCR_InputButtonDisplay.c.

◆ m_fButtonTextSizeModifier

float SCR_InputButtonDisplay::m_fButtonTextSizeModifier = 3
protected

Definition at line 16 of file SCR_InputButtonDisplay.c.

◆ m_fDoubleTapTime

float SCR_InputButtonDisplay::m_fDoubleTapTime
protected

Definition at line 21 of file SCR_InputButtonDisplay.c.

◆ m_fHoldIndicatorAnimationPosition

float SCR_InputButtonDisplay::m_fHoldIndicatorAnimationPosition[2]
protected

Definition at line 23 of file SCR_InputButtonDisplay.c.

◆ m_fHoldIndicatorDefaultPosition

float SCR_InputButtonDisplay::m_fHoldIndicatorDefaultPosition[2]
protected

Definition at line 22 of file SCR_InputButtonDisplay.c.

◆ m_fLargeButtonWidhtModifier

float SCR_InputButtonDisplay::m_fLargeButtonWidhtModifier = 1.78
protected

Definition at line 15 of file SCR_InputButtonDisplay.c.

◆ m_fMaxHoldtime

float SCR_InputButtonDisplay::m_fMaxHoldtime
protected

Definition at line 20 of file SCR_InputButtonDisplay.c.

◆ m_fMediumButtonWidhtModifier

float SCR_InputButtonDisplay::m_fMediumButtonWidhtModifier = 1.5
protected

Definition at line 14 of file SCR_InputButtonDisplay.c.

◆ m_HoldIndicatorAnimation

WidgetAnimationPosition SCR_InputButtonDisplay::m_HoldIndicatorAnimation
protected

Definition at line 41 of file SCR_InputButtonDisplay.c.

◆ m_HoldingAnimation

WidgetAnimationAlphaMask SCR_InputButtonDisplay::m_HoldingAnimation
protected

Definition at line 40 of file SCR_InputButtonDisplay.c.

◆ m_InputButtonComp

SCR_InputButtonComponent SCR_InputButtonDisplay::m_InputButtonComp
protected

Definition at line 39 of file SCR_InputButtonDisplay.c.

◆ m_iWidth

int SCR_InputButtonDisplay::m_iWidth
protected

Definition at line 13 of file SCR_InputButtonDisplay.c.

◆ m_sButtonLayoutConfig

ResourceName SCR_InputButtonDisplay::m_sButtonLayoutConfig
protected

Definition at line 8 of file SCR_InputButtonDisplay.c.

◆ m_sButtonText

string SCR_InputButtonDisplay::m_sButtonText
protected

Definition at line 5 of file SCR_InputButtonDisplay.c.

◆ m_wButtonImg

ImageWidget SCR_InputButtonDisplay::m_wButtonImg
protected

Definition at line 54 of file SCR_InputButtonDisplay.c.

◆ m_wButtonImgGlow

ImageWidget SCR_InputButtonDisplay::m_wButtonImgGlow
protected

Definition at line 53 of file SCR_InputButtonDisplay.c.

◆ m_wButtonText

RichTextWidget SCR_InputButtonDisplay::m_wButtonText
protected

Definition at line 56 of file SCR_InputButtonDisplay.c.

◆ m_wDoubleTabIndicator

ImageWidget SCR_InputButtonDisplay::m_wDoubleTabIndicator
protected

Definition at line 52 of file SCR_InputButtonDisplay.c.

◆ m_wGlow

ImageWidget SCR_InputButtonDisplay::m_wGlow
protected

Definition at line 48 of file SCR_InputButtonDisplay.c.

◆ m_wHoldIndicator

ImageWidget SCR_InputButtonDisplay::m_wHoldIndicator
protected

Definition at line 55 of file SCR_InputButtonDisplay.c.

◆ m_wKeyBG

ImageWidget SCR_InputButtonDisplay::m_wKeyBG
protected

Definition at line 51 of file SCR_InputButtonDisplay.c.

◆ m_wOutline

ImageWidget SCR_InputButtonDisplay::m_wOutline
protected

Definition at line 50 of file SCR_InputButtonDisplay.c.

◆ m_wOutlineClear

ImageWidget SCR_InputButtonDisplay::m_wOutlineClear
protected

Definition at line 49 of file SCR_InputButtonDisplay.c.

◆ m_wOverlay

OverlayWidget SCR_InputButtonDisplay::m_wOverlay
protected

Definition at line 46 of file SCR_InputButtonDisplay.c.

◆ m_wParent

Widget SCR_InputButtonDisplay::m_wParent
protected

Definition at line 44 of file SCR_InputButtonDisplay.c.

◆ m_wRoot

Widget SCR_InputButtonDisplay::m_wRoot
protected

Definition at line 43 of file SCR_InputButtonDisplay.c.

◆ m_wShadowOverlay

OverlayWidget SCR_InputButtonDisplay::m_wShadowOverlay
protected

Definition at line 47 of file SCR_InputButtonDisplay.c.

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