SettingsSchemas Class
Beta
The registry of available SettingSchemaGroups. The registry is used for editing Settings files and for finding default values for settings.
Methods
| Name | Description | |
|---|---|---|
| addDirectory(dirName: string): void Static | Add all files with a either ".json" or ".json5" extension from a supplied directory. | |
| addFile(fileName: string): void Static | Add a SettingSchemaGroup from a json5 file. | |
| addGroup(settingsGroup: SettingSchemaGroup | SettingSchemaGroup[]): void Static | Add one or more SettingSchemaGroups. | |
| addJson(settingSchema: string): void Static | Add a SettingSchemaGroup from stringified json5. | |
| removeGroup(groupName: string): void Static | Remove a previously added SettingSchemaGroup by groupName |
Properties
| Name | Type | Description | |
|---|---|---|---|
| allSchemas StaticReadonly | Map<string, SettingSchema> | a map of all registered SettingSchemas | |
| onSchemaChanged StaticReadonly | BeEvent<() => void> | event that signals that the values in SettingsSchemas.allSchemas have changed in some way. |
Defined in
Last Updated: 20 June, 2023