Inheritance diagram for SCR_InputButtonComponent:

Protected Member Functions
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
bool	IsKeybindAvailable (inout notnull array< string > keyStack)
override void	SetEnabled (bool enabled, bool animate=true)
void	SetEnabled_Internal (bool enabled, bool animate=true)
void	OnInputDeviceUserChanged (bool isGamepad)
	React on switching between input methods.
bool	ChangeInputDevice (EInputDeviceType inputDevice, bool hasFocus, bool resetOverride=false)
bool	GetInputFilterSettings (BaseContainer filter)
	Check which filter is applied to the action to change the buttons behavior.
void	CreateComboWidget ()
	Create a second InputButton widget to display combos.
void	DeleteComboWidget ()
	Delete secound InputButton widget if there is one.
void	SetInputAction ()
	Add action listeners for selected input action.
void	OnButtonPressed (float value, EActionTrigger reason)
override bool	OnDoubleClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
override void	OnDisabled (bool animate)
override void	OnEnabled (bool animate)
void	OnButtonHold (float value)
void	PlaySoundClicked ()
void	OnInput ()
	Called when Button is clicked / key is presses.
void	ActionPressed (bool isHoldAction=false)
void	ActionReleased ()
bool	GetIsHoldingButton ()
void	SetIsHoldingButton (bool isHolding)
float	GetAnimationRate ()
float	GetAnimationTime ()
bool	GetIsInputCombo ()
ScriptInvokerVoid	GetOnAnimateHover ()
ScriptInvokerVoid	GetOnUpdateEnableColor ()
ScriptInvokerVoid	GetOnHoldAnimComplete ()
void	ProcessKeybindStack (inout int index, notnull array< string > keyStack)
void	ProcessFilterStack ()
void	SetLabel (string label)
	PUBLIC API\.
void	SetLabelColor (notnull Color color)
	Change the color of the Label.
bool	SetAction (string action, EInputDeviceType currentInputDevice=-1, bool forceUpdate=false)
int	GetSize ()
void	SetSize (int size)
bool	IsClickSoundDisabled ()
void	SetClickSoundDisabled (bool isEnabled)
	Enable / disable the click sound played when button is pressed.
void	SetTexture (string imagePath, string image=string.Empty, Color color=Color.FromInt(Color.WHITE), SCR_EButtonSize buttonType=SCR_EButtonSize.KEYBOARD_MEDIUM)
void	ResetTexture ()
void	SetColorActionDisabled (Color newColor)
void	ChangeInputVisibility (bool visible)
bool	IsHovering ()
void	SetForceDisabled (bool forceDisabled, bool animate=true)
void	SetForceDisabledWithDelay (bool forceDisabled, bool animate=true, int delay=0)
void	OnActiveWidgetInteraction (bool isInteractionActive, int delay)
void	OnDialogOpen (DialogUI dialog)
void	OnDialogClose (DialogUI dialog)
void	OnMenuFocusGained (ChimeraMenuBase menu)
void	OnMenuFocusLost (ChimeraMenuBase menu)
void	OnSettingsMenuClosed (ChimeraMenuBase menu)
bool	IsInTopMenu ()
	Returns true if there are no dailogs or if this button is in the last dialog opened.
bool	IsInTopDialog ()
	Returns true if there if this button is in the last dialog opened.
bool	GetForceDisabled ()
void	UpdateComboIndicatorSizes ()

Static Protected Member Functions
static SCR_InputButtonComponent	FindComponent (notnull Widget w)
static SCR_InputButtonComponent	GetInputButtonComponent (string name, notnull Widget parent, bool searchAllChildren=true)

