guiwindowctrl: members
23 implemented, 0 reserved. Entries are sorted by name.
Implemented
Section titled “Implemented”bounds
Section titled “bounds”guiwindowctrl.bounds: array
Runs on: client only. Origin: compatibility. Since: M5. Playground: no.
The window rectangle as a list: x, y, width and height. Writing it moves and resizes the window.
this.bounds = {10, 10, 300, 200};Specification: client-rendering.md§4.11.
canclose
Section titled “canclose”guiwindowctrl.canclose: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Whether the title bar has a close button; clicking it raises onClose.
new GuiWindowCtrl("MyControl") { canclose = true; }Specification: gui.md§3.
canmaximize
Section titled “canmaximize”guiwindowctrl.canmaximize: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Whether the title bar has a maximize button.
new GuiWindowCtrl("MyControl") { canmaximize = true; }Specification: gui.md§3.
canminimize
Section titled “canminimize”guiwindowctrl.canminimize: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Whether the title bar has a minimize button.
new GuiWindowCtrl("MyControl") { canminimize = true; }Specification: gui.md§3.
clientrelative
Section titled “clientrelative”guiwindowctrl.clientrelative: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
When true, children are placed relative to the client area (below the title bar) instead of the window’s corner.
new GuiWindowCtrl("MyControl") { clientrelative = 1; }Specification: gui.md§3.
closequery
Section titled “closequery”guiwindowctrl.closequery: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiWindowCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiWindowCtrl("MyControl") { closequery = 1; }Specification: gui.md§3.
destroyonhide
Section titled “destroyonhide”guiwindowctrl.destroyonhide: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiWindowCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiWindowCtrl("MyControl") { destroyonhide = 1; }Specification: gui.md§3.
dockable
Section titled “dockable”guiwindowctrl.dockable: boolean
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Whether the window may be docked; kept for scripts, because windows stay in the canvas.
Win.dockable = true;Specification: gui.md§3.10.
externalwindow
Section titled “externalwindow”guiwindowctrl.externalwindow: guiwindowctrl
Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.
The external window object; in Borne the window itself.
echo(this.externalwindow);Specification: gui.md§3.
isactivewindow
Section titled “isactivewindow”guiwindowctrl.isactivewindow() -> boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Returns true when the window is the one on top.
Control.isactivewindow();Specification: gui.md§3.
isexternal
Section titled “isexternal”guiwindowctrl.isexternal: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Asks for a separate desktop window; Borne keeps the window inside the game canvas.
new GuiWindowCtrl("MyControl") { isexternal = 1; }Specification: gui.md§3.
istoolwindow
Section titled “istoolwindow”guiwindowctrl.istoolwindow: boolean
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Whether the window has a smaller title; kept for scripts.
Win.istoolwindow = true;Specification: gui.md§3.10.
maximized
Section titled “maximized”guiwindowctrl.maximized: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiWindowCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiWindowCtrl("MyControl") { maximized = 1; }Specification: gui.md§3.
minimized
Section titled “minimized”guiwindowctrl.minimized: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiWindowCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiWindowCtrl("MyControl") { minimized = 1; }Specification: gui.md§3.
onClose
Section titled “onClose”guiwindowctrl.onClose()
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Raised by the close button of the window. Without any handler the window is hidden.
function MyWindow.onClose() { MyWindow.destroy();}Specification: gui.md§3.
onCloseQuery
Section titled “onCloseQuery”guiwindowctrl.onCloseQuery()
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Raised instead of onClose when the close button is pressed on a window with closequery set; the script decides whether to hide it.
function MyWindow.onCloseQuery() { MyWindow.hide();}Specification: gui.md§3.10.
screenbounds
Section titled “screenbounds”guiwindowctrl.screenbounds: array
Runs on: client only. Origin: compatibility. Since: M8. Playground: no. read-only.
The screen rectangle the window can use: {x, y, width, height}.
echo(this.screenbounds);Specification: gui.md§3.
screenheight
Section titled “screenheight”guiwindowctrl.screenheight: number
Runs on: client only. Origin: compatibility. Since: M5. Playground: no. read-only.
The height of the screen in logical pixels.
echo(this.screenheight);Specification: client-rendering.md§4.11.
screenwidth
Section titled “screenwidth”guiwindowctrl.screenwidth: number
Runs on: client only. Origin: compatibility. Since: M5. Playground: no. read-only.
The width of the screen in logical pixels.
echo(this.screenwidth);Specification: client-rendering.md§4.11.
settext
Section titled “settext”guiwindowctrl.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.
showontaskbar
Section titled “showontaskbar”guiwindowctrl.showontaskbar: boolean
Runs on: client only. Origin: compatibility. Since: M14. Playground: no.
Whether the window has a taskbar button; kept for scripts.
Win.showontaskbar = true;Specification: gui.md§3.10.
guiwindowctrl.text: string
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
The text the control shows.
new GuiWindowCtrl("MyControl") { text = "Hello"; }Specification: gui.md§3.
guiwindowctrl.tile: boolean
Runs on: client only. Origin: compatibility. Since: M8. Playground: no.
Property of GuiWindowCtrl in the legacy GUI toolkit (gui.md§2, §3).
new GuiWindowCtrl("MyControl") { tile = 1; }Specification: gui.md§3.
Engine version 0.1.0. Built 2026-11-18.