guibitmapctrl: members
9 implemented, 0 reserved. Entries are sorted by name.
Implemented
Section titled “Implemented”bitmap
Section titled “bitmap”guibitmapctrl.bitmap: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Image file; a bitmap button also uses the _h, _d and _i variants for hover, pressed and inactive.
new GuiBitmapCtrl("MyControl") { bitmap = "button.png"; }Specification: gui.md§3.
bitmaprectangle
Section titled “bitmaprectangle”guibitmapctrl.bitmaprectangle: array
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
The part of the picture to draw, as x, y, width, height; empty draws all of it.
Pic.bitmaprectangle = {0, 0, 32, 32};Specification: gui.md§3.11.
fullbitmap
Section titled “fullbitmap”guibitmapctrl.fullbitmap: boolean
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
True while no part of the picture is chosen; writing true clears bitmaprectangle.
Pic.fullbitmap = true;Specification: gui.md§3.11.
offsetx
Section titled “offsetx”guibitmapctrl.offsetx: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Moves the picture inside the control; set by setValue(x, y).
new GuiBitmapCtrl("MyControl") { offsetx = 4; }Specification: gui.md§3.
offsety
Section titled “offsety”guibitmapctrl.offsety: number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Moves the picture inside the control; set by setValue(x, y).
new GuiBitmapCtrl("MyControl") { offsety = 4; }Specification: gui.md§3.
setbitmap
Section titled “setbitmap”guibitmapctrl.setbitmap(image: string, state?: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Sets a picture: the picture of a bitmap control, or the picture of one state of a bitmap button (0 normal, 1 mouse over, 2 pressed).
Button.setBitmap("btn_hot.png", 1);Specification: gui.md§3.
setvalue
Section titled “setvalue”guibitmapctrl.setvalue(x: number, y: number) -> number
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Sets the offset of the picture inside the control (offsetx and offsety).
Control.setvalue(4, 4);Specification: gui.md§3.
guibitmapctrl.tile: boolean
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Another name of wrap: repeat the picture at its own size instead of stretching it.
Pic.tile = true;Specification: gui-legacy.md§29.
guibitmapctrl.wrap: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiBitmapCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiBitmapCtrl("MyControl") { wrap = 1; }Specification: gui.md§3.
Engine version 0.1.0. Built 2026-11-18.