NumberField
Written by Hypixel Studios Canada Inc.
NumberField
Accepts child elements: No
A number field which lets the user enter text with their keyboard. Once the field loses focus its text content will be sanitized to the last valid number entered
Properties
| Name | Type | Description |
|---|---|---|
| Value | Decimal | |
| PasswordChar | Char | Replaces all character occurences in this field with the specified character. Used for password fields |
| 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 |
| Format | NumberFieldFormat | Number value options |
| Style | InputFieldStyle | Text style properties |
| PlaceholderStyle | InputFieldStyle | Text style properties for placeholder text |
| Decoration | InputFieldDecorationStyle | Field style properties |
| AutoFocus | Boolean | If true, the element will automatically set itself as the focused element when after being mounted. If there is other elements with AutoFocus on, then the last element getting mounted will be the last to be focused |
| AutoSelectAll | Boolean | Automatically selects all text after being mounted. This property won't work unless AutoFocus is turned on as well |
| IsReadOnly | Boolean | Whether the value of this field can be edited or not |
| MaxLength | Integer | The maximum amount of characters that can be entered into this field |
| 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 |
|---|---|
| RightClicking | |
| Validating | |
| Dismissing | |
| FocusLost | |
| FocusGained | |
| ValueChanged |