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

Public Member Functions

override void Init (Widget w, SCR_BaseEditorAttribute attribute)
 Initialize GUI from attribute.
 
override void SetVariableToDefaultValue (SCR_BaseEditorAttributeVar var)
 
override void SetFromVar (SCR_BaseEditorAttributeVar var)
 Update GUI from attribute variable.
 
SCR_ToolboxComponent GetToolboxComponent ()
 Get toolbox component of the attribute UI.
 
SCR_BaseEditorAttributeFloatStringValues GetButtonBoxData ()
 Get toolbox component of the attribute UI.
 
override void ToggleButtonSelected (bool selected, int index, bool animated=true)
 
override bool OnChange (Widget w, int x, int y, bool finished)
 
override void HandlerDeattached (Widget w)
 
- Public Member Functions inherited from SCR_BaseEditorAttributeUIComponent
SCR_BaseEditorAttribute GetAttribute ()
 Get attribute this component represents.
 
void SetFromVar (SCR_BaseEditorAttributeVar var)
 Update GUI from attribute variable.
 
void Init (Widget w, SCR_BaseEditorAttribute attribute)
 Initialize GUI from attribute.
 
override bool OnChange (Widget w, int x, int y, bool finished)
 
void ShowButtonDescription (SCR_AttributeButtonUIComponent button, bool showButtonDescription, string buttonDescription=string.Empty)
 
ScriptInvoker GetOnAttributeChanged ()
 Called on attribute changed via UI.
 
ScriptInvoker GetOnAttributeUIFocusChanged ()
 Called on focus changes.
 
ScriptInvoker GetOnEnabledByAttribute ()
 Called when another attribute enables/disables the attribute.
 
ScriptInvoker GetOnMouseLeave ()
 Called when the mouse leaves the attribute.
 
bool GetTickboxEnabled ()
 Get if tickbox is enabled or not.
 
void ToggleEnableAttributeTickbox ()
 Toggle tickbox UI, flipping the tickbox from true to false and viceversa.
 
bool GetIsFocused ()
 Get if attribute is focused /return if attribute is focused.
 
override bool OnFocus (Widget w, int x, int y)
 
override bool OnFocusLost (Widget w, int x, int y)
 
override bool OnMouseEnter (Widget w, int x, int y)
 
override bool OnMouseLeave (Widget w, Widget enterW, int x, int y)
 
override void HandlerDeattached (Widget w)
 

Protected Member Functions

void DelayedInit (bool hasIcon, bool hasDescription)
 
void OnSingleButton (SCR_ToolboxComponent toolbox, int index, bool state)
 
void OnSelectableButton (SCR_ToolboxComponent toolbox, int index)
 
void OnMultiSelectButton (SCR_ToolboxComponent toolbox, int index, bool state)
 
void UpdateButtonBorder (int selectedIndex)
 
void DelayedButtonRandomizer (int currentIndex)
 
- Protected Member Functions inherited from SCR_BaseEditorAttributeUIComponent
void SetFromVarExternal (SCR_BaseEditorAttributeVar var, bool isReset)
 
void SetFromVarOrDefault ()
 
void ToggleButtonSelected (bool selected, int index, bool animated=true)
 
void SetAsSubAttribute ()
 
void AttributeValueChanged ()
 
void ShowAttributeDescription ()
 
void HideAttributeDescription ()
 
void SetVariableToDefaultValue (SCR_BaseEditorAttributeVar var)
 
void ToggleEnableAttribute (bool enabled)
 
void ToggleEnable (bool enabled)
 Toggle UI enabled.
 
void OnTickboxToggleChanged (bool toggle)
 
void GamePadLockedSelectorFocusChanged (bool newFocus)
 
void OnFocusAttributeWidget (Widget w)
 Callback for focus of widget used.
 
void SetGamepadLockSelectorActive (bool isGamepad)
 

Protected Attributes

EAttributeToolBoxType m_ToolboxType
 
LocalizedString m_sRandomizeButtonLabel
 
ResourceName m_sButtonWithIcon
 
ResourceName m_sEmptyButton
 
int m_iRandomizerButtonStart
 
bool m_bShowBorderOnHover
 
SCR_ToolboxComponent m_ToolBoxComponent
 
ref SCR_BaseEditorAttributeFloatStringValues m_ButtonBoxData
 
bool m_bButtonValueInitCalled
 
bool m_bHasRandomizeButton
 
bool m_bSelectionButtonIsSelected = true
 
- Protected Attributes inherited from SCR_BaseEditorAttributeUIComponent
string m_sUiComponentName
 
string m_sTickBoxAttributeName
 
string m_sAttributeHolder
 
string m_sGamePadLockedSelectorName
 
string m_sSubAttributeIndicatorName
 
float m_fSubAttributeDisabledAlphaColor
 
ref SCR_EditorAttributeUIInfo m_ButtonDescriptionUIInfo = new SCR_EditorAttributeUIInfo
 
SCR_AttributeButtonUIComponent m_ActiveButtonDescription
 
SCR_ChangeableComponentBase m_UIComponent
 
float m_fBottomPadding = 1
 
bool m_bIsSubAttribute
 
SCR_AttributeTickboxUIComponent m_TickBoxAttribute
 
Widget m_GamePadLockedSelector
 
SCR_AttributesManagerEditorComponent m_AttributeManager
 
InputManager m_InputManager
 
Widget m_SubAttributeIndicator
 
Widget m_wAttributeHolder
 
bool m_bEnabledByAttribute
 
