Widget Properties

Search our Site

At the top of the Widget Properties panel is a drop-down list that contains all the widgets currently in the selected UI Element. Selecting a Widget from this list will allow you to edit its settings. Widget selection can also be achieved through the Element Hierarchy.

With a Widget Selected there are three sub panels.

Sub Panel
Properties Contains all the property settings of the selected widget
Style Contains all the style settings of the selected widget. Note that these will automatically inherit values equal to the selected stylesheet if there is one applied. Changing these values while a stylesheet is applied will act as an override.
Event Contains all the event settings of the selected widget

Widget Properties
Name Name of the widget. Must be unique, without spaces.
ID ID of the widget that can be used within scripts to trigger functionality
Type The Type of the widget
Parent Set the parent of the widget. Only Panels and Windows can be set as parents. Defaults to (None)
Use Atlas Uses the assigned UI Element Atlas Map for texturing rather than individually assigned textures
Enabled Enable/Disable the Widget by default
Visible Shows/Hides the Widget by default
Clip Children Clip any part of a child widget that falls out of bounds of this Widget
Position Set the position of the widget relative to its parent. If the widget does not have a parent, the position is set relative to the position of the UI Element.
Size Set the size of the Widget.

Panel Properties
Name Name of the widget. Must be unique, without spaces.

Label Properties
Text Set the text of the label
Font Select the font to use to render the label. Font’s must first be created inside the Font Manager to appear in the drop down list.
Font Size Set the font size to draw the label at. Note that if you are not using a Font which is utilising Signed Distance Fields, large font sizes can create pixel artifacts.
Line Length Set the maximum length of the label in pixels before a new line will start. Note that if line length is too short, it can make long words disappear
Centered Set the text to be aligned centerally. The central point is determined using a combination of the Label position and the Line Length.
Space Width Modifier Modify the space between characters in a label
Line Height Modifier Modify the space between lines in a label

Button Properties
Button
Checkable Sets whether the button is checkable when a user pressed on it
Checked Sets whether the button is checked. Note this will have no effect if the Checkable setting is disabled.
Border Sets the width of the border around the widget in pixels
Icon
Show Icon Show/Hide the icon inside the button
Border Sets the width of the border around the icon in pixels
Offset Sets the position of the icon insider the button relative to the button’s position.
Size Sets the size of the icon

Check Box Properties
Checked Sets whether or not the checkbox is currently checked
Border Set the width of the border around the background panel of the check box in pixels

Progress Bar Properties
Bottom Edge
Show Edge Show/Hide the bottom edge of the progress bar
Border Sets the width of the border around the bottom edge of the progress bar in pixels
Thickness Sets the thickness of the bottom edge of the progress bar
Left Edge
Show Edge Show/Hide the left edge of the progress bar
Border Sets the width of the border around the left edge of the progress bar in pixels
Thickness Sets the width of the border around the left edge of the progress bar in pixels
Progress Bar
Value Sets the current value of the progress bar (0 to 100)
Background Border Sets the width of the border around the background panel of the progress bar in pixels
Foreground Border Sets the width of the border around the foreground panel of the progress bar in pixels
Fill Method Sets the direction the progress bar should be filled from
  • Left to Right
  • Right to Left
  • Bottom to Top
  • Top to Bottom
  • Horizontal Center Out
  • Vertical Center Out
Fill Mode Sets how the progress bar fills out. If you are not using a texture to style the foreground of the progress bar, it is more efficient to select the Stretch option.
  • Stretch – The UV coordinates of the foreground are not adjusted. This can make textures appear squashed or stretched.
  • Reveal – The UV coordinates of the foreground are adjusted to reveal the fill texture eliminating any stretching or squashing artefacts.
Right Edge
Show Edge Show/Hide the right edge of the progress bar
Border Sets the width of the border around the right edge of the progress bar in pixels
Thickness Sets the thickness of the right edge of the progress bar
Top Edge
Show Edge Show/Hide the top edge of the progress bar
Border Sets the width of the border around the top edge of the progress bar in pixels
Thickness Sets the thickness of the top edge of the progress bar

Horizontal Slider Properties
Left Fill
Left Fill Show/Hide the left fill panel.
Border Sets the width of the border of the left fill panel in pixels
Right Fill
Right Fill Show/Hide the right fill panel.
Border Sets the width of the border of the right fill panel in pixels
Slider
Value Sets the current value of the slider (0 to 100)
Border Sets the width of the border of the background panel of the slider in pixels
Thumb
Width Set the width of the thumb panel of the slider
Border Sets the width of the border of the thumb panel of the slider in pixels

Vertical Slider Properties
Top Fill
Top Fill Show/Hide the top fill panel.
Border Sets the width of the border of the top fill panel in pixels
Bottom Fill
Bottom Fill Show/Hide the bottom fill panel.
Border Sets the width of the border of the bottom fill panel in pixels
Slider
Value Sets the current value of the slider (0 to 100)
Border Sets the width of the border of the background panel of the slider in pixels
Thumb
Width Set the width of the thumb panel of the slider
Border Sets the width of the border of the thumb panel of the slider in pixels


