Class TJSGameSettings<ExtraProps>
Type Parameters
- ExtraProps extends Record<string, any> = {}
Hierarchy
- TJSGameSettings (View Summary)
Index
Constructors
Accessors
Methods
Constructors
constructor
- new TJSGameSettings<ExtraProps extends Record<string, any> = {}>(
namespace: string,
): TJSGameSettings<ExtraProps> Creates the TJSGameSettings instance.
Type Parameters
- ExtraProps extends Record<string, any> = {}
Parameters
- namespace: string
The namespace for all settings.
Returns TJSGameSettings<ExtraProps>
Methods
data
- data(
regex?: RegExp,
): IterableIterator<TJSGameSettings.Data.GameSetting<ExtraProps>> Returns an iterable for the game setting data; TJSGameSettings.Data.GameSetting.
Parameters
Optionalregex: RegExpOptional 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
Parameters
Optionalregex: RegExpOptional regular expression to filter by game setting keys.
Returns IterableIterator<[string, MinimalWritable<T>]>
Iterable iterator of keys and stores.
getReadableStore
getStore
- getStore<T>(key: string): MinimalWritable<T>
Returns a writable Game Settings store for the associated key.
Type Parameters
Parameters
- key: string
Game setting key.
Returns MinimalWritable<T>
The associated store for the given game setting key.
- key: string
getWritableStore
- getWritableStore<T>(key: string): MinimalWritable<T>
Returns a writable Game Settings store for the associated key.
Type Parameters
Parameters
- key: string
Game setting key.
Returns MinimalWritable<T>
The associated store for the given game setting key.
- key: string
keys
- keys(regex?: RegExp): IterableIterator<string>
Returns an iterable for the game setting keys from existing stores.
Parameters
Optionalregex: RegExpOptional 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: booleanWhen false this overrides the
setting.options.configparameter 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
- setting: TJSGameSettings.Options.GameSetting<ExtraProps>
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: booleanWhen false this overrides the
setting.options.configparameter 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
keyadded.- settings: Iterable<TJSGameSettings.Options.GameSetting<ExtraProps>>
stores
- stores<T>(regex?: RegExp): IterableIterator<MinimalWritable<T>>
Returns an iterable for the game setting stores.
Type Parameters
Parameters
Optionalregex: RegExpOptional regular expression to filter by game setting keys.
Returns IterableIterator<MinimalWritable<T>>
Iterable iterator of stores.
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
onChangecallbacks on registration.Type Param
ExtraProps- Defines additional properties for game setting options / data that child implementations may define.