BackButton
Written by Hypixel Studios Canada Inc.
BackButton
Accepts child elements: No
Properties
| Name | Type | Description |
|---|---|---|
| ActionName | String | |
| KeyBindingLabel | String | |
| BindingModifier1Label | String | |
| BindingModifier2Label | String | |
| IsAvailable | Boolean | |
| IsHoldBinding | Boolean | Whether this keybinding needs to be held down |
| Alignment | ActionButtonAlignment | |
| LayoutMode | LayoutMode | Determines how child elements will be laid out |
| Visible | Boolean | Hides the element. Makes the parent layouting skip this element as well |
| HitTestVisible | Boolean | By default, most elements won't return themselves during a HitTest check unless they expose certain functionality that requires them to (e.g. a button). This means that elements visually underneath them might receive the input event instead. If you want this element to be returned during a HitTest set this to true |
| TooltipText | String | Enables a text tooltip and sets the text to show. The tooltip will be shown while the mouse cursor is on this element |
| TooltipTextSpans | List<LabelSpan> | Enables a text tooltip and sets the text spans to show. The tooltip will be shown while the mouse cursor is on this element |
| TextTooltipStyle | TextTooltipStyle | Style options for the text tooltip |
| TextTooltipShowDelay | Float | Specifies a delay in seconds for long the mouse has to stay on this element for the tooltip to appear |
| Disabled | Boolean | Whether the button is clickable or not. If true mouse click related event callbacks won't be triggered anymore |
| Style | ButtonStyle | Button style |
| Anchor | Anchor | Defines how the element should be laid out inside its allocated area |
| Padding | Padding | Defines how much space to keep around the content. Background is unaffected. |
| FlexWeight | Integer | FlexWeight can be used to distribute any left-over space after explicit widths/heights have been subtracted |
| ContentWidth | Integer | If set, this element will display a horizontal scrollbar |
| ContentHeight | Integer | If set, this element will display a vertical scrollbar |
| AutoScrollDown | Boolean | Makes the element automatically scroll down to the bottom of the element. The element won't try to scroll down if it has been scrolled up |
| KeepScrollPosition | Boolean | Whether to keep the scrolling position, even after the element has been unmounted |
| MouseWheelScrollBehaviour | MouseWheelScrollBehaviourType | |
| Background | PatchStyle / String | Sets a background image or color |
| MaskTexturePath | UI Path (String) | Sets a mask texture to be used for clipping. (Doesn't support 9-patches yet) |
| OutlineColor | Color | Sets the color for the outline to render |
| OutlineSize | Float | Draws a basic outline around the element with the specified size |
| Overscroll | Boolean | If enabled scrolling areas will be extended by the size of the element |
Event Callbacks
| Name | Description |
|---|---|
| Activating | |
| DoubleClicking | |
| RightClicking | |
| MouseEntered | |
| MouseExited |