Class ListBuilder<TOpts>

constructor

• new ListBuilder<TOpts>(name, manager): ListBuilder<TOpts>

• Type Parameters

  • TOpts extends OptionsMap

  Parameters

  • name: string

  • manager: SettingsManager

  Returns ListBuilder<TOpts>

definitions

manager

name

addOptionBoolean

• addOptionBoolean<TName, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "boolean", TDefault, false>>

• Type Parameters

  • TName extends string

  • TDefault extends undefined | boolean = undefined

  Parameters

  • name: TName

  • options: BaseOptions<false, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "boolean", TDefault, false>>

addOptionChannel

• addOptionChannel<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "channel", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | string = undefined

  Parameters

  • name: TName

  • options: ChannelOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "channel", TDefault, TRequired>>

addOptionChannels

• addOptionChannels<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "channels", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | string[] = undefined

  Parameters

  • name: TName

  • options: ChannelsOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "channels", TDefault, TRequired>>

addOptionCustomNumberMultiSelect

• addOptionCustomNumberMultiSelect<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "customNumberMultiSelect", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | number[] = undefined

  Parameters

  • name: TName

  • options: CustomNumberMultiSelectOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "customNumberMultiSelect", TDefault, TRequired>>

addOptionCustomNumberSelect

• addOptionCustomNumberSelect<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "customNumberSelect", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | number = undefined

  Parameters

  • name: TName

  • options: CustomNumberSelectOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "customNumberSelect", TDefault, TRequired>>

addOptionCustomStringMultiSelect

• addOptionCustomStringMultiSelect<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "customStringMultiSelect", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | string[] = undefined

  Parameters

  • name: TName

  • options: CustomStringMultiSelectOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "customStringMultiSelect", TDefault, TRequired>>

addOptionCustomStringSelect

• addOptionCustomStringSelect<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "customStringSelect", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | string = undefined

  Parameters

  • name: TName

  • options: CustomStringSelectOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "customStringSelect", TDefault, TRequired>>

addOptionFloat

• addOptionFloat<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "float", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | number = undefined

  Parameters

  • name: TName

  • options: FloatOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "float", TDefault, TRequired>>

addOptionInteger

• addOptionInteger<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "integer", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | number = undefined

  Parameters

  • name: TName

  • options: IntegerOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "integer", TDefault, TRequired>>

addOptionInteger64

• addOptionInteger64<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "integer64", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | string = undefined

  Parameters

  • name: TName

  • options: Integer64Options<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "integer64", TDefault, TRequired>>

addOptionRole

• addOptionRole<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "role", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | string = undefined

  Parameters

  • name: TName

  • options: RoleOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "role", TDefault, TRequired>>

addOptionRoles

• addOptionRoles<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "roles", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | string[] = undefined

  Parameters

  • name: TName

  • options: RolesOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "roles", TDefault, TRequired>>

addOptionString

• addOptionString<TName, TRequired, TDefault>(name, options): ListBuilder<LayerOption<TOpts, TName, "string", TDefault, TRequired>>

• Type Parameters

  • TName extends string

  • TRequired extends boolean = false

  • TDefault extends undefined | string = undefined

  Parameters

  • name: TName

  • options: StringOptions<TRequired, TDefault>

  Returns ListBuilder<LayerOption<TOpts, TName, "string", TDefault, TRequired>>

complete

• complete(options?): LoadedList<TOpts>

• Parameters

  • Optional options: ListOptions<OptionMapValues<TOpts>[]>

  Returns LoadedList<TOpts>