Controls

WaxContainerCopy Anchor Link

Something controls can be added to: a window, a page, a section, a row or an overlay.

Below, container stands for one of these.

container:Label(content, options?)Copy Anchor Link

Adds text that wraps to the container's width.

container:Label(content: any, options?: WaxLabelOptions): WaxLabel

Returns WaxLabel

container:Heading(content)Copy Anchor Link

Adds a bold title line.

container:Heading(content: any): WaxHeading

Returns WaxHeading

container:Separator()Copy Anchor Link

Adds a thin dividing line.

container:Separator(): WaxControl

Returns WaxControl

container:Spacer(height?)Copy Anchor Link

Adds an empty gap, as tall as the theme's spacing when no height is given.

container:Spacer(height?: number): WaxControl

Returns WaxControl

container:Button(caption?, on_click?, options?)Copy Anchor Link

Adds a button. on_click runs on each click. With an icon and no caption it is an icon button.

container:Button(caption?: string, on_click?: fun(), options?: WaxButtonOptions): WaxButton

Returns WaxButton

container:Icon(name, options?)Copy Anchor Link

Adds an icon on its own, by name. The menu's Icons page lists the names.

container:Icon(name: string, options?: WaxIconOptions): WaxIcon

Returns WaxIcon

container:Toggle(caption, initial?, on_change?)Copy Anchor Link

Adds a switch. on_change(on) runs when the user flips it.

container:Toggle(caption: string, initial?: boolean, on_change?: fun(on: boolean)): WaxToggle

Returns WaxToggle

container:Slider(caption, options?, on_change?)Copy Anchor Link

Adds a slider with a read-out. on_change(value) runs while the user drags it.

container:Slider(caption: string, options?: WaxSliderOptions, on_change?: fun(value: number)): WaxSlider

Returns WaxSlider

container:Input(caption?, options?, on_commit?)Copy Anchor Link

Adds a text box. on_commit(text) runs when Enter is pressed or the box loses focus.

container:Input(caption?: string, options?: WaxInputOptions, on_commit?: fun(text: string)): WaxInput

Returns WaxInput

container:Dropdown(caption, choices, selected?, on_change?)Copy Anchor Link

Adds a dropdown that opens in place. on_change(choice) runs when the user picks one.

container:Dropdown<T>(caption: string, choices: T[], selected?: T, on_change?: fun(choice: T)): WaxDropdown

Returns WaxDropdown

container:Section(title, options?)Copy Anchor Link

Adds a collapsible card and returns it as a container: section:Button(...), section:Toggle(...) and so on.

container:Section(title: string, options?: WaxSectionOptions): WaxSection

Returns WaxSection

container:Title(content, description?)Copy Anchor Link

Adds a title for a page or a group of controls: large text, an optional explanation, and a rule under it.

container:Title(content: string, description?: string): WaxTitle

Returns WaxTitle

container:Row()Copy Anchor Link

Adds a row. Controls added to the returned container sit side by side and share the width.

container:Row(): WaxRow

Returns WaxRow

container:Color(caption, color?, on_change?)Copy Anchor Link

A colour the user can change.

container:Color(caption: string, color?: string, on_change?: fun(color: string)): WaxColorControl

Returns WaxColorControl

container:Grid(options)Copy Anchor Link

Adds a grid for any number of items. It builds only the cells in view, with the make and show functions in options.

container:Grid(options: WaxGridOptions): WaxGrid

Returns WaxGrid

container:Flow(options?)Copy Anchor Link

Adds an area where controls keep their own size and wrap onto new lines. Add them to the returned container.

container:Flow(options?: WaxFlowOptions): WaxRow

Returns WaxRow

container:Progress(caption, value?, options?)Copy Anchor Link

Adds a progress bar. value is 0..1.

container:Progress(caption: string, value?: number, options?: WaxProgressOptions): WaxProgress

Returns WaxProgress

container:Field(name, value?, options?)Copy Anchor Link

Adds a name with a value on the right, for read-outs.

container:Field(name: string, value?: any, options?: WaxFieldOptions): WaxField

Returns WaxField

container:Keybind(caption, key?, on_change?)Copy Anchor Link

Adds a key the user can rebind by clicking it and pressing a key. on_change(key) gets the engine's key name.

container:Keybind(caption: string, key?: string, on_change?: fun(key: string)): WaxKeybind

Returns WaxKeybind

container:Console(options?)Copy Anchor Link

Adds a scrolling list of text lines, such as a log.

container:Console(options?: WaxConsoleOptions): WaxConsole

Returns WaxConsole

WaxControlCopy Anchor Link

What every control has.

