Config
Config пространство имен предоставляет помощники для чтения, записи и сохранения данных конфигурации скрипта.
Функции
GetConfig(configName: string){ [key: string]: any; }
Извлекает объект config по его имени.
configNameнить - Имя объекта конфигурации.
IMPORTANT
После изменения объекта config вы должны вызвать SaveConfig чтобы сохранить изменения.
Вернулся:
- { [key: string]: any; } - Объект конфигурации.
SaveConfig(configName: string)пустота
Сохраняет объект конфигурации под его именем.
configNameнить - Имя объекта конфигурации.
Read(configName: string, key: string, defaultValue: any)любой
Считывает значение из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для чтения.defaultValueлюбой — Значение по умолчанию, которое возвращается, если ключ не существует.
IMPORTANT
Если значение представляет собой строку, оно будет проанализировано как JSON.
Вернулся:
- любой — Значение из объекта конфигурации или значение по умолчанию.
ReadRaw(configName: string, key: string, defaultValue: any)любой
Считывает необработанное значение из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для чтения.defaultValueлюбой — Значение по умолчанию, которое возвращается, если ключ не существует.
IMPORTANT
Если значение является строкой, оно не будет анализироваться как JSON.
Вернулся:
- любой — Необработанное значение из объекта конфигурации или значение по умолчанию.
ReadInt(configName: string, key: string, defaultValue: number)число
Считывает целочисленное значение из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для чтения.defaultValueчисло — Значение по умолчанию, которое возвращается, если ключ не существует.
Вернулся:
- число — Целочисленное значение из объекта конфигурации или значение по умолчанию.
ReadFloat(configName: string, key: string, defaultValue: number)число
Считывает значение с плавающей запятой из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для чтения.defaultValueчисло — Значение по умолчанию, которое возвращается, если ключ не существует.
Вернулся:
- число — Значение с плавающей запятой из объекта конфигурации или значение по умолчанию.
ReadString(configName: string, key: string, defaultValue: string)нить
Считывает строковое значение из объекта конфигурации. Если значение не существует, оно возвращает значение по умолчанию.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для чтения.defaultValueнить — Значение по умолчанию, которое возвращается, если ключ не существует.
Вернулся:
- нить — Строковое значение из объекта конфигурации или значение по умолчанию.
Write(configName: string, key: string, value: any)пустота
Записывает значение в объект конфигурации и сохраняет его.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для записи.valueлюбой - Значение для записи.
WriteRaw(configName: string, key: string, value: any)пустота
Записывает необработанное значение в объект конфигурации и сохраняет его.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для записи.valueлюбой - Значение для записи.
IMPORTANT
Непосредственно записывает значение в объект конфигурации.
WriteInt(configName: string, key: string, value: number)пустота
Записывает целочисленное значение в объект конфигурации и сохраняет его.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для записи.valueчисло — Целочисленное значение для записи.
WriteFloat(configName: string, key: string, value: number)пустота
Записывает значение с плавающей запятой в объект конфигурации и сохраняет его.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для записи.valueчисло — Значение с плавающей запятой для записи.
WriteString(configName: string, key: string, value: string)пустота
Записывает строковое значение в объект конфигурации и сохраняет его.
configNameнить - Имя объекта конфигурации.keyнить - Ключ значения для записи.valueнить — Строковое значение для записи.