bool m_bEnabledByTickbox
 
bool m_bIsFocused
 
bool m_bIsShowingDescription
 
bool m_bShowButtonDescription
 
string m_sButtonDescription
 
string m_sButtonDescriptionParam1
 
ref ScriptInvoker Event_OnAttributeChanged = new ScriptInvoker
 
ref ScriptInvoker Event_OnEnabledByAttribute = new ScriptInvoker
 
ref ScriptInvoker Event_OnAttributeUIFocusChanged = new ScriptInvoker
 
ref ScriptInvoker Event_OnInputDeviceChanged = new ScriptInvoker
 
ref ScriptInvoker Event_OnMouseLeave = new ScriptInvoker
 

Member Function Documentation

◆ DelayedButtonRandomizer()

void SCR_ButtonBoxAttributeUIComponent.DelayedButtonRandomizer ( int  currentIndex)
protected

◆ DelayedInit()

void SCR_ButtonBoxAttributeUIComponent.DelayedInit ( bool  hasIcon,
bool  hasDescription 
)
protected

◆ GetButtonBoxData()

SCR_BaseEditorAttributeFloatStringValues SCR_ButtonBoxAttributeUIComponent.GetButtonBoxData ( )

Get toolbox component of the attribute UI.

Returns
Toolbox component

◆ GetToolboxComponent()

SCR_ToolboxComponent SCR_ButtonBoxAttributeUIComponent.GetToolboxComponent ( )

Get toolbox component of the attribute UI.

Returns
Toolbox component

◆ HandlerDeattached()

override void SCR_ButtonBoxAttributeUIComponent.HandlerDeattached ( Widget  w)

◆ Init()

override void SCR_ButtonBoxAttributeUIComponent.Init ( Widget  w,
SCR_BaseEditorAttribute  attribute 
)

Initialize GUI from attribute.

To be overridden by inherited classes.

Parameters
wWidget this component is attached to
attributeEditor attribute this component represents

Implements SCR_BaseEditorAttributeUIComponent.

Implemented in SCR_ButtonBoxMultiSelectAttributeUIComponent.

◆ OnChange()

override bool SCR_ButtonBoxAttributeUIComponent.OnChange ( Widget  w,
int  x,
int  y,
bool  finished 
)

◆ OnMultiSelectButton()

void SCR_ButtonBoxAttributeUIComponent.OnMultiSelectButton ( SCR_ToolboxComponent  toolbox,
int  index,
bool  state 
)
protected

◆ OnSelectableButton()

void SCR_ButtonBoxAttributeUIComponent.OnSelectableButton ( SCR_ToolboxComponent  toolbox,
int  index 
)
protected

◆ OnSingleButton()

void SCR_ButtonBoxAttributeUIComponent.OnSingleButton ( SCR_ToolboxComponent  toolbox,
int  index,
bool  state 
)
protected

◆ SetFromVar()

override void SCR_ButtonBoxAttributeUIComponent.SetFromVar ( SCR_BaseEditorAttributeVar  var)

Update GUI from attribute variable.

Called when attributes are initialized in a dialog or when they are reset based on user request.

Parameters
varAttribute variable

Implements SCR_BaseEditorAttributeUIComponent.

Implemented in SCR_ButtonBoxMultiSelectAttributeUIComponent, and SCR_TimePresetsAttributeUIComponent.

◆ SetVariableToDefaultValue()

override void SCR_ButtonBoxAttributeUIComponent.SetVariableToDefaultValue ( SCR_BaseEditorAttributeVar  var)

◆ ToggleButtonSelected()

override void SCR_ButtonBoxAttributeUIComponent.ToggleButtonSelected ( bool  selected,
int  index,
bool  animated = true 
)

◆ UpdateButtonBorder()

void SCR_ButtonBoxAttributeUIComponent.UpdateButtonBorder ( int  selectedIndex)
protected

Member Data Documentation

◆ m_bButtonValueInitCalled

bool SCR_ButtonBoxAttributeUIComponent.m_bButtonValueInitCalled
protected

◆ m_bHasRandomizeButton

bool SCR_ButtonBoxAttributeUIComponent.m_bHasRandomizeButton
protected

◆ m_bSelectionButtonIsSelected

bool SCR_ButtonBoxAttributeUIComponent.m_bSelectionButtonIsSelected = true
protected

◆ m_bShowBorderOnHover

bool SCR_ButtonBoxAttributeUIComponent.m_bShowBorderOnHover
protected

◆ m_ButtonBoxData

ref SCR_BaseEditorAttributeFloatStringValues SCR_ButtonBoxAttributeUIComponent.m_ButtonBoxData
protected

◆ m_iRandomizerButtonStart

int SCR_ButtonBoxAttributeUIComponent.m_iRandomizerButtonStart
protected

◆ m_sButtonWithIcon

ResourceName SCR_ButtonBoxAttributeUIComponent.m_sButtonWithIcon
protected

◆ m_sEmptyButton

ResourceName SCR_ButtonBoxAttributeUIComponent.m_sEmptyButton
protected

◆ m_sRandomizeButtonLabel

LocalizedString SCR_ButtonBoxAttributeUIComponent.m_sRandomizeButtonLabel
protected

◆ m_ToolBoxComponent

SCR_ToolboxComponent SCR_ButtonBoxAttributeUIComponent.m_ToolBoxComponent
protected

◆ m_ToolboxType

EAttributeToolBoxType SCR_ButtonBoxAttributeUIComponent.m_ToolboxType
protected

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