You get one from container:Separator, container:Spacer. Below, control stands for one of these.

control:Destroy()Copy Anchor Link

Removes the control.

control:Destroy()

Returns nothing.

control:SetVisible(shown)Copy Anchor Link

Shows or hides the control. A hidden control takes no room.

control:SetVisible(shown: boolean)

Returns nothing.

control:SetEnabled(enabled)Copy Anchor Link

Greys the control out and stops it reacting, or makes it usable again.

control:SetEnabled(enabled: boolean)

Returns nothing.

WaxLabelCopy Anchor Link

It can also do everything WaxControl can. You get one from container:Label. Below, label stands for one of these.

label:Set(value)Copy Anchor Link

Replaces the text.

label:Set(value: any)

Returns nothing.

label:SetColor(color)Copy Anchor Link

Changes the text colour.

label:SetColor(color: WaxColor)

Returns nothing.

WaxHeadingCopy Anchor Link

It can also do everything WaxControl can. You get one from container:Heading. Below, heading stands for one of these.

heading:Set(value)Copy Anchor Link

Replaces the text.

heading:Set(value: any)

Returns nothing.

WaxButtonCopy Anchor Link

It can also do everything WaxControl can. You get one from container:Button. Below, button stands for one of these.

button:SetIcon(name)Copy Anchor Link

Shows another icon on a button that was made with one.

button:SetIcon(name: string)

Returns nothing.

button:Spin()Copy Anchor Link

Turns the icon round once.

button:Spin()

Returns nothing.

WaxIconCopy Anchor Link

It can also do everything WaxControl can. You get one from container:Icon. Below, icon stands for one of these.

icon:Set(name)Copy Anchor Link

Shows another icon.

icon:Set(name: string)

Returns nothing.

WaxToggleCopy Anchor Link

It can also do everything WaxControl can. You get one from container:Toggle. Below, toggle stands for one of these.

toggle:Get()Copy Anchor Link

True while the switch is on.

toggle:Get(): boolean

Returns boolean

toggle:Set(on, instant?)Copy Anchor Link

Turns the switch on or off without firing Changed.

toggle:Set(on: boolean, instant?: boolean)

Returns nothing.

toggle:SetCaption(text)Copy Anchor Link

Changes the text beside the switch.

toggle:SetCaption(text: string)

Returns nothing.

WaxColorControlCopy Anchor Link

A colour selector. It opens a panel with a shade box, a hue bar and the colour as text that can be typed, pasted or copied.

It can also do everything WaxControl can. You get one from container:Color. Below, colorControl stands for one of these.

colorControl:Get()Copy Anchor Link

The colour as "#rrggbb".

colorControl:Get(): string

Returns string

colorControl:Set(color)Copy Anchor Link

Sets the colour without firing Changed.

colorControl:Set(color: string)

Returns nothing.

WaxTitleCopy Anchor Link

A page or group title: large text, an optional line under it, and a rule.

It can also do everything WaxControl can. You get one from container:Title. Below, title stands for one of these.

title:Set(content)Copy Anchor Link

Changes the title text.

title:Set(content: any)

Returns nothing.

title:SetDescription(description)Copy Anchor Link

Changes the line under the title (only if the title was made with one).

title:SetDescription(description: any)

Returns nothing.

WaxSliderCopy Anchor Link

A slider. The number beside it can be clicked and typed into.

It can also do everything WaxControl can. You get one from container:Slider. Below, slider stands for one of these.

slider:Get()Copy Anchor Link

The current value.

slider:Get(): number

Returns number

slider:Set(value)Copy Anchor Link

Moves the slider (snapped and kept within its range) without firing Changed.

slider:Set(value: number)

Returns nothing.

WaxInputCopy Anchor Link

It can also do everything WaxControl can. You get one from container:Input. Below, input stands for one of these.

input:Get()Copy Anchor Link

The text in the box.

input:Get(): string

Returns string

input:Focus()Copy Anchor Link

Gives the box the keyboard, so the user can type without clicking it.

input:Focus()

Returns nothing.

input:HasFocus()Copy Anchor Link

True while the box has the keyboard.

input:HasFocus(): boolean

Returns boolean

input:SetGhost(text)Copy Anchor Link

Shows greyed text after what is typed, such as the rest of a suggested word. Only a box made with mono = true shows it.

input:SetGhost(text: string)

Returns nothing.

input:Set(text)Copy Anchor Link

Replaces the text without firing Changed.

input:Set(text: any)

Returns nothing.

WaxDropdownCopy Anchor Link

A dropdown opens in place under its header. The chosen row is highlighted, and only one list is open at a time.

