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

Меню ​

Menu пространство имен предоставляет API для создания, получения и управления параметрами скрипта menu.

Интерфейсы ​

MenuOptionChange Интерфейс описывает соответствующую форму объекта, предоставляемую объявлениями.

  • indexMenuOption<T> - Индекс.
  • oldValueT - Старое значение.
  • newValueT - Новое значение.

Введите псевдонимы ​

LocaleVariant"en" | "ru" | "cn" | "es" ​

LocaleVariant введите псевдоним.

MenuOptionChangeCallback введите псевдоним.

Функции ​

GetOptionById(id: number)MenuOption<any> | null ​

Получает опцию по идентификатору.

  • idnumber - Идентификатор.

Возвращает:

  • MenuOption<any> | null - Соответствующий объект или null если он недоступен.

IsNewMenu()boolean ​

Проверяет, новый ли это menu.

Возвращает:

  • boolean - Истина, если условие выполнено, и ложь в противном случае.

GetLocale()LocaleVariant ​

Получает локаль.

Возвращает:

  • LocaleVariant - Запрошенная локаль.

SetVisible(value: boolean)void ​

Устанавливает видимое.

  • valueboolean — Значение, которое нужно установить или использовать.

IsVisible()boolean ​

Проверяет, видно ли это.

Возвращает:

  • boolean - Истина, если условие выполнено, и ложь в противном случае.

AddToggle(whereAt: string[], name: string, defaultValue: boolean)MenuOption<boolean> ​

Добавляет переключатель.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • defaultValueboolean - Значение по умолчанию.

Возвращает:

  • MenuOption<boolean> - Результат звонка.

AddSlider(whereAt: string[], name: string, minValue: number, maxValue: number, defaultValue: number, step?: number)MenuOption<number> ​

Добавляет слайдер.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • minValuenumber - Минимальное значение.
  • maxValuenumber - Максимальное значение.
  • defaultValuenumber - Значение по умолчанию.
  • stepnumber (необязательный) - Шаг.

Возвращает:

  • MenuOption<number> - Результат звонка.

AddInputBox(whereAt: string[], name: string, defaultValue: string)MenuOption<string> ​

Добавляет поле input.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • defaultValuestring - Значение по умолчанию.

Возвращает:

  • MenuOption<string> - Результат звонка.

AddComboBox(whereAt: string[], name: string, values: string[], defaultValueIndex: number)MenuOption<number> ​

Добавляет поле со списком.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • valuesstring[] - Значения, которые следует использовать.
  • defaultValueIndexnumber - Индекс значения по умолчанию.

Возвращает:

  • MenuOption<number> - Результат звонка.

AddMultiComboBox(whereAt: string[], name: string, values: string[], defaultState: boolean[] | boolean)MenuOption<boolean[]> ​

Добавляет многофункциональное поле со списком.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • valuesstring[] - Значения, которые следует использовать.
  • defaultStateboolean[] | boolean - Состояние по умолчанию.

Возвращает:

  • MenuOption<boolean[]> - Результат звонка.

AddMultiSelect(whereAt: string[], name: string, images: string[], defaultState: boolean[] | boolean, reservedSlots?: number)MenuOption<boolean[]> ​

Добавляет множественный выбор.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • imagesstring[] - Изображения.
  • defaultStateboolean[] | boolean - Состояние по умолчанию.
  • reservedSlotsnumber (необязательный) - Зарезервированные слоты.

Возвращает:

  • MenuOption<boolean[]> - Результат звонка.

AddPrioritySelect(whereAt: string[], name: string, images: string[], defaultState: boolean[] | boolean, reservedSlots?: number)MenuOption<number[]> ​

Добавляет выбор приоритета.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • imagesstring[] - Изображения.
  • defaultStateboolean[] | boolean - Состояние по умолчанию.
  • reservedSlotsnumber (необязательный) - Зарезервированные слоты.

Возвращает:

  • MenuOption<number[]> - Результат звонка.

AddColorPicker(whereAt: string[], name: string, color: Color)MenuOption<Color> ​

Добавляет средство выбора color.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • colorColor – Используемое значение color.

Возвращает:

AddColorPickerBlock(whereAt: string[], color: Color)MenuOption<Color> ​

Добавляет блок выбора color.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • colorColor – Используемое значение color.

Возвращает:

AddKeyBind(whereAt: string[], name: string, defaultKey: number)MenuOption<number> ​

