Class ControlsService<T>

Type Parameters

T extends object

Index

Constructors

constructor

Methods

addCheckbox addColorSwatch addDropdown addHeader addSoundDropdown addSwitchCheckbox

Constructors

constructor

new ControlsService<T extends object>(
    settings: SettingsService<T>,
    messages: MessagesService,
    variablePrefix: string,
): ControlsService<T>
Type Parameters
- T extends object
Parameters
- settings: SettingsService<T>
- messages: MessagesService
- variablePrefix: string
  Starts the name the game saves each control under, so two addons never share one.
Returns ControlsService<T>
- Defined in controls.service.ts:13

Methods

addCheckbox

addCheckbox(
    category: SettingsCategory,
    variable: string,
    label: string,
    tooltip: string | undefined,
    isOnByDefault: boolean,
    get: () => boolean,
    set: (isChecked: boolean) => void,
): void
Parameters
- category: SettingsCategory
- variable: string
- label: string
- tooltip: string | undefined
- isOnByDefault: boolean
- get: () => boolean
- set: (isChecked: boolean) => void
Returns void
- Defined in controls.service.ts:24

addColorSwatch

addColorSwatch(
    category: SettingsCategory,
    variable: string,
    label: string,
    defaultColor: Rgb,
    get: () => Rgb,
    set: (color: Rgb) => void,
): void
A color the player can pick; skipped on clients without color swatches.
Parameters
- category: SettingsCategory
- variable: string
- label: string
- defaultColor: Rgb
- get: () => Rgb
- set: (color: Rgb) => void
Returns void
- Defined in controls.service.ts:104

addDropdown

addDropdown(
    category: SettingsCategory,
    variable: string,
    label: string,
    tooltip: string,
    defaultValue: string,
    get: () => string,
    set: (value: string) => void,
    items: () => [value: string, label: string][],
    isStatic?: boolean,
): void
items returns [value, label] pairs; a static list is built once.
Parameters
- category: SettingsCategory
- variable: string
- label: string
- tooltip: string
- defaultValue: string
- get: () => string
- set: (value: string) => void
- items: () => [value: string, label: string][]
- isStatic: boolean = false
Returns void
- Defined in controls.service.ts:54

addHeader

addHeader(layout: SettingsLayout, label: string): void
Parameters
- layout: SettingsLayout
- label: string
Returns void
- Defined in controls.service.ts:20

addSoundDropdown

addSoundDropdown(
    category: SettingsCategory,
    variable: string,
    label: string,
    tooltip: string,
    get: () => SoundKey,
    set: (key: SoundKey) => void,
): void
The sound of a reminder; choosing one plays it once as a preview.
Parameters
- category: SettingsCategory
- variable: string
- label: string
- tooltip: string
- get: () => SoundKey
- set: (key: SoundKey) => void
Returns void
- Defined in controls.service.ts:79

addSwitchCheckbox

addSwitchCheckbox(
    category: SettingsCategory,
    key: SwitchKey<T>,
    label: string,
    tooltip: string,
): void
A switch stored in the settings under key; its default is the default of the setting.
Parameters
- category: SettingsCategory
- key: SwitchKey<T>
- label: string
- tooltip: string
Returns void
- Defined in controls.service.ts:41

Class ControlsService<T>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ControlsService<T>

Methods

addCheckbox

Parameters

Returns void

addColorSwatch

Parameters

Returns void

addDropdown

Parameters

Returns void

addHeader

Parameters

Returns void

addSoundDropdown

Parameters

Returns void

addSwitchCheckbox

Parameters

Returns void

Settings

On This Page