Class TJSGameSettings<ExtraProps>

Registers game settings and creates a backing Svelte store for each setting. The Svelte store will update the Foundry game settings and vice versa when changes occur to the Foundry game settings the updated data is set to the store.

Note: It is possible to add multiple onChange callbacks on registration.

Type Param

ExtraProps - Defines additional properties for game setting options / data that child implementations may define.

Type Parameters

ExtraProps extends Record<string, any> = {}

Hierarchy

TJSGameSettings (View Summary)
- TJSGameSettingsWithUI

Index

Constructors

constructor

new TJSGameSettings<ExtraProps extends Record<string, any> = {}>(
namespace: string,
options?: Ctor,
): TJSGameSettings<ExtraProps>
Creates the TJSGameSettings instance.
Type Parameters
- ExtraProps extends Record<string, any> = {}
Parameters
- namespace: string
  The namespace for all settings.
- Optionaloptions: Ctor
  TJSGameSetting options.
Returns TJSGameSettings<ExtraProps>

Accessors

namespace

get namespace(): string

Returns string
Returns namespace set in constructor.

size

get size(): number

Returns number
Number of stores managed.

Methods

data

data(
regex?: RegExp,
): IterableIterator<TJSGameSettings.Data.GameSetting<ExtraProps>>
Returns an iterable for the game setting data; TJSGameSettings.Data.GameSetting.
Parameters
- Optionalregex: RegExp
  Optional regular expression to filter by game setting keys.
Returns IterableIterator<TJSGameSettings.Data.GameSetting<ExtraProps>>
Iterable iterator of TJSGameSettings.Data.GameSetting.

entries

entries<T>(regex?: RegExp): IterableIterator<[string, MinimalWritable<T>]>
Returns an iterable for the game setting keys and stores.
Type Parameters
- T
  Store data type.
Parameters
- Optionalregex: RegExp
  Optional regular expression to filter by game setting keys.
Returns IterableIterator<[string, MinimalWritable<T>]>
Iterable iterator of keys and stores.

getReadableStore

getReadableStore<T>(key: string): Readable<T>
Returns a readable Game Settings store for the associated key.
Type Parameters
- T
Parameters
- key: string
  Game setting key.
Returns Readable<T>
The associated store for the given game setting key.

getStore

getStore<T>(key: string): MinimalWritable<T>
Returns a writable Game Settings store for the associated key.
Type Parameters
- T
Parameters
- key: string
  Game setting key.
Returns MinimalWritable<T>
The associated store for the given game setting key.

getWritableStore

getWritableStore<T>(key: string): MinimalWritable<T>
Returns a writable Game Settings store for the associated key.
Type Parameters
- T
Parameters
- key: string
  Game setting key.
Returns MinimalWritable<T>
The associated store for the given game setting key.

hasStore

hasStore(key: string): boolean
Returns whether a Game Settings store exist for the given key.
Parameters
- key: string
  Setting key to test.
Returns boolean

keys

keys(regex?: RegExp): IterableIterator<string>
Returns an iterable for the game setting keys from existing stores.
Parameters
- Optionalregex: RegExp
  Optional regular expression to filter by game setting keys.
Returns IterableIterator<string>
Iterable iterator of game setting keys.

register

register(
setting: TJSGameSettings.Options.GameSetting<ExtraProps>,
coreConfig?: boolean,
): void
Registers a setting with TJSGameSettings and Foundry core.
Parameters
- setting: TJSGameSettings.Options.GameSetting<ExtraProps>
  A GameSetting instance to set to Foundry game settings.
- OptionalcoreConfig: boolean
  When false this overrides the setting.options.config parameter when registering the setting with Foundry. This allows the settings to be displayed in the app itself, but removed from the standard Foundry configuration location.
Returns void

registerAll

registerAll(
settings: Iterable<TJSGameSettings.Options.GameSetting<ExtraProps>>,
coreConfig?: boolean,
): void
Registers multiple settings.
Parameters
- settings: Iterable<TJSGameSettings.Options.GameSetting<ExtraProps>>
  An iterable list of game setting configurations to register.
- OptionalcoreConfig: boolean
  When false this overrides the setting.options.config parameter when registering the setting with Foundry. This allows the settings to be displayed in the app itself, but removed from the standard Foundry configuration location.
Returns void
An object containing all TJSGameSetting store subscriber handlers for each setting key added.

stores

stores<T>(regex?: RegExp): IterableIterator<MinimalWritable<T>>
Returns an iterable for the game setting stores.
Type Parameters
- T
Parameters
- Optionalregex: RegExp
  Optional regular expression to filter by game setting keys.
Returns IterableIterator<MinimalWritable<T>>
Iterable iterator of stores.

Class TJSGameSettings<ExtraProps>

Type Param

Type Parameters

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TJSGameSettings<ExtraProps>

Accessors

namespace

Returns string

size

Returns number

Methods

data

Parameters

Returns IterableIterator<TJSGameSettings.Data.GameSetting<ExtraProps>>

entries

Type Parameters

Parameters

Returns IterableIterator<[string, MinimalWritable<T>]>

getReadableStore

Type Parameters

Parameters

Returns Readable<T>

getStore

Type Parameters

Parameters

Returns MinimalWritable<T>

getWritableStore

Type Parameters

Parameters

Returns MinimalWritable<T>

hasStore

Parameters

Returns boolean

keys

Parameters

Returns IterableIterator<string>

register

Parameters

Returns void

registerAll

Parameters

Returns void

stores

Type Parameters

Parameters

Returns IterableIterator<MinimalWritable<T>>

Settings

On This Page