SCR_DeployButton Interface Reference

Component that handles the request respawn button. More...

Inheritance diagram for SCR_DeployButton:

Public Member Functions
override void	HandlerAttached (Widget w)
void	SetSuppliesEnabled (bool enabled)
void	SetSupplyCost (int cost)
int	GetSupplyCost ()
void	SetText (bool deployEnabled, string text, float remainingTime=-1)
	Set text of the button.
void	UpdateSpinner (float timeSlice)
	Update the loading spinner widget.
void	ShowLoading (bool show)
	Set loading spinner widget visible.
void	UpdateBackground ()
	Change color of background depending on if button is enabled.
Public Member Functions inherited from SCR_InputButtonComponent
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override void	SetEnabled (bool enabled, bool animate=true)
override bool	OnMouseButtonDown (Widget w, int x, int y, int button)
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)
	Called when button is held.
void	PlaySoundClicked ()
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)
	Iterate trough key bind stack.
void	ProcessFilterStack ()
	Delete not needed entries from m_aFilterStack and bring it into correct order !
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)
	Override action.
int	GetSize ()
void	SetSize (int size)
	Change the size of the button.
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)
	Override texture in Button.
void	ResetTexture ()
	Restet Button back to it's default texutre Use after SetTexture() to undo the override.
void	SetColorActionDisabled (Color newColor)
bool	IsHovering ()
void	OnActiveWidgetInteraction (bool isInteractionActive, int delay)
void	OnDialogOpen (DialogUI dialog)
void	OnDialogClose (DialogUI dialog)
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 ()
Public Member Functions inherited from SCR_ButtonBaseComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (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 bool	OnFocus (Widget w, int x, int y)
override bool	OnFocusLost (Widget w, int x, int y)
void	SetToggled (bool toggled, bool animate=true, bool invokeChange=true, bool instant=false)
bool	IsToggled ()
void	SetToggleable (bool togglable)
bool	GetToggleable ()
void	ShowBorder (bool show, bool animate=true)
bool	IsBorderShown ()
void	SetBackgroundColors (Color defColor=null, Color hoverColor=null, Color selectColor=null, Color selectHoverColor=null, Color clickColor=null)
	Alternate way of setting button background colors through script.
void	ColorizeBackground (bool animate=true)
Public Member Functions inherited from SCR_WLibComponentBase
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnFocus (Widget w, int x, int y)
void	SetHoverSound (string soundHover)
void	SetClickedSound (string soundClicked)
string	GetHoverSound ()
string	GetClickedSound ()
void	SetEnabled (bool enabled, bool animate=true)
void	SetVisible (bool visible, bool animate=true)
bool	IsEnabled ()
void	SetMouseOverToFocus (bool mouseOverToFocus)
void	SetDisabledOpacity (float newDisabledOpacity)
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Protected Attributes
string	m_sText
string	m_sShortcutName
string	m_sTextHolderName
TextWidget	m_wText
Widget	m_wShortcut
Widget	m_wTextHolder
string	m_sLoadingSpinner
string	m_sBackground
Widget	m_wLoadingSpinner
Widget	m_wSupplies
Widget	m_wBackgroundWidget
RichTextWidget	m_wSuppliesText
SCR_LoadingSpinner	m_LoadingSpinner
int	m_iSupplyCost
bool	m_bSuppliesEnabled
Protected Attributes inherited from SCR_InputButtonComponent
string	m_sActionName
string	m_sLabel
bool	m_bIsMouseInput
int	m_iMaxShownKeys
ref Color	m_ActionUnbound
string	m_sActionUnboundIcon
bool	m_bDisableClickSound
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
ref SCR_InputButtonDisplay	m_ButtonDisplay
Widget	m_wHorizontalLayout
ImageWidget	m_wComboIndicatorImage
ImageWidget	m_wComboIndicatorShadow
RichTextWidget	m_wTextHint
ref array< Widget >	m_aComboWidgets = {}
ref array< BaseContainer >	m_aFilterStack = {}
ref array< int >	m_aFilterStackIndexRemover = {}
ref array< string >	m_aKeyStackArray = {}
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
float	m_fDefaultHoldTime
float	m_fDefaultClickTime
EInputDeviceType	m_eCurrentInputDevice
ref ScriptInvokerVoid	m_OnAnimateHover
ref ScriptInvokerVoid	m_OnUpdateEnableColor
ref ScriptInvokerVoid	m_OnHoldAnimComplete
ref array< DialogUI >	m_aDialogs = {}
Protected Attributes inherited from SCR_ButtonBaseComponent
bool	m_bIsToggled
MenuBase	m_ParentMenu
SCR_SubMenuBase	m_ParentSubMenu
Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered
string	m_sSoundClicked
float	m_fAnimationTime
bool	m_bMouseOverToFocus
float	m_fDisabledOpacity
float	m_fAnimationRate
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_InputButtonComponent
static SCR_InputButtonComponent	FindComponent (notnull Widget w)
static SCR_InputButtonComponent	GetInputButtonComponent (string name, notnull Widget parent, bool searchAllChildren=true)
	Static method to easily find component by providing name and parent.
Static Public Member Functions inherited from SCR_ButtonBaseComponent
static SCR_ButtonBaseComponent	GetButtonBase (string name, Widget parent, bool searchAllChildren=true)
Static Public Member Functions inherited from SCR_WLibComponentBase
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.
Public Attributes inherited from SCR_InputButtonComponent
int	m_iHeightInPixel
ref Color	m_ActionDefault
ref Color	m_ActionHovered
ref Color	m_ActionDisabled
ref Color	m_LabelDefault
ref Color	m_ActionToggled
float	m_fHoldIndicatorDefaultPosition
float	m_fHoldIndicatorHoldPosition
float	m_fHoldIndicatorAnimationTime
bool	m_bCanBeDisabled
bool	m_bChangeLabelColorOnDisabled
InputManager	m_InputManager = GetGame().GetInputManager()
bool	m_bIsHovered
bool	m_bIsDoubleTapStated
float	m_fMaxHoldtime
int	m_iDoubleTapThreshold
ref ScriptInvoker	m_OnActivated = new ScriptInvoker()
Public Attributes inherited from SCR_ButtonBaseComponent
bool	m_bCanBeToggled
bool	m_bUseColorization
ref Color	m_BackgroundDefault
ref Color	m_BackgroundHovered
ref Color	m_BackgroundSelected
ref Color	m_BackgroundSelectedHovered
ref Color	m_BackgroundClicked
bool	m_bShowBorderOnFocus
bool	m_bShowBackgroundOnFocus
bool	m_bNoBorderAnimation
bool	m_bNoBackgroundAnimation
bool	m_bShowBorderOnHover
Widget	m_wBackground
Widget	m_wBorder
ref ScriptInvoker	m_OnClicked = new ScriptInvoker()
ref ScriptInvoker	m_OnToggled = new ScriptInvoker()
ref ScriptInvoker< Widget >	m_OnFocus = new ScriptInvoker<Widget>()
ref ScriptInvoker< Widget >	m_OnFocusLost = new ScriptInvoker<Widget>()
ref ScriptInvoker	m_OnShowBorder = new ScriptInvoker()
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker
Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001
static const float	START_ANIMATION_PERIOD = 250
Protected Member Functions inherited from SCR_InputButtonComponent
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)
	Check for last used input device and get the correct keybind for it.
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)
void	OnInput ()
	Called when Button is clicked / key is presses.
