@vttforge/types / GameSettingsApi

Interface: GameSettingsApi

Properties

menus

readonly menus: ReadonlyMap<string, RegisteredSettingMenu>

Every settings menu registered in this world, keyed namespace.key.

---

settings

readonly settings: ReadonlyMap<string, RegisteredSetting<unknown>>

Every setting registered in this world, keyed namespace.key.

The only way to reach settings belonging to a package you did not write. Read it to enumerate, report on or copy what a world holds; write through register, get and set, never through the map.

Methods

get()

get<T>(namespace, key, options?): T

Type Parameters

T

T = unknown

Parameters

namespace

string

key

string

options?

document?

boolean

Returns

T

---

register()

register<T>(namespace, key, data): void

Type Parameters

T

T

Parameters

namespace

string

key

string

data

SettingConfig<T>

Returns

void

---

registerMenu()

registerMenu(namespace, key, data): void

Parameters

namespace

string

key

string

data

SettingMenuConfig

Returns

void

---

set()

set<T>(namespace, key, value, options?): Promise<T>

Type Parameters

T

T

Parameters

namespace

string

key

string

value

T

options?

document?

boolean

Returns

Promise<T>