It can also do everything WaxControl can. You get one from container:Dropdown. Below, dropdown stands for one of these.

dropdown:Get()Copy Anchor Link

The selected choice.

dropdown:Get(): any

Returns any

dropdown:Set(choice)Copy Anchor Link

Selects a choice without firing Changed.

dropdown:Set(choice: any)

Returns nothing.

WaxSectionCopy Anchor Link

A collapsible card. It is a container for controls.

It can also do everything WaxContainer can. You get one from container:Section. Below, section stands for one of these.

section:SetOpen(open)Copy Anchor Link

Expands or collapses the section.

section:SetOpen(open: boolean)

Returns nothing.

section:IsOpen()Copy Anchor Link

True while the section is expanded.

section:IsOpen(): boolean

Returns boolean

WaxRowCopy Anchor Link

A container whose controls sit side by side.

It can also do everything WaxContainer can. You get one from container:Row, container:Flow.

WaxProgressCopy Anchor Link

It can also do everything WaxControl can. You get one from container:Progress. Below, progress stands for one of these.

progress:Get()Copy Anchor Link

The current value, 0..1.

progress:Get(): number

Returns number

progress:Set(value)Copy Anchor Link

Moves the bar to a value of 0..1.

progress:Set(value: number)

Returns nothing.

progress:SetColor(color)Copy Anchor Link

Changes the colour of the filled part.

progress:SetColor(color: WaxColor)

Returns nothing.

WaxFieldCopy Anchor Link

It can also do everything WaxControl can. You get one from container:Field. Below, field stands for one of these.

field:Set(value)Copy Anchor Link

Replaces the value.

field:Set(value: any)

Returns nothing.

field:SetColor(color)Copy Anchor Link

Changes the colour of the value.

field:SetColor(color: WaxColor)

Returns nothing.

WaxKeybindCopy Anchor Link

It can also do everything WaxControl can. You get one from container:Keybind. Below, keybind stands for one of these.

keybind:Get()Copy Anchor Link

The key's engine name, or nil when none is set.

keybind:Get(): string?

Returns string?

keybind:Set(key)Copy Anchor Link

Sets the key without firing Changed.

keybind:Set(key: string?)

Returns nothing.

WaxConsoleCopy Anchor Link

A log: coloured lines the user can select across (drag, Ctrl+A) and copy (Ctrl+C).

It can also do everything WaxControl can. You get one from container:Console. Below, console stands for one of these.

console:GetText()Copy Anchor Link

Everything being shown, as one text (for ui.Copy).

console:GetText(): string

Returns string

console:SetLines(lines)Copy Anchor Link

Shows these lines, or the last max of them.

console:SetLines(lines: WaxConsoleLine[])

Returns nothing.

console:SetFollow(on)Copy Anchor Link

Turns scrolling to the newest line on every SetLines on or off. It starts on.

console:SetFollow(on: boolean)

Returns nothing.

WaxGridCopy Anchor Link

A grid for any number of items: only the cells in view exist, and they are reused as it scrolls. It follows its scrolling while the menu is open, so it belongs in a window, not in an overlay.

It can also do everything WaxControl can. You get one from container:Grid. Below, grid stands for one of these.

grid:SetItems(items)Copy Anchor Link

Shows another list, from the top.

grid:SetItems(items: any[])

Returns nothing.

grid:Refresh()Copy Anchor Link

Shows every cell again, after the items themselves changed.

grid:Refresh()

Returns nothing.

grid:Count()Copy Anchor Link

How many items the grid has.

grid:Count(): integer

Returns integer

WaxLabelOptionsCopy Anchor Link

Used by container:Label.

WaxButtonOptionsCopy Anchor Link

Used by container:Button.

WaxIconOptionsCopy Anchor Link

Used by container:Icon.

WaxSliderOptionsCopy Anchor Link

Used by container:Slider.

WaxInputOptionsCopy Anchor Link

Used by container:Input.

WaxSectionOptionsCopy Anchor Link

Used by container:Section.

WaxProgressOptionsCopy Anchor Link

Used by container:Progress.

WaxFieldOptionsCopy Anchor Link

Used by container:Field.

WaxConsoleOptionsCopy Anchor Link

Used by container:Console.

WaxGridOptionsCopy Anchor Link

Used by container:Grid.

WaxFlowOptionsCopy Anchor Link

Used by container:Flow.

Named valuesCopy Anchor Link

Short names for a fixed set of values. Where a function asks for one of these, pass one of the values listed.

WaxConsoleLineCopy Anchor Link

One console line: the text, then an optional colour.

The same as { [1]: any, [2]: WaxColor? }.