TabletButtonProxy

Available in: Interface Scripts Client Entity Scripts

Methods

Signals

Type Definitions

Properties:
Name Type Description
uuid Uuid Uniquely identifies this button. Read-only.
properties TabletButtonProxy.ButtonProperties

Methods

editProperties(properties)
Replace the values of some of this button's properties.
Parameters:
Name Type Description
properties TabletButtonProxy.ButtonProperties Set of properties to change.
getProperties() → {TabletButtonProxy.ButtonProperties}
Returns the current value of this button's properties.
Returns:
Type: TabletButtonProxy.ButtonProperties

Signals

clicked() → {Signal}
Triggered when this button has been clicked on by the user.
Returns:
Type: Signal
propertiesChanged() → {Signal}
Returns:
Type: Signal

Type Definitions

ButtonProperties
Type: object
Properties:
Name Type Description
icon string URL to button icon. (50 x 50)
hoverIcon string URL to button icon, displayed during mouse hover. (50 x 50)
activeHoverIcon string URL to button icon used when button is active, and during mouse hover. (50 x 50)
activeIcon string URL to button icon used when button is active. (50 x 50)
text string Button caption.
hoverText string Button caption when button is not-active but during mouse hover.
activeText string Button caption when button is active.
activeHoverText string Button caption when button is active and during mouse hover.
isActive boolean true when button is active.
sortOrder number Determines sort order on tablet. lower numbers will appear before larger numbers. Default is 100.