Skip to content

@pumpkin-plugins/tab-display API / config / loadTabDisplayConfig

Function: loadTabDisplayConfig() ​

loadTabDisplayConfig(store): object

Defined in: packages/tab-display/src/config.ts:158

Loads values from a config store and rejects invalid candidates before the caller swaps them.

Parameters ​

store ​

ConfigStore

Returns ​

object

config ​

readonly config: object

config.bedrock ​

bedrock: SectionValues<{ objective_enabled: Field<boolean>; }>

config.entry ​

entry: SectionValues<{ bold: Field<boolean>; color: Field<string>; enabled: Field<boolean>; italic: Field<boolean>; strikethrough: Field<boolean>; text: Field<string>; underlined: Field<boolean>; }>

footer: SectionValues<{ lines: Field<readonly TemplateLineConfig[]>; }>

config.general ​

general: SectionValues<{ enabled: Field<boolean>; max_players: Field<number>; refresh_ticks: Field<number>; version: Field<number>; }>

config.header ​

header: SectionValues<{ lines: Field<readonly TemplateLineConfig[]>; }>

config.objective ​

objective: SectionValues<{ enabled: Field<boolean>; value: Field<string>; }>

config.placeholders ​

placeholders: SectionValues<{ missing_provider: Field<string>; provider: Field<string>; unresolved: Field<string>; }>

config.sorting ​

sorting: SectionValues<{ rules: Field<readonly ConfigSortRule[]>; }>

warnings ​

readonly warnings: readonly string[]

pumpkin-plugins documentation