Interface GameSetting
interface GameSetting {
configApp?: boolean;
folder?: string;
key: string;
namespace?: string;
options: CoreSetting;
readonly?: boolean;
store?: MinimalWritable<any>;
}
configApp?: boolean;
folder?: string;
key: string;
namespace?: string;
options: CoreSetting;
readonly?: boolean;
store?: MinimalWritable<any>;
}
Hierarchy
- TJSGameSettings.Options.GameSetting<ExtraProps>
- GameSetting (View Summary)
Properties
OptionalconfigApp
configApp?: boolean
Overrides core config game setting option allowing the setting to be available to edit via
#standard/component/fvtt/settings!TJSSettingsEdit. This will hide the setting from the standard
Foundry settings configuration panel, but show it in the TRL settings edit panel.
Optionalfolder
folder?: string
The name of the TJSSvgFolder to put this setting in to group them.
key
key: string
The setting key to register.
Optionalnamespace
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
Core game setting configuration options.
Optionalreadonly
readonly?: boolean
Makes the input element readonly; useful for file input to prevent editing of the file path.
Optionalstore
An existing store instance to use.
Defines the game setting with UI options for TJSGameSettings.register.