Protected Attributes
bool	m_bKeybindActive
string	m_sActionName
string	m_sLabel
bool	m_bIsMouseInput
int	m_iMaxShownKeys
int	m_iHeightInPixel
ref Color	m_ActionDefault
ref Color	m_ActionHovered
ref Color	m_ActionDisabled
ref Color	m_ActionUnbound
string	m_sActionUnboundIcon
ref Color	m_LabelDefault
ref Color	m_ActionToggled
bool	m_bDisableClickSound
float	m_fHoldIndicatorDefaultPosition
float	m_fHoldIndicatorHoldPosition
float	m_fHoldIndicatorAnimationTime
bool	m_bCanBeDisabled
bool	m_bChangeLabelColorOnDisabled
string	m_sButtonWidgetName
string	m_sHorizontalLayoutWidget
string	m_sTextHintWidget
ResourceName	m_sInputButtonWidget
ResourceName	m_sComboIndicatorWidget
ResourceName	m_sComboIndicatorImageSet
ResourceName	m_sComboIndicatorImageSetGlow
bool	m_bOverrideTextSize
float	m_fHoldTimeReduction
bool	m_bDebugSimulateController
const string	COMBO_INDICATOR_IMAGE_NAME = "ComboIndicatorImg"
const string	COMBO_INDICATOR_SHADOW_NAME = "ComboIndicatorShadow"
const string	COMBO_INDICATOR_DIVIDER_NAME = "keybind_divider"
const string	COMBO_INDICATOR_COMBO_NAME = "keybind_combo"
const string	COMBO_INDICATOR_KEY = " + "
const string	COMBO_DIVIDER_KEY = " \| "
const float	COMBO_INDICATOR_SIZE_MULTIPLIER = 0.5
const float	COMBO_INDICATOR_PADDING_MULTIPLIER_LEFT = 0.20
const float	COMBO_INDICATOR_PADDING_MULTIPLIER_RIGHT = 0.15
const float	MIN_FONTSIZE_MULTIPLIER = 0.5
ref SCR_InputButtonDisplay	m_ButtonDisplay
Widget	m_wHorizontalLayout
RichTextWidget	m_wTextHint
ref array< SizeLayoutWidget >	m_aComboIndicators = {}
ref array< Widget >	m_aComboWidgets = {}
ref array< BaseContainer >	m_aFilterStack = {}
ref array< int >	m_aFilterStackIndexRemover = {}
ref array< string >	m_aKeyStackArray = {}
InputManager	m_InputManager = GetGame().GetInputManager()
bool	m_bIsComboInput
bool	m_bIsAlternativeInput
bool	m_bIsHoldAction
bool	m_bIsDoubleTapAction
bool	m_bPressedInput
bool	m_bIsContinuous
bool	m_bForceDisabled
bool	m_bShouldBeEnabled
bool	m_bIsInteractionActive
bool	m_bForceUpdate
	If user changed keybing then it should force update of hints.
string	m_sOldActionName
bool	m_bIsHoldingButton
bool	m_bIsHovered
bool	m_bIsDoubleTapStated
float	m_fDefaultHoldTime
float	m_fDefaultClickTime
float	m_fMaxHoldtime
int	m_iDoubleTapThreshold
EInputDeviceType	m_eCurrentInputDevice
ref ScriptInvokerVoid	m_OnAnimateHover
ref ScriptInvokerVoid	m_OnUpdateEnableColor
ref ScriptInvokerVoid	m_OnHoldAnimComplete
ref ScriptInvoker	m_OnActivated = new ScriptInvoker()
ref array< DialogUI >	m_aDialogs = {}

Detailed Description

Definition at line 1 of file SCR_InputButtonComponent.c.

Member Function Documentation

◆ ActionPressed()

void SCR_InputButtonComponent::ActionPressed ( bool isHoldAction = false )

inlineprotected

Definition at line 751 of file SCR_InputButtonComponent.c.

◆ ActionReleased()

void SCR_InputButtonComponent::ActionReleased ( )

inlineprotected

Definition at line 767 of file SCR_InputButtonComponent.c.

◆ ChangeInputDevice()

bool SCR_InputButtonComponent::ChangeInputDevice	(	EInputDeviceType	inputDevice,
		bool	hasFocus,
		bool	resetOverride = false )

inlineprotected

Check for last used input device and get the correct keybind for it.

Parameters

[in]	EInputDeviceType	type of InputDevice
[in]	bool	is the realted button focused by mouse
[in]	bool	reset Button override if it was enabled (false by default)

Get keybind for selected input action and input device

Definition at line 317 of file SCR_InputButtonComponent.c.

◆ ChangeInputVisibility()

void SCR_InputButtonComponent::ChangeInputVisibility ( bool visible )

inlineprotected

Change the visibility of the Button Image & Text

Parameters

[in] visibility

Definition at line 1054 of file SCR_InputButtonComponent.c.

◆ CreateComboWidget()

void SCR_InputButtonComponent::CreateComboWidget ( )

inlineprotected

Create a second InputButton widget to display combos.

Create InputButton widget

Definition at line 482 of file SCR_InputButtonComponent.c.

◆ DeleteComboWidget()

void SCR_InputButtonComponent::DeleteComboWidget ( )

inlineprotected

Delete secound InputButton widget if there is one.

Definition at line 574 of file SCR_InputButtonComponent.c.

◆ FindComponent()

SCR_InputButtonComponent SCR_InputButtonComponent::FindComponent ( notnull Widget w )

inlinestaticprotected

Definition at line 1078 of file SCR_InputButtonComponent.c.

◆ GetAnimationRate()

float SCR_InputButtonComponent::GetAnimationRate ( )

inlineprotected

Definition at line 799 of file SCR_InputButtonComponent.c.

◆ GetAnimationTime()

float SCR_InputButtonComponent::GetAnimationTime ( )

inlineprotected

Definition at line 805 of file SCR_InputButtonComponent.c.

◆ GetForceDisabled()

bool SCR_InputButtonComponent::GetForceDisabled ( )

inlineprotected

