Skip to content
ForgeCastDocs
Plugin SDKLua API reference

The plugin itself

Its settings panel and what to do when it is turned off.

Functions

PluginSettings:render(tree)

Show a new interface in the settings panel on the plugin's card.

plugin.on_unload(handler)

Run handler when the plugin is turned off or reloaded: clean up here.

  • handler: fun()

plugin.settings(spec)

Needs ui.dashboard

A settings panel shown on the plugin's card in the Plugins page.

  • spec: { title?: string, content?: UiNode }

Returns PluginSettings

Types

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

Dashboard sections

Add your own box to the Dashboard.

Storage, timers and data

Keep data, run things later, write to the console, read and write JSON.

On this page

FunctionsPluginSettings:render(tree)plugin.on_unload(handler)plugin.settings(spec)Types