Skip to content
ForgeCastDocs
Plugin SDKLua API reference

Windows

Open windows of your own.

Functions

Window:render(tree)

Show a new interface in the window.

Window:close()

Close this window.

Window:focus()

Bring this window to the front.

Window:set_title(title)

Change this window's title.

  • title: string

window.create(spec)

Needs ui.window

Open a window of your own.

Returns Window

local w = window.create{ title = "Counter", width = 300, height = 200 }
local n = 0
local function draw()
  w:render(ui.column{ ui.heading("Count: " .. n), ui.button("+1", function() n = n + 1 draw() end) })
end
draw()

window.close(key)

Close one of your windows.

  • key: string

window.focus(key)

Bring one of your windows to the front.

  • key: string

window.set_title(key, title)

Change a window's title.

  • key: string
  • title: string

Types

Open a type to see its fields; type names above link here.

Interface elements

The building blocks of every window, Dashboard section, settings panel and dialog.

Dashboard sections

Add your own box to the Dashboard.

On this page

FunctionsWindow:render(tree)Window:close()Window:focus()Window:set_title(title)window.create(spec)window.close(key)window.focus(key)window.set_title(key, title)Types