Skip to content
ForgeCastDocs
Plugin SDKLua API reference

Notifications and dialogs

Pop-up notifications, messages, questions and your own dialogs.

Functions

ui.notify(spec)

Needs ui.notify

Show a notification inside ForgeCast. A plain string works too: ui.notify("Done").

  • spec: string|NotifySpec

Returns string id

ui.modal(spec)

Needs ui.modal

Show a dialog over the app.

Returns string id

ui.close(id)

Close a dialog from code.

  • id: string

ui.alert(message, on_close)

A dialog with a message and an OK button.

  • message: string
  • on_close: fun(), optional

Returns string id

ui.confirm(message, on_answer, opts)

Ask yes or no. on_answer gets true or false.

Name

Type

Returns string id

ui.prompt(message, default, on_answer)

Ask for a line of text. on_answer gets the text, or nil if cancelled.

Name

Type

Returns string id

ui.render(target, tree)

Draw a tree into one of your own windows or Dashboard sections (the handles' :render does this).

  • target: string. "window:<key>", "panel:<id>" or "settings"
  • tree: UiNode

Types

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

Streams

The streams being watched: viewers, likes and when they start and end.

Interface elements

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

On this page

Functionsui.notify(spec)ui.modal(spec)ui.close(id)ui.alert(message, on_close)ui.confirm(message, on_answer, opts)ui.prompt(message, default, on_answer)ui.render(target, tree)Types