void	ActionPressed (bool isHoldAction=false)
void	ActionReleased ()
void	SetForceDisabled (bool forceDisabled, bool animate=true)
void	SetForceDisabledWithDelay (bool forceDisabled, bool animate=true, int delay=0)
void	OnMenuFocusGained (ChimeraMenuBase menu)
void	OnMenuFocusLost (ChimeraMenuBase menu)
void	OnSettingsMenuClosed (ChimeraMenuBase menu)
	Callback method that is triggered when some menu is closed.
Protected Member Functions inherited from SCR_ButtonBaseComponent
void	OnMenuSelect ()
void	MenuSelectBase ()
void	FindParentMenu ()
	Finds the parent menu of this component.
bool	IsParentMenuFocused ()
	Returns true if parent menu is focused, or if there is no parent menu.
Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)
void	OnDisabled (bool animate)
bool	IsChildWidget (Widget parent, Widget child)
void	SetAnimationRate ()
void	PlaySound (string sound)
Static Protected Attributes inherited from SCR_InputButtonComponent
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 float	COMBO_INDICATOR_SIZE_MULTIPLIER = 0.5
const float	MIN_FONTSIZE_MULTIPLIER = 0.5

Detailed Description

Component that handles the request respawn button.

Member Function Documentation

GetSupplyCost()

int SCR_DeployButton.GetSupplyCost

(

)

Returns

HandlerAttached()

override void SCR_DeployButton.HandlerAttached

(

Widget

w

)

Implements SCR_InputButtonComponent.

SetSuppliesEnabled()

void SCR_DeployButton.SetSuppliesEnabled

(

bool

enabled

)

Parameters

[in]

enabled

SetSupplyCost()

void SCR_DeployButton.SetSupplyCost

(

int

cost

)

Parameters

[in]

cost

SetText()

void SCR_DeployButton.SetText	(	bool	deployEnabled,
		string	text,
		float	remainingTime = -1
	)

Set text of the button.

ShowLoading()

void SCR_DeployButton.ShowLoading

(

bool

show

)

Set loading spinner widget visible.

UpdateBackground()

void SCR_DeployButton.UpdateBackground

(

)

Change color of background depending on if button is enabled.

UpdateSpinner()

void SCR_DeployButton.UpdateSpinner

(

float

timeSlice

)

Update the loading spinner widget.

Member Data Documentation

m_bSuppliesEnabled

bool SCR_DeployButton.m_bSuppliesEnabled

protected

m_iSupplyCost

int SCR_DeployButton.m_iSupplyCost

protected

m_LoadingSpinner

SCR_LoadingSpinner SCR_DeployButton.m_LoadingSpinner

protected

m_sBackground

string SCR_DeployButton.m_sBackground

protected

m_sLoadingSpinner

string SCR_DeployButton.m_sLoadingSpinner

protected

m_sShortcutName

string SCR_DeployButton.m_sShortcutName

protected

m_sText

string SCR_DeployButton.m_sText

protected

m_sTextHolderName

string SCR_DeployButton.m_sTextHolderName

protected

m_wBackgroundWidget

Widget SCR_DeployButton.m_wBackgroundWidget

protected

m_wLoadingSpinner

Widget SCR_DeployButton.m_wLoadingSpinner

protected

m_wShortcut

Widget SCR_DeployButton.m_wShortcut

protected

m_wSupplies

Widget SCR_DeployButton.m_wSupplies

protected

m_wSuppliesText

RichTextWidget SCR_DeployButton.m_wSuppliesText

protected

m_wText

TextWidget SCR_DeployButton.m_wText

protected

m_wTextHolder

Widget SCR_DeployButton.m_wTextHolder

protected

---

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

• Game/UI/Menu/DeployMenu/SCR_DeployMenuBase.c