Interface GameSettingBase

Defines a game setting.

interface GameSettingBase {
    key: string;
    namespace?: string;
    options: CoreSetting;
    store?: MinimalWritable<any>;
}

Index

Properties

key namespace? options store?

Properties

key

key: string

The setting key to register.

`Optional`namespace

namespace?: string

The setting namespace; usually the ID of the package. If not provided the associated namespace with the instance of TJSGameSettings will be used.

options

options: CoreSetting

Core game setting configuration options.

`Optional`store

store?: MinimalWritable<any>

An existing store instance to use.