Horizontal Scroll Bar Properties
Left Button
Border Set the width of the left button of the scroll bar in pixels
Text Sets the text inside the left button
Right Button
Border Set the width of the right button of the scroll bar in pixels
Text Sets the text inside the right button
Scroll Bar
Buttons Show/Hide the buttons within the scroll bar
Scroll Position Set the default scroll position (0 to 100)
Border Set the width of the border of the background panel of the scroll bar in pixels
Thumb
Border Set the width of the border of the thumb panel of the scroll bar in pixels

Vertical Scroll Bar Properties
Down Button
Border Set the width of the down button of the scroll bar in pixels
Text Sets the text inside the down button
Up Button
Border Set the width of the Up button of the scroll bar in pixels
Text Sets the text inside the up button
Scroll Bar
Buttons Show/Hide the buttons within the scroll bar
Scroll Position Set the default scroll position (0 to 100)
Border Set the width of the border of the background panel of the scroll bar in pixels
Thumb
Border Set the width of the border of the thumb panel of the scroll bar in pixels

Text Box Properties
Regular Expression
Force Upper Case Sets all the characters in the string to be upper case
Force Lower Case Sets all the characters in the string to be lower case
Lower Case Allowed Allows/Prevents lower case characters in the input string
Upper Case Allowed Allows/Prevents upper case characters in the input string
Numbers Allowed Allows/Prevents numbers in the input string
Punctuation Allowed Allows/Prevents punctuation in the input string
Whitespace Allowed Allows/Prevents spaces in the input string
Text Box
Border Sets the width of the border of the background panel in pixels
Multi Line Sets whether the text box wraps text across multiple lines
Centered Centrally align text within the text box
Cursor Position Sets the current cursor position within the text box
Max Characters Sets the maximum number of characters allowed within the text box

Spin Box Properties
Down Button
Border Set the width of the down button of the scroll bar in pixels
Text Sets the text inside the down button
Font Size Set the font size of the text in the down button
Text Offset Set the position of the text relative to the down button’s position
Input Field
Border Set the width of the input fields of the scroll bar in pixels
Up Button
Border Set the width of the up button of the scroll bar in pixels
Text Sets the text inside the up button
Font Size Set the font size of the text in the up button
Text Offset Set the position of the text relative to the up button’s position
Spin Box
Value Sets the value of the spin box
Increment Set the amount to increase and decrease by when using the buttons of the spin box
Max Value Set the max value of the spin box
Min Value Set the min value of the spin box
Decimal Places Set the number of decimal places to display
Border Set the width of the border around the background panel of the spin box

List Box Properties
List Box
Border Set the width of the border around the background panel of the list box in pixels
Selected Index Sets the current selected index of the list box. Defaults to -1 which means nothing is selected.
(Collection) Contains all the items within the list box. Can be edited using the Collection Editor
List Box Item
Height Sets the default height for new items added to the list box in pixels
Border Sets the width of the border around the background panel of items in the list box in pixels.
Text Offset Sets the position of the text within the item relative to the item’s position within the list.
Icon Offset Sets the position of the icon within the item relative to the item’s position within the list.
Scroll Bar
Visible Show/Hide the scroll bar of the list box
Width Set the width of the scroll bar within the list box in pixels.

Combo Box Properties
Combo Box
Border Set the width of the border around the background panel of the combo box in pixels
List Height Sets the height of the drop down list when its opened in pixels
Selected Index Sets the selected index of the combo box. Defaults to -1 which means nothing is selected
List Button
Border Sets the width of the border around the drop down list button of the combo box in pixels
Text Offset Sets the position of the text within the drop down list button relative to its position
Text Sets the text of the drop down list button
Selected Item Label
Text Sets the default text to display in the combo box when no item has been selected
Text Offset Set the position of the text within the combo box relative to its position.

Window Properties
Close Button
Border Set the width of the border around the close button of the window in pixels
Text Set the text of the close button of the window
Offset Set the position of the text within the close button
Minimise Button
Border Set the width of the border around the minimize button on the window in pixels
Text Set the text of the close button of the window
Offset Set the position of the text within the minimize button
Status Bar
Status Bar Show/Hide the status bar of the window
Border Set the width of the border around the status bar in the window in pixels
Height Set the height of the status bar of the window in pixels
Title Bar
Title Bar Show/Hide the title bar of the window
Border Set the width of the border around the title bar in the window in pixels
Offset Set the position of the text relative to the position of the title bar
Text Set the text to display in the title bar
Height Set the height of the title bar of the window in pixels
Window
Movable Sets whether the window can be moved by the user
Minimised Sets whether the window should be minimized by default
Title Bar Buttons Sets which title bar buttons should be displayed in the window
  • None
  • Close Only
  • Minimise Only
  • All
Border Sets the width of the border around the title bar in pixels