guibuttonctrl: members
11 implemented, 0 reserved. Entries are sorted by name.
Implemented
Section titled “Implemented”buttontype
Section titled “buttontype”guibuttonctrl.buttontype: string
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
How the button behaves when clicked: pushbutton, togglebutton or radiobutton.
new GuiButtonCtrl("MyControl") { buttontype = "togglebutton"; }Specification: gui-legacy.md§29.
checked
Section titled “checked”guibuttonctrl.checked: boolean
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Whether a toggle or radio button is checked (another name of value on a check box or radio control).
echo(MyControl.checked);Specification: gui-legacy.md§29.
gettext
Section titled “gettext”guibuttonctrl.gettext() -> string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The text of a text edit or markup text control, as stored.
echo(Edit.getText());Specification: gui.md§3.
groupnum
Section titled “groupnum”guibuttonctrl.groupnum: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The group of a radio-type button: choosing one clears the others of its group.
new GuiRadioCtrl("MyControl") { groupnum = 10; }Specification: gui.md§3.
guibuttonctrl.icon: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiButtonCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiButtonCtrl("MyControl") { icon = 1; }Specification: gui.md§3.
iconheight
Section titled “iconheight”guibuttonctrl.iconheight: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiButtonCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiButtonCtrl("MyControl") { iconheight = 1; }Specification: gui.md§3.
iconwidth
Section titled “iconwidth”guibuttonctrl.iconwidth: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiButtonCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiButtonCtrl("MyControl") { iconwidth = 1; }Specification: gui.md§3.
seticonsize
Section titled “seticonsize”guibuttonctrl.seticonsize(arg1: number, arg2: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Sets the size of the icons (at most 64 by 64) and raises onIconResized.
Control.seticonsize(0, 0);Specification: gui.md§3.
settext
Section titled “settext”guibuttonctrl.settext(text: string) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Replaces the text of a text edit; the caret goes to the end.
Edit.setText("hello");Specification: gui.md§3.
stylesection
Section titled “stylesection”guibuttonctrl.stylesection: string
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Name of the part of the GUI style the control takes its colors from; kept without GUI styles.
new GuiButtonCtrl("MyControl") { stylesection = "Clock"; }Specification: gui.md§3.11.
guibuttonctrl.text: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The text the control shows.
new GuiButtonCtrl("MyControl") { text = "Hello"; }Specification: gui.md§3.
Engine version 0.1.0. Built 2026-11-18.