Skip to content

API

The following functions can be useful, for example, to control Worldbuilder using macros:

Open the Worldbuilder app

worldbuilder.api.open(tab); //"tab" is an optional tab name

//Tab names: "home", "favorites", "sessions", "quests", "characters", "groups", "creatures", "locations", "objects", "other", "widgets", "tags", "settings"

Toggle the Worldbuilder app open/close

worldbuilder.api.toggle(tab); //"tab" is an optional tab name

//Tab names: "home", "favorites", "sessions", "quests", "characters", "groups", "creatures", "locations", "objects", "other", "widgets", "tags", "settings"

Open a specific tab

worldbuilder.api.openTab(tab); //"tab" is the name of the tab to open

//Tab names: "home", "favorites", "sessions", "quests", "characters", "groups", "creatures", "locations", "objects", "other", "widgets", "tags", "settings"

Open article

worldbuilder.api.openArticleApp(uuid); //"uuid" is the uuid of the article

Open tag config

worldbuilder.api.openTagApp(tag); //"tag" is the tag name

Download logs

worldbuilder.api.downloadLogs(all); //"all" is an optional (boolean) value to download all logs (if true), otherwise it will download the log for the current session