Skip to content

@vttforge/types / GameSettingsApi

Interface: GameSettingsApi ​

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>

MIT licensed.