Definition at line 1189 of file SCR_InputButtonComponent.c.

◆ GetInputButtonComponent()

SCR_InputButtonComponent SCR_InputButtonComponent::GetInputButtonComponent	(	string	name,
		notnull Widget	parent,
		bool	searchAllChildren = true )

inlinestaticprotected

Static method to easily find component by providing name and parent. Searching all children will go through whole hierarchy, instead of immediate chidren

Definition at line 1212 of file SCR_InputButtonComponent.c.

◆ GetInputFilterSettings()

bool SCR_InputButtonComponent::GetInputFilterSettings ( BaseContainer filter )

inlineprotected

Check which filter is applied to the action to change the buttons behavior.

Definition at line 403 of file SCR_InputButtonComponent.c.

◆ GetIsHoldingButton()

bool SCR_InputButtonComponent::GetIsHoldingButton ( )

inlineprotected

Definition at line 787 of file SCR_InputButtonComponent.c.

◆ GetIsInputCombo()

bool SCR_InputButtonComponent::GetIsInputCombo ( )

inlineprotected

Definition at line 811 of file SCR_InputButtonComponent.c.

◆ GetOnAnimateHover()

ScriptInvokerVoid SCR_InputButtonComponent::GetOnAnimateHover ( )

inlineprotected

Definition at line 817 of file SCR_InputButtonComponent.c.

◆ GetOnHoldAnimComplete()

ScriptInvokerVoid SCR_InputButtonComponent::GetOnHoldAnimComplete ( )

inlineprotected

Definition at line 835 of file SCR_InputButtonComponent.c.

◆ GetOnUpdateEnableColor()

ScriptInvokerVoid SCR_InputButtonComponent::GetOnUpdateEnableColor ( )

inlineprotected

Definition at line 826 of file SCR_InputButtonComponent.c.

◆ GetSize()

int SCR_InputButtonComponent::GetSize ( )

inlineprotected

Definition at line 977 of file SCR_InputButtonComponent.c.

◆ HandlerAttached()

override void SCR_InputButtonComponent::HandlerAttached ( Widget w )

inlineprotected

Get the default hold time defined in Project settings

Definition at line 165 of file SCR_InputButtonComponent.c.

◆ HandlerDeattached()

override void SCR_InputButtonComponent::HandlerDeattached ( Widget w )

inlineprotected

Remove old listener

Definition at line 225 of file SCR_InputButtonComponent.c.

◆ IsClickSoundDisabled()

bool SCR_InputButtonComponent::IsClickSoundDisabled ( )

inlineprotected

Definition at line 1002 of file SCR_InputButtonComponent.c.

◆ IsHovering()

bool SCR_InputButtonComponent::IsHovering ( )

inlineprotected

Definition at line 1084 of file SCR_InputButtonComponent.c.

◆ IsInTopDialog()

bool SCR_InputButtonComponent::IsInTopDialog ( )

inlineprotected

Returns true if there if this button is in the last dialog opened.

Definition at line 1183 of file SCR_InputButtonComponent.c.

◆ IsInTopMenu()

bool SCR_InputButtonComponent::IsInTopMenu ( )

inlineprotected

Returns true if there are no dailogs or if this button is in the last dialog opened.

Definition at line 1176 of file SCR_InputButtonComponent.c.

◆ IsKeybindAvailable()

bool SCR_InputButtonComponent::IsKeybindAvailable ( inout notnull array< string > keyStack )

inlineprotected

Parameters

[in,out] keyStack stack for keys. Can be: '+' for input combo (binary node followed by two child nodes) or '|' for input sum/alternative (binary node followed by two child nodes) otherwise contains key code (leaf node)

Returns: true when there is a keybind avialable for current input device

Definition at line 266 of file SCR_InputButtonComponent.c.

◆ OnActiveWidgetInteraction()

void SCR_InputButtonComponent::OnActiveWidgetInteraction	(	bool	isInteractionActive,
		int	delay )

inlineprotected

Definition at line 1119 of file SCR_InputButtonComponent.c.

◆ OnButtonHold()

void SCR_InputButtonComponent::OnButtonHold ( float value )

inlineprotected

Called when button is held.

Parameters

Float 0-1. State of button press.

Definition at line 679 of file SCR_InputButtonComponent.c.

◆ OnButtonPressed()

void SCR_InputButtonComponent::OnButtonPressed	(	float	value,
		EActionTrigger	reason )

inlineprotected

Definition at line 617 of file SCR_InputButtonComponent.c.

◆ OnClick()

override bool SCR_InputButtonComponent::OnClick	(	Widget	w,
		int	x,
		int	y,
		int	button )

inlineprotected

Definition at line 245 of file SCR_InputButtonComponent.c.

◆ OnDialogClose()

void SCR_InputButtonComponent::OnDialogClose ( DialogUI dialog )

