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

Меню ​

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

Интерфейсы ​

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

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

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

LocaleVariant"эн" | "ру" | "сп" | "эс" ​

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

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

Функции ​

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

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

  • idчисло - Идентификатор.

Вернулся:

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

IsNewMenu()логическое значение ​

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

Вернулся:

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

GetLocale()LocaleVariant ​

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

Вернулся:

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

SetVisible(value: boolean)пустота ​

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

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

IsVisible()логическое значение ​

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

Вернулся:

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

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

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

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

Вернулся:

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

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

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

  • whereAtнить[] – Путь menu, по которому следует добавить или разрешить параметр.
  • nameнить - Имя.
  • minValueчисло - Минимальное значение.
  • maxValueчисло - Максимальное значение.
  • defaultValueчисло - Значение по умолчанию.
  • stepчисло (необязательный) - Шаг.

Вернулся:

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

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

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

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

Вернулся:

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

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

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

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

Вернулся:

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

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

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

  • whereAtнить[] – Путь menu, по которому следует добавить или разрешить параметр.
  • nameнить - Имя.
  • valuesнить[] - Значения, которые следует использовать.
  • defaultStateлогическое значение[] | логическое значение - Состояние по умолчанию.

Вернулся:

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

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

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

  • whereAtнить[] – Путь menu, по которому следует добавить или разрешить параметр.
  • nameнить - Имя.
  • imagesнить[] - Изображения.
  • defaultStateлогическое значение[] | логическое значение - Состояние по умолчанию.
  • reservedSlotsчисло (необязательный) - Зарезервированные слоты.

Вернулся:

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

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

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

  • whereAtнить[] – Путь menu, по которому следует добавить или разрешить параметр.
  • nameнить - Имя.
  • imagesнить[] - Изображения.
  • defaultStateлогическое значение[] | логическое значение - Состояние по умолчанию.
  • reservedSlotsчисло (необязательный) - Зарезервированные слоты.

Вернулся:

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

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

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

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

Вернулся:

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

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

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

Вернулся:

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

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

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

Вернулся:

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

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

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

  • whereAtнить[] – Путь menu, по которому следует добавить или разрешить параметр.
  • namesнить[] - Имена.
  • stateлогическое значение[] | логическое значение - Государство.
  • verticalлогическое значение (необязательный) - Вертикаль.

Вернулся:

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

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

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

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

Вернулся:

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

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

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

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

Вернулся:

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

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

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

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

Вернулся:

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

SetPathLocale(whereAt: string[], locale: LocaleVariant, whereAtNew: string[])пустота ​

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

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

OpenFolder(path: string[])пустота ​

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

  • pathнить[] - Путь.

HighlightOption(path: string[])пустота ​

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

  • pathнить[] - Путь.

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

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

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

Вернулся:

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

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

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

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

Вернулся:

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

SetImage(whereAt: string[], imagePath: string)пустота ​

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

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

OnOptionAdded(func: (option: MenuOption<any>) => void)пустота ​

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

  • func(вариант: MenuOption<any>) => void - Функц.

IsKeyDownOnce(handle: MenuKeyBindHandler, checkInputCapture?: boolean)логическое значение ​

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

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

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

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

Вернулся:

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

IsKeyDown(handle: MenuKeyBindHandler, checkInputCapture?: boolean)логическое значение ​

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

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

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

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

Вернулся:

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

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

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

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

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

Вернулся:

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

SetTipLocale(handle: MenuOptionHandler, locale: LocaleVariant, tip: string)пустота ​

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

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

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

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

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

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

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

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

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

Вернулся:

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