Options
All
  • Public
  • Public/Protected
  • All
Menu

The client-side Setting document which extends the common BaseSetting model.

mixes

ClientDocumentMixin

see

WorldSettings The world-level collection of Setting documents

Hierarchy

  • any
    • Setting

Index

Constructors

  • Returns Setting

Accessors

  • The setting configuration for this setting document.

    Returns SettingsConfig

Methods

  • _initialize(options?: {}): void
  • inheritdoc

    Parameters

    • options: {} = {}

      Returns void

    • _onCreate(data: any, options: any, userId: any): void
    • override

      Parameters

      • data: any
      • options: any
      • userId: any

      Returns void

    • _onUpdate(changed: any, options: any, userId: any): void
    • override

      Parameters

      • changed: any
      • options: any
      • userId: any

      Returns void

    • _castType(): any
    • Cast the value of the Setting into its defined type.

      Returns any

      The initialized type of the Setting document.

    Properties

    value: any
    #PRIMITIVE_TYPES: readonly (SymbolConstructor | StringConstructor | BooleanConstructor | NumberConstructor | ArrayConstructor | BigIntConstructor)[] = ...

    The types of settings which should be constructed as a function call rather than as a class constructor.