inlineprotected

Definition at line 1136 of file SCR_InputButtonComponent.c.

◆ OnDialogOpen()

void SCR_InputButtonComponent::OnDialogOpen ( DialogUI dialog )

inlineprotected

Definition at line 1128 of file SCR_InputButtonComponent.c.

◆ OnDisabled()

override void SCR_InputButtonComponent::OnDisabled ( bool animate )

inlineprotected

Definition at line 661 of file SCR_InputButtonComponent.c.

◆ OnDoubleClick()

override bool SCR_InputButtonComponent::OnDoubleClick	(	Widget	w,
		int	x,
		int	y,
		int	button )

inlineprotected

Definition at line 627 of file SCR_InputButtonComponent.c.

◆ OnEnabled()

override void SCR_InputButtonComponent::OnEnabled ( bool animate )

inlineprotected

Definition at line 668 of file SCR_InputButtonComponent.c.

◆ OnInput()

void SCR_InputButtonComponent::OnInput ( )

inlineprotected

Called when Button is clicked / key is presses.

Definition at line 726 of file SCR_InputButtonComponent.c.

◆ OnInputDeviceUserChanged()

void SCR_InputButtonComponent::OnInputDeviceUserChanged ( bool isGamepad )

inlineprotected

React on switching between input methods.

Definition at line 304 of file SCR_InputButtonComponent.c.

◆ OnMenuFocusGained()

void SCR_InputButtonComponent::OnMenuFocusGained ( ChimeraMenuBase menu )

inlineprotected

Definition at line 1144 of file SCR_InputButtonComponent.c.

◆ OnMenuFocusLost()

void SCR_InputButtonComponent::OnMenuFocusLost ( ChimeraMenuBase menu )

inlineprotected

Definition at line 1151 of file SCR_InputButtonComponent.c.

◆ OnMouseEnter()

override bool SCR_InputButtonComponent::OnMouseEnter	(	Widget	w,
		int	x,
		int	y )

inlineprotected

Definition at line 636 of file SCR_InputButtonComponent.c.

◆ OnMouseLeave()

override bool SCR_InputButtonComponent::OnMouseLeave	(	Widget	w,
		Widget	enterW,
		int	x,
		int	y )

inlineprotected

Definition at line 648 of file SCR_InputButtonComponent.c.

◆ OnSettingsMenuClosed()

void SCR_InputButtonComponent::OnSettingsMenuClosed ( ChimeraMenuBase menu )

inlineprotected

Callback method that is triggered when some menu is closed

Parameters

[in] menu that was closed

Definition at line 1160 of file SCR_InputButtonComponent.c.

◆ PlaySoundClicked()

void SCR_InputButtonComponent::PlaySoundClicked ( )

inlineprotected

Definition at line 713 of file SCR_InputButtonComponent.c.

◆ ProcessFilterStack()

void SCR_InputButtonComponent::ProcessFilterStack ( )

inlineprotected

Delete not needed entries from m_aFilterStack and bring it into correct order !

Definition at line 886 of file SCR_InputButtonComponent.c.

◆ ProcessKeybindStack()

void SCR_InputButtonComponent::ProcessKeybindStack	(	inout int	index,
		notnull array< string >	keyStack )

inlineprotected

Iterate trough key bind stack

Parameters

[in,out] index gets decremented by one

Definition at line 846 of file SCR_InputButtonComponent.c.

◆ ResetTexture()

void SCR_InputButtonComponent::ResetTexture ( )

inlineprotected

Restet Button back to it's default texutre Use after SetTexture() to undo the override

Definition at line 1031 of file SCR_InputButtonComponent.c.

◆ SetAction()

bool SCR_InputButtonComponent::SetAction	(	string	action,
		EInputDeviceType	currentInputDevice = -1,
		bool	forceUpdate = false )

inlineprotected

Override action. This changes the visuals of the button based on the new action.

Parameters

[in]	action	name defined in chimeraInputCommon.conf
[in]	currentInputDevice	for what input device type this hint should load the data
[in]	forceUpdate	if this hint should ignore if it is already configured for the same action and try to fetch that data again in order to refresh it

Definition at line 951 of file SCR_InputButtonComponent.c.

◆ SetClickSoundDisabled()

void SCR_InputButtonComponent::SetClickSoundDisabled ( bool isEnabled )

inlineprotected

Enable / disable the click sound played when button is pressed.

Definition at line 1009 of file SCR_InputButtonComponent.c.

◆ SetColorActionDisabled()

void SCR_InputButtonComponent::SetColorActionDisabled ( Color newColor )

inlineprotected

Definition at line 1046 of file SCR_InputButtonComponent.c.

◆ SetEnabled()

override void SCR_InputButtonComponent::SetEnabled	(	bool	enabled,
		bool	animate = true )

inlineprotected

Definition at line 278 of file SCR_InputButtonComponent.c.

