Function reference

Built In helpers

The helpers the in-game Functions tab lists as Built In. Public ones are called by name; the others are bound as a dependency (choose the completion, or add it under Dependencies) and called by their qualified name.

22 of 240 helpers. Clear filters

`UI.checkbox.constructor` dependency	Constructs a new RM-CheckBox condition widget: a 180 by 24 frame holding a workbench check box, with SetLabel, SetValue, GetValue and SetDisabled, firing OnValueChanged when clicked.
`UI.checkbox.CreateConditionCheckBox` public	Create a native boolean condition control.
`UI.condition_display.buttonConstructor` dependency	Constructs a new RM-ConditionButton widget around a 200-pixel workbench button, with SetText, SetAutoWidth and SetDisabled, firing OnClick (with the mouse button), OnEnter and OnLeave only while its lease is live.
`UI.condition_display.CreateConditionButton` public	Create a native button using the shared condition widget lifecycle and workbench theme.
`UI.condition_display.CreateConditionLabel` public	Create native wrapping text that measures its height from its width and font.
`UI.condition_display.CreateConditionLink` public	Create native wrapping text with optional leading image and pointer callbacks.
`UI.condition_display.defaultFont` dependency	Returns the default font for condition labels and buttons: the GameFontHighlightSmall font object, or its name when the object is not defined.
`UI.condition_display.labelConstructor` dependency	Constructs a new condition text widget: a plain wrapping RM-ConditionLabel, or with interactive set an RM-ConditionLink button that adds a leading image and OnEnter, OnLeave and OnClick callbacks.
`UI.condition_icon.constructor` dependency	Constructs a new RM-ConditionIcon widget: a clickable image with an optional caption below it, with SetImage, SetImageByAtlas, SetImageSize, SetLabel and SetDisabled, firing OnClick, OnEnter and OnLeave while its lease is live.
`UI.condition_icon.CreateConditionIcon` public	Create a native image control using the condition widget lifecycle.
`UI.condition_inputs.constructor` dependency	Constructs a new condition input widget: an RM-ConditionEditBox text box, or with numeric set an RM-ConditionSlider pairing a slider with a numeric box (with range, step and percent display).
`UI.condition_inputs.CreateConditionEditBox` public	Create a native text input using the condition widget contract.
`UI.condition_inputs.CreateConditionSlider` public	Create a native numeric condition input with a slider and typed numeric field.
`UI.condition_inputs.finite` dependency	True when value is a number that is neither NaN nor infinite; the condition inputs use it to validate entered and slider values.
`UI.condition_layout.constructor` dependency	Constructs a new RM-ConditionGroup container that stacks condition widgets in List, Table or RM-SpellField layout, resizing itself to its contents and relaying out its parent.
`UI.condition_layout.CreateConditionGroup` public	Create a condition field container with RM-owned List, Table and responsive spell-field layouts.
`UI.condition_layout.layoutIconRows` dependency	Lays out the "RM-IconRows" container: an icon on the left, vertically centered beside the rows of fields, and an optional side widget (marked with the side user data) that sits beside the last row when there is room and below the rows when there is not.
`UI.condition_layout.verticalAlignment` dependency	Converts a table cell's alignV setting to a vertical offset fraction for the condition group's Table layout: 0 for nil, start or top, 0.5 for middle or center, and 1 for end or bottom (case-insensitive prefixes).
`UI.condition_position.constructor` dependency	Constructs a new RM-ConditionPositionPad widget around the shared workbench directional pad, with SetDisabled, firing OnOffsetChanged (horizontal and vertical direction, whether Center was pressed, and the step) only while its lease is live and it is enabled.
`UI.condition_position.CreateConditionPositionPad` public	Create a native position pad using the shared directional controls.
`UI.selector.CreateConditionDropdown` public	Create a native condition selector.
`UI.selector.selectorWidget` dependency	Constructs a new RM-Selector dropdown widget: an optional caption over a button that opens the workbench selector popup.