Документация Melonity

Config ​

Config пространство имен предоставляет помощники для чтения, записи и сохранения данных конфигурации скрипта.

Функции ​

GetConfig(configName: string){ [key: string]: any; } ​

Извлекает объект config по его имени.

  • configNamestring - Имя объекта конфигурации.

Важно

После изменения объекта config вы должны вызвать SaveConfig чтобы сохранить изменения.

Возвращает:

  • { [key: string]: any; } - Объект конфигурации.

SaveConfig(configName: string)void ​

Сохраняет объект конфигурации под его именем.

  • configNamestring - Имя объекта конфигурации.

Read(configName: string, key: string, defaultValue: any)any ​

Считывает значение из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для чтения.
  • defaultValueany — Значение по умолчанию, которое возвращается, если ключ не существует.

Важно

Если значение представляет собой строку, оно будет проанализировано как JSON.

Возвращает:

  • any — Значение из объекта конфигурации или значение по умолчанию.

ReadRaw(configName: string, key: string, defaultValue: any)any ​

Считывает необработанное значение из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для чтения.
  • defaultValueany — Значение по умолчанию, которое возвращается, если ключ не существует.

Важно

Если значение является строкой, оно не будет анализироваться как JSON.

Возвращает:

  • any — Необработанное значение из объекта конфигурации или значение по умолчанию.

ReadInt(configName: string, key: string, defaultValue: number)number ​

Считывает целочисленное значение из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для чтения.
  • defaultValuenumber — Значение по умолчанию, которое возвращается, если ключ не существует.

Возвращает:

  • number — Целочисленное значение из объекта конфигурации или значение по умолчанию.

ReadFloat(configName: string, key: string, defaultValue: number)number ​

Считывает значение с плавающей запятой из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для чтения.
  • defaultValuenumber — Значение по умолчанию, которое возвращается, если ключ не существует.

Возвращает:

  • number — Значение с плавающей запятой из объекта конфигурации или значение по умолчанию.

ReadString(configName: string, key: string, defaultValue: string)string ​

Считывает строковое значение из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для чтения.
  • defaultValuestring — Значение по умолчанию, которое возвращается, если ключ не существует.

Возвращает:

  • string — Строковое значение из объекта конфигурации или значение по умолчанию.

Write(configName: string, key: string, value: any)void ​

Записывает значение в объект конфигурации и сохраняет его.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для записи.
  • valueany - Значение для записи.

WriteRaw(configName: string, key: string, value: any)void ​

Записывает необработанное значение в объект конфигурации и сохраняет его.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для записи.
  • valueany - Значение для записи.

Важно

Непосредственно записывает значение в объект конфигурации.

WriteInt(configName: string, key: string, value: number)void ​

Записывает целочисленное значение в объект конфигурации и сохраняет его.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для записи.
  • valuenumber — Целочисленное значение для записи.

WriteFloat(configName: string, key: string, value: number)void ​

Записывает значение с плавающей запятой в объект конфигурации и сохраняет его.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для записи.
  • valuenumber — Значение с плавающей запятой для записи.

WriteString(configName: string, key: string, value: string)void ​

Записывает строковое значение в объект конфигурации и сохраняет его.

  • configNamestring - Имя объекта конфигурации.
  • keystring - Ключ значения для записи.
  • valuestring — Строковое значение для записи.