◆ SetEnabled_Internal()

void SCR_InputButtonComponent::SetEnabled_Internal	(	bool	enabled,
		bool	animate = true )

inlineprotected

Definition at line 285 of file SCR_InputButtonComponent.c.

◆ SetForceDisabled()

void SCR_InputButtonComponent::SetForceDisabled	(	bool	forceDisabled,
		bool	animate = true )

inlineprotected

Definition at line 1090 of file SCR_InputButtonComponent.c.

◆ SetForceDisabledWithDelay()

void SCR_InputButtonComponent::SetForceDisabledWithDelay	(	bool	forceDisabled,
		bool	animate = true,
		int	delay = 0 )

inlineprotected

Definition at line 1103 of file SCR_InputButtonComponent.c.

◆ SetInputAction()

void SCR_InputButtonComponent::SetInputAction ( )

inlineprotected

Add action listeners for selected input action.

Definition at line 593 of file SCR_InputButtonComponent.c.

◆ SetIsHoldingButton()

void SCR_InputButtonComponent::SetIsHoldingButton ( bool isHolding )

inlineprotected

Definition at line 793 of file SCR_InputButtonComponent.c.

◆ SetLabel()

void SCR_InputButtonComponent::SetLabel ( string label )

inlineprotected

PUBLIC API\.

Change the Text displayed in the label

Definition at line 927 of file SCR_InputButtonComponent.c.

◆ SetLabelColor()

void SCR_InputButtonComponent::SetLabelColor ( notnull Color color )

inlineprotected

Change the color of the Label.

Definition at line 938 of file SCR_InputButtonComponent.c.

◆ SetSize()

void SCR_InputButtonComponent::SetSize ( int size )

inlineprotected

Change the size of the button

Parameters

Int	- Height in px. Width will be calculated automatically

Definition at line 985 of file SCR_InputButtonComponent.c.

◆ SetTexture()

void SCR_InputButtonComponent::SetTexture	(	string	imagePath,
		string	image = string.Empty,
		Color	color = Color.FromInt(Color.WHITE),
		SCR_EButtonSize	buttonType = SCR_EButtonSize.KEYBOARD_MEDIUM )

inlineprotected

Override texture in Button

Parameters

ImagePath
Image	name if using ImageSet. Default: null
Color	of the Image

Definition at line 1019 of file SCR_InputButtonComponent.c.

◆ UpdateComboIndicatorSizes()

void SCR_InputButtonComponent::UpdateComboIndicatorSizes ( )

inlineprotected

Definition at line 1195 of file SCR_InputButtonComponent.c.

Member Data Documentation

◆ COMBO_DIVIDER_KEY

const string SCR_InputButtonComponent::COMBO_DIVIDER_KEY = " | "

protected

Definition at line 99 of file SCR_InputButtonComponent.c.

◆ COMBO_INDICATOR_COMBO_NAME

const string SCR_InputButtonComponent::COMBO_INDICATOR_COMBO_NAME = "keybind_combo"

protected

Definition at line 97 of file SCR_InputButtonComponent.c.

◆ COMBO_INDICATOR_DIVIDER_NAME

const string SCR_InputButtonComponent::COMBO_INDICATOR_DIVIDER_NAME = "keybind_divider"

protected

Definition at line 96 of file SCR_InputButtonComponent.c.

◆ COMBO_INDICATOR_IMAGE_NAME

const string SCR_InputButtonComponent::COMBO_INDICATOR_IMAGE_NAME = "ComboIndicatorImg"

protected

Definition at line 94 of file SCR_InputButtonComponent.c.

◆ COMBO_INDICATOR_KEY

const string SCR_InputButtonComponent::COMBO_INDICATOR_KEY = " + "

protected

Definition at line 98 of file SCR_InputButtonComponent.c.

◆ COMBO_INDICATOR_PADDING_MULTIPLIER_LEFT

const float SCR_InputButtonComponent::COMBO_INDICATOR_PADDING_MULTIPLIER_LEFT = 0.20

protected

Definition at line 104 of file SCR_InputButtonComponent.c.

◆ COMBO_INDICATOR_PADDING_MULTIPLIER_RIGHT

const float SCR_InputButtonComponent::COMBO_INDICATOR_PADDING_MULTIPLIER_RIGHT = 0.15

protected

Definition at line 105 of file SCR_InputButtonComponent.c.

◆ COMBO_INDICATOR_SHADOW_NAME

const string SCR_InputButtonComponent::COMBO_INDICATOR_SHADOW_NAME = "ComboIndicatorShadow"

protected

Definition at line 95 of file SCR_InputButtonComponent.c.

◆ COMBO_INDICATOR_SIZE_MULTIPLIER

const float SCR_InputButtonComponent::COMBO_INDICATOR_SIZE_MULTIPLIER = 0.5