Добавляет привязку клавиш.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • defaultKeynumber - Ключ по умолчанию.

Возвращает:

  • MenuOption<number> - Результат звонка.

AddToggleBlock(whereAt: string[], names: string[], state: boolean[] | boolean, vertical?: boolean)MenuOption<boolean[]> ​

Добавляет блок переключения.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namesstring[] - Имена.
  • stateboolean[] | boolean - Государство.
  • verticalboolean (необязательный) - Вертикаль.

Возвращает:

  • MenuOption<boolean[]> - Результат звонка.

AddHeroSelect(whereAt: string[], name: string, defaultValue: string[])MenuOption<string[]> ​

defaultValue — это массив строк имен героев, таких как npc_dota_hero_techies, npc_dota_hero_pudge.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • defaultValuestring[] - Значение по умолчанию.

Возвращает:

  • MenuOption<string[]> - Результат звонка.

AddButton(whereAt: string[], name: string, callback: () => void)MenuOption<void> ​

Добавляет кнопку.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.
  • callback() => void - Обратный звонок.

Возвращает:

  • MenuOption<void> - Результат звонка.

AddLabel(whereAt: string[], name: string)MenuOption<void> ​

Добавляет метку.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namestring - Имя.

Возвращает:

  • MenuOption<void> - Результат звонка.

SetPathLocale(whereAt: string[], locale: LocaleVariant, whereAtNew: string[])void ​

Устанавливает языковой стандарт пути.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • localeLocaleVariant - Локаль для использования.
  • whereAtNewstring[] - Где в новом.

OpenFolder(path: string[])void ​

Открывает папку.

  • pathstring[] - Путь.

HighlightOption(path: string[])void ​

Обеспечивает доступ к опции выделения.

  • pathstring[] - Путь.

GetFolder(whereAt: string[])MenuOption<void> | null ​

Получает папку.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.

Возвращает:

  • MenuOption<void> | null - Соответствующий объект или null если он недоступен.

GetOption<T = any>(whereAt: string[])MenuOption<T> | null ​

Получает параметр.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.

Возвращает:

  • MenuOption<T> | null - Соответствующий объект или null если он недоступен.

SetImage(whereAt: string[], imagePath: string)void ​

Устанавливает изображение.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.
  • imagePathstring - Путь изображения.

OnOptionAdded(func: (option: MenuOption<any>) => void)void ​

Предоставляет доступ к добавленной опции.

  • func(option: MenuOption<any>) => void - Функц.

IsKeyDownOnce(handle: MenuKeyBindHandler, checkInputCapture?: boolean)boolean ​

Проверяет, была ли указанная клавиша нажата один раз.

  • handleMenuKeyBindHandler - Ручка.
  • checkInputCaptureboolean (необязательный) - Захват чека input.

Предупреждение

Устарело. вместо этого используйте option.IsKeyDownOnce

Возвращает:

  • boolean - Истина, если условие выполнено, и ложь в противном случае.

IsKeyDown(handle: MenuKeyBindHandler, checkInputCapture?: boolean)boolean ​

Проверяет, удерживается ли в данный момент указанная клавиша.

  • handleMenuKeyBindHandler - Ручка.
  • checkInputCaptureboolean (необязательный) - Захват чека input.

Предупреждение

Устарело. вместо этого используйте option.IsKeyDown

Возвращает:

  • boolean - Истина, если условие выполнено, и ложь в противном случае.

GetValue<T>(handle: MenuOption<T>)T ​

Получает указанное значение переменной консоли.

Предупреждение

Устарело. вместо этого используйте option.GetValue

Возвращает:

  • T - Запрошенное значение.

SetTipLocale(handle: MenuOptionHandler, locale: LocaleVariant, tip: string)void ​

Устанавливает локаль подсказки.

  • handleMenuOptionHandler - Ручка.
  • localeLocaleVariant - Локаль для использования.
  • tipstring - Совет.

Предупреждение

Устарело. вместо этого используйте option.SetTipLocale

GetFolderOptions(whereAt: string[])MenuOption<any>[] | null ​

Получает параметры папки.

  • whereAtstring[] – Путь menu, по которому следует добавить или разрешить параметр.

Предупреждение

Устарело. вместо этого используйте option.GetChildrens

Возвращает:

  • MenuOption<any>[] | null - Соответствующий объект или null если он недоступен.