Class ConfigItem

constructor

• new ConfigItem(
      key: string,
      section: string,
      name: string,
      desc: string,
      defaultValue: string,
  ): ConfigItem

  Ignore, don't use the constructor directly! Use the static methods such as createBoolean or createString etc..

  Parameters

  • key: string
  • section: string
  • name: string
  • desc: string
  • defaultValue: string

  Returns ConfigItem

ReadonlydataType

ReadonlydefaultValue

Readonlydesc

Readonlykey

Readonlyname

Readonlysection

getValue

• getValue(): any

  Returns the value associated with this config item which has been set in the package manager

  Returns any

setValue

• setValue(value: any): void

  Overrides the value associated with this config item and is reflected in the package manager

  Parameters

  • value: any

  Returns void

StaticcreateBoolean

• createBoolean(
      key: string,
      section: string,
      name: string,
      desc: string,
      defaultValue: boolean,
  ): ConfigItem

  Create a config item which will be editable by users through the package config manager

  Parameters

  • key: string

    a unique string associated with the config item to identify it amongst others
  • section: string

    the section the items falls under in the config
  • name: string

    display name of the config item
  • desc: string

    define a small description for the config item
  • defaultValue: boolean

    the default value your config item presents, it can be anything in-line with your data type

  Returns ConfigItem

StaticcreateInteger

• createInteger(
      key: string,
      section: string,
      name: string,
      desc: string,
      defaultValue: number,
  ): ConfigItem

  Create a config item which will be editable by users through the package config manager

  Parameters

  • key: string

    a unique string associated with the config item to identify it amongst others
  • section: string

    the section the items falls under in the config
  • name: string

    display name of the config item
  • desc: string

    define a small description for the config item
  • defaultValue: number

    the default value your config item presents, it can be anything in-line with your data type

  Returns ConfigItem

StaticcreateIntegerRange

• createIntegerRange(
      key: string,
      section: string,
      name: string,
      desc: string,
      rangeMin: number,
      rangeMax: number,
      defaultValue: number,
  ): ConfigItem

  Create a config item which will be editable by users through the package config manager

  Parameters

  • key: string

    a unique string associated with the config item to identify it amongst others
  • section: string

    the section the items falls under in the config
  • name: string

    display name of the config item
  • desc: string

    define a small description for the config item
  • rangeMin: number

    for integer types, define the minimum value a user can input
  • rangeMax: number

    for integer types, define the maximum value a user can input
  • defaultValue: number

    the default value your config item presents, it can be anything in-line with your data type

  Returns ConfigItem

StaticcreateKeyBind

• createKeyBind(
      key: string,
      section: string,
      name: string,
      desc: string,
      defaultValue: boolean,
  ): ConfigItem

  Create a config item which will be editable by users through the package config manager

  Parameters

  • key: string

    a unique string associated with the config item to identify it amongst others
  • section: string

    the section the items falls under in the config
  • name: string

    display name of the config item
  • desc: string

    define a small description for the config item
  • defaultValue: boolean

    the default value your config item presents, format: new WorldPoint(x, y, z) OR null to show 'not set'

  Returns ConfigItem

StaticcreateList

• createList(
      key: string,
      section: string,
      name: string,
      desc: string,
      listContent: string[],
      defaultValue: string,
  ): ConfigItem

  Create a config item which will be editable by users through the package config manager

  Parameters

  • key: string

    a unique string associated with the config item to identify it amongst others
  • section: string

    the section the items falls under in the config
  • name: string

    display name of the config item
  • desc: string

    define a small description for the config item
  • listContent: string[]

    for list types, an array of items which be selectable in the dropdown menu
  • defaultValue: string

    the default value your config item presents, it can be anything in-line with your data type

  Returns ConfigItem

StaticcreateString

• createString(
      key: string,
      section: string,
      name: string,
      desc: string,
      defaultValue: string,
  ): ConfigItem

  Create a config item which will be editable by users through the package config manager

  Parameters

  • key: string

    a unique string associated with the config item to identify it amongst others
  • section: string

    the section the items falls under in the config
  • name: string

    display name of the config item
  • desc: string

    define a small description for the config item
  • defaultValue: string

    the default value your config item presents, it can be anything in-line with your data type

  Returns ConfigItem

StaticcreateWorldPoint

• createWorldPoint(
      key: string,
      section: string,
      name: string,
      desc: string,
      defaultValue: boolean,
  ): ConfigItem

  Create a config item which will be editable by users through the package config manager

  Parameters

  • key: string

    a unique string associated with the config item to identify it amongst others
  • section: string

    the section the items falls under in the config
  • name: string

    display name of the config item
  • desc: string

    define a small description for the config item
  • defaultValue: boolean

    the default value your config item presents, format: new WorldPoint(x, y, z) OR null to show 'not set'

  Returns ConfigItem