protected

Definition at line 101 of file SCR_InputButtonComponent.c.

◆ m_aComboIndicators

ref array<SizeLayoutWidget> SCR_InputButtonComponent::m_aComboIndicators = {}

protected

Definition at line 113 of file SCR_InputButtonComponent.c.

◆ m_aComboWidgets

ref array<Widget> SCR_InputButtonComponent::m_aComboWidgets = {}

protected

Definition at line 114 of file SCR_InputButtonComponent.c.

◆ m_ActionDefault

ref Color SCR_InputButtonComponent::m_ActionDefault

protected

Definition at line 26 of file SCR_InputButtonComponent.c.

◆ m_ActionDisabled

ref Color SCR_InputButtonComponent::m_ActionDisabled

protected

Definition at line 32 of file SCR_InputButtonComponent.c.

◆ m_ActionHovered

ref Color SCR_InputButtonComponent::m_ActionHovered

protected

Definition at line 29 of file SCR_InputButtonComponent.c.

◆ m_ActionToggled

ref Color SCR_InputButtonComponent::m_ActionToggled

protected

Definition at line 44 of file SCR_InputButtonComponent.c.

◆ m_ActionUnbound

ref Color SCR_InputButtonComponent::m_ActionUnbound

protected

Definition at line 35 of file SCR_InputButtonComponent.c.

◆ m_aDialogs

ref array<DialogUI> SCR_InputButtonComponent::m_aDialogs = {}

protected

Definition at line 160 of file SCR_InputButtonComponent.c.

◆ m_aFilterStack

ref array<BaseContainer> SCR_InputButtonComponent::m_aFilterStack = {}

protected

Definition at line 115 of file SCR_InputButtonComponent.c.

◆ m_aFilterStackIndexRemover

ref array<int> SCR_InputButtonComponent::m_aFilterStackIndexRemover = {}

protected

Definition at line 116 of file SCR_InputButtonComponent.c.

◆ m_aKeyStackArray

ref array<string> SCR_InputButtonComponent::m_aKeyStackArray = {}

protected

Definition at line 117 of file SCR_InputButtonComponent.c.

◆ m_bCanBeDisabled

bool SCR_InputButtonComponent::m_bCanBeDisabled

protected

Definition at line 59 of file SCR_InputButtonComponent.c.

◆ m_bChangeLabelColorOnDisabled

bool SCR_InputButtonComponent::m_bChangeLabelColorOnDisabled

protected

Definition at line 62 of file SCR_InputButtonComponent.c.

◆ m_bDebugSimulateController

bool SCR_InputButtonComponent::m_bDebugSimulateController

protected

Definition at line 92 of file SCR_InputButtonComponent.c.

◆ m_bDisableClickSound

bool SCR_InputButtonComponent::m_bDisableClickSound

protected

Definition at line 47 of file SCR_InputButtonComponent.c.

◆ m_bForceDisabled

bool SCR_InputButtonComponent::m_bForceDisabled

protected

Definition at line 128 of file SCR_InputButtonComponent.c.

◆ m_bForceUpdate

bool SCR_InputButtonComponent::m_bForceUpdate

protected

If user changed keybing then it should force update of hints.

Definition at line 133 of file SCR_InputButtonComponent.c.

◆ m_bIsAlternativeInput

bool SCR_InputButtonComponent::m_bIsAlternativeInput

protected

Definition at line 122 of file SCR_InputButtonComponent.c.

◆ m_bIsComboInput

bool SCR_InputButtonComponent::m_bIsComboInput

protected

Definition at line 121 of file SCR_InputButtonComponent.c.

◆ m_bIsContinuous

bool SCR_InputButtonComponent::m_bIsContinuous

protected

Definition at line 126 of file SCR_InputButtonComponent.c.

◆ m_bIsDoubleTapAction

bool SCR_InputButtonComponent::m_bIsDoubleTapAction

protected

Definition at line 124 of file SCR_InputButtonComponent.c.

◆ m_bIsDoubleTapStated

bool SCR_InputButtonComponent::m_bIsDoubleTapStated

protected

Definition at line 139 of file SCR_InputButtonComponent.c.

◆ m_bIsHoldAction

bool SCR_InputButtonComponent::m_bIsHoldAction

protected

Definition at line 123 of file SCR_InputButtonComponent.c.

◆ m_bIsHoldingButton

bool SCR_InputButtonComponent::m_bIsHoldingButton

protected

Definition at line 137 of file SCR_InputButtonComponent.c.

◆ m_bIsHovered

bool SCR_InputButtonComponent::m_bIsHovered

protected

Definition at line 138 of file SCR_InputButtonComponent.c.

◆ m_bIsInteractionActive

bool SCR_InputButtonComponent::m_bIsInteractionActive

protected

Definition at line 130 of file SCR_InputButtonComponent.c.

◆ m_bIsMouseInput

bool SCR_InputButtonComponent::m_bIsMouseInput

protected

Definition at line 17 of file SCR_InputButtonComponent.c.

◆ m_bKeybindActive

bool SCR_InputButtonComponent::m_bKeybindActive

protected

Definition at line 8 of file SCR_InputButtonComponent.c.

◆ m_bOverrideTextSize

bool SCR_InputButtonComponent::m_bOverrideTextSize

protected

Definition at line 86 of file SCR_InputButtonComponent.c.

◆ m_bPressedInput

bool SCR_InputButtonComponent::m_bPressedInput

protected

Definition at line 125 of file SCR_InputButtonComponent.c.

◆ m_bShouldBeEnabled

bool SCR_InputButtonComponent::m_bShouldBeEnabled

protected

Definition at line 129 of file SCR_InputButtonComponent.c.

◆ m_ButtonDisplay

ref SCR_InputButtonDisplay SCR_InputButtonComponent::m_ButtonDisplay

protected

Definition at line 109 of file SCR_InputButtonComponent.c.

◆ m_eCurrentInputDevice

EInputDeviceType SCR_InputButtonComponent::m_eCurrentInputDevice

protected

Definition at line 147 of file SCR_InputButtonComponent.c.

◆ m_fDefaultClickTime

float SCR_InputButtonComponent::m_fDefaultClickTime

protected

Definition at line 142 of file SCR_InputButtonComponent.c.

◆ m_fDefaultHoldTime

float SCR_InputButtonComponent::m_fDefaultHoldTime

protected

Definition at line 141 of file SCR_InputButtonComponent.c.

◆ m_fHoldIndicatorAnimationTime

float SCR_InputButtonComponent::m_fHoldIndicatorAnimationTime

protected

Definition at line 56 of file SCR_InputButtonComponent.c.

◆ m_fHoldIndicatorDefaultPosition

float SCR_InputButtonComponent::m_fHoldIndicatorDefaultPosition

protected

Definition at line 50 of file SCR_InputButtonComponent.c.

◆ m_fHoldIndicatorHoldPosition

float SCR_InputButtonComponent::m_fHoldIndicatorHoldPosition

protected

Definition at line 53 of file SCR_InputButtonComponent.c.

◆ m_fHoldTimeReduction

float SCR_InputButtonComponent::m_fHoldTimeReduction

protected

Definition at line 89 of file SCR_InputButtonComponent.c.

◆ m_fMaxHoldtime

float SCR_InputButtonComponent::m_fMaxHoldtime

protected

Definition at line 143 of file SCR_InputButtonComponent.c.

◆ m_iDoubleTapThreshold

int SCR_InputButtonComponent::m_iDoubleTapThreshold

protected

Definition at line 145 of file SCR_InputButtonComponent.c.

◆ m_iHeightInPixel

int SCR_InputButtonComponent::m_iHeightInPixel

protected

Definition at line 23 of file SCR_InputButtonComponent.c.

◆ m_iMaxShownKeys

int SCR_InputButtonComponent::m_iMaxShownKeys

protected

Definition at line 20 of file SCR_InputButtonComponent.c.

◆ m_InputManager

InputManager SCR_InputButtonComponent::m_InputManager = GetGame().GetInputManager()

protected

Definition at line 119 of file SCR_InputButtonComponent.c.

◆ m_LabelDefault

ref Color SCR_InputButtonComponent::m_LabelDefault

protected

Definition at line 41 of file SCR_InputButtonComponent.c.

◆ m_OnActivated

ref ScriptInvoker SCR_InputButtonComponent::m_OnActivated = new ScriptInvoker()

protected

Definition at line 153 of file SCR_InputButtonComponent.c.

◆ m_OnAnimateHover

ref ScriptInvokerVoid SCR_InputButtonComponent::m_OnAnimateHover

protected

Definition at line 149 of file SCR_InputButtonComponent.c.

◆ m_OnHoldAnimComplete

ref ScriptInvokerVoid SCR_InputButtonComponent::m_OnHoldAnimComplete

protected

Definition at line 151 of file SCR_InputButtonComponent.c.

◆ m_OnUpdateEnableColor

ref ScriptInvokerVoid SCR_InputButtonComponent::m_OnUpdateEnableColor

protected

Definition at line 150 of file SCR_InputButtonComponent.c.

◆ m_sActionName

string SCR_InputButtonComponent::m_sActionName

protected

Definition at line 11 of file SCR_InputButtonComponent.c.

◆ m_sActionUnboundIcon

string SCR_InputButtonComponent::m_sActionUnboundIcon

protected

Definition at line 38 of file SCR_InputButtonComponent.c.

◆ m_sButtonWidgetName

string SCR_InputButtonComponent::m_sButtonWidgetName

protected

Definition at line 65 of file SCR_InputButtonComponent.c.

◆ m_sComboIndicatorImageSet

ResourceName SCR_InputButtonComponent::m_sComboIndicatorImageSet

protected

Definition at line 80 of file SCR_InputButtonComponent.c.

◆ m_sComboIndicatorImageSetGlow

ResourceName SCR_InputButtonComponent::m_sComboIndicatorImageSetGlow

protected

Definition at line 83 of file SCR_InputButtonComponent.c.

◆ m_sComboIndicatorWidget

ResourceName SCR_InputButtonComponent::m_sComboIndicatorWidget

protected

Definition at line 77 of file SCR_InputButtonComponent.c.

◆ m_sHorizontalLayoutWidget

string SCR_InputButtonComponent::m_sHorizontalLayoutWidget

protected

Definition at line 68 of file SCR_InputButtonComponent.c.

◆ m_sInputButtonWidget

ResourceName SCR_InputButtonComponent::m_sInputButtonWidget

protected

Definition at line 74 of file SCR_InputButtonComponent.c.

◆ m_sLabel

string SCR_InputButtonComponent::m_sLabel

protected

Definition at line 14 of file SCR_InputButtonComponent.c.

◆ m_sOldActionName

string SCR_InputButtonComponent::m_sOldActionName

protected

Definition at line 135 of file SCR_InputButtonComponent.c.

◆ m_sTextHintWidget

string SCR_InputButtonComponent::m_sTextHintWidget

protected

Definition at line 71 of file SCR_InputButtonComponent.c.

◆ m_wHorizontalLayout

Widget SCR_InputButtonComponent::m_wHorizontalLayout

protected

Definition at line 110 of file SCR_InputButtonComponent.c.

◆ m_wTextHint

RichTextWidget SCR_InputButtonComponent::m_wTextHint

protected

Definition at line 111 of file SCR_InputButtonComponent.c.

◆ MIN_FONTSIZE_MULTIPLIER

const float SCR_InputButtonComponent::MIN_FONTSIZE_MULTIPLIER = 0.5

protected

Definition at line 107 of file SCR_InputButtonComponent.c.

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

scripts/Game/UI/Components/WidgetLibrary/SCR_InputButton/SCR_InputButtonComponent.c

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ ActionPressed()

◆ ActionReleased()

◆ ChangeInputDevice()

◆ ChangeInputVisibility()

◆ CreateComboWidget()

◆ DeleteComboWidget()

◆ FindComponent()

◆ GetAnimationRate()

◆ GetAnimationTime()

◆ GetForceDisabled()

◆ GetInputButtonComponent()

◆ GetInputFilterSettings()

◆ GetIsHoldingButton()

◆ GetIsInputCombo()

◆ GetOnAnimateHover()

◆ GetOnHoldAnimComplete()

◆ GetOnUpdateEnableColor()

◆ GetSize()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ IsClickSoundDisabled()

◆ IsHovering()

◆ IsInTopDialog()

◆ IsInTopMenu()

◆ IsKeybindAvailable()

◆ OnActiveWidgetInteraction()

◆ OnButtonHold()

◆ OnButtonPressed()

◆ OnClick()

◆ OnDialogClose()

◆ OnDialogOpen()

◆ OnDisabled()

◆ OnDoubleClick()

◆ OnEnabled()

◆ OnInput()

◆ OnInputDeviceUserChanged()

◆ OnMenuFocusGained()

◆ OnMenuFocusLost()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ OnSettingsMenuClosed()

◆ PlaySoundClicked()

◆ ProcessFilterStack()

◆ ProcessKeybindStack()

◆ ResetTexture()

◆ SetAction()

◆ SetClickSoundDisabled()

◆ SetColorActionDisabled()

◆ SetEnabled()

◆ SetEnabled_Internal()

◆ SetForceDisabled()

◆ SetForceDisabledWithDelay()

◆ SetInputAction()

◆ SetIsHoldingButton()

◆ SetLabel()

◆ SetLabelColor()

◆ SetSize()

◆ SetTexture()

◆ UpdateComboIndicatorSizes()

Member Data Documentation

◆ COMBO_DIVIDER_KEY

◆ COMBO_INDICATOR_COMBO_NAME

◆ COMBO_INDICATOR_DIVIDER_NAME

◆ COMBO_INDICATOR_IMAGE_NAME

◆ COMBO_INDICATOR_KEY

◆ COMBO_INDICATOR_PADDING_MULTIPLIER_LEFT

◆ COMBO_INDICATOR_PADDING_MULTIPLIER_RIGHT

◆ COMBO_INDICATOR_SHADOW_NAME

◆ COMBO_INDICATOR_SIZE_MULTIPLIER

◆ m_aComboIndicators

◆ m_aComboWidgets

◆ m_ActionDefault

◆ m_ActionDisabled

◆ m_ActionHovered

◆ m_ActionToggled