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

MenuOption ​

MenuOption Класс представляет экземпляр параметра menu и предоставляет API для его чтения, обновления и настройки.

Методы ​

GetOptionID()number ​

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

Возвращает:

  • number - Идентификатор запрошенной опции.

GetType()Enum.MenuOptionType ​

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

Возвращает:

IsFolder()boolean ​

Проверяет, является ли это папкой.

Возвращает:

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

OnChange(func: MenuOptionChangeCallback<T>, initCall?: boolean)this ​

Зарегистрируйте функцию, которая будет вызываться при изменении значения опции.

  • funcMenuOptionChangeCallback<T> - функция для вызова при изменении значения опции
  • initCallboolean (необязательный) - если true, функция будет вызываться с текущим значением для инициализации, полезной, если регистрация вашей цепочки не заканчивается GetValue (по умолчанию — false)

Важно

полезно, если регистрация вашей цепочки не заканчивается на GetValue

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

GetValue()T ​

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

Возвращает:

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

SetValue(value: T)this ​

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

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

GetSlotValueByIndex(index: number)boolean ​

Получает значение слота по индексу.

  • indexnumber - Индекс.

Важно

можно использовать только с ToggleBlock, MultiSelect или MultiComboBox

Возвращает:

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

SetSlotValueByIndex(index: number, value: boolean)this ​

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

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

Важно

можно использовать только с ToggleBlock, MultiSelect или MultiComboBox

Возвращает:

  • this - Текущий экземпляр для цепочки.

GetSlotValueByKey(key: string)boolean ​

Получает значение слота по ключу.

  • keystring - Ключ.

Важно

можно использовать только с ToggleBlock, MultiSelect или MultiComboBox

Возвращает:

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

SetSlotValueByKey(key: string, value: boolean)this ​

Устанавливает значение слота по ключу.

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

Важно

можно использовать только с ToggleBlock, MultiSelect или MultiComboBox

Возвращает:

  • this - Текущий экземпляр для цепочки.

GetBindedValue(){ value: T } ​

Возвращаемый объект со значением, которое будет обновляться при изменении значения параметра, поможет избежать явной регистрации OnChange.

Возвращает:

  • { value: T } - Запрошенное привязанное значение.

GetPrioritySelectValue()string[] ​

Получает значение выбора приоритета.

Возвращает:

  • string[] - Массив с совпадающими значениями.

SetTip(text: string, locale?: LocaleVariant)this ​

Установите текст, который будет отображаться под опцией

  • textstring - текст для показа
  • localeLocaleVariant (необязательный) - текстовая локаль, по умолчанию «en»

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

SetTip2(text: string, locale?: LocaleVariant)this ​

Установите текст, который будет отображаться, если вы наведете курсор на опцию

  • textstring - текст для показа
  • localeLocaleVariant (необязательный) - текстовая локаль, по умолчанию «en»

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

SetTip2Title(text: string, locale?: LocaleVariant)this ​

Установите заголовок, который будет отображаться, если вы наведете курсор на опцию

  • textstring - текст для показа
  • localeLocaleVariant (необязательный) - текстовая локаль, по умолчанию «en»

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

SetTip2Image(imagePath: string)this ​

Установите изображение, которое будет отображаться, если вы наведете курсор на опцию

  • imagePathstring - путь к изображению

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

SetColumn(value: number)this ​

Устанавливает столбец.

  • valuenumber - 0 - слева, 1 - справа

Важно

Это не будет работать, если используется MergeWithNext.

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

GetColumn()number ​

Извлекает столбец.

Возвращает:

  • number - Запрошенный столбец.

SetMergeWithNext(value: boolean)this ​

Устанавливает слияние со следующим.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

MergeWithNext()this ​

Объединяет этот параметр со следующим в одной группе.

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

IsMergedWithNext()boolean ​

Проверяет, объединено ли оно со следующим.

Возвращает:

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

SetTipLocale(locale: LocaleVariant, text: string)this ​

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

  • localeLocaleVariant - Локаль для использования.
  • textstring - Текстовое значение.

Важно

сделайте то же самое, что и SetTip

Возвращает:

  • this - Текущий экземпляр для цепочки.

SetComboBoxLocale(locale: LocaleVariant, values: string[])this ​

Установить переведенные строковые значения для поля со списком

  • localeLocaleVariant - локаль значений
  • valuesstring[] - массив переведенных значений

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

SetNameLocale(locale: LocaleVariant, name: string)this ​

Установить переведенное название опции

  • localeLocaleVariant - локаль имени
  • namestring - переведенное имя

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

SetGeneral(value: boolean)this ​

Установите этот параметр как общий для своей группы. Если этот параметр отключен, все остальные параметры в группе будут отключены.

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

Важно

работает только с опциями переключения, эта опция должна быть первой в группе

Возвращает:

  • this - этот экземпляр, позволяющий создавать цепочки методов

IsGeneral()boolean ​

Проверяет, является ли оно общим.

Важно

См. SetGeneral

Возвращает:

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

SetGeneralForTab(value: boolean)this ​

Устанавливает общие параметры для вкладки.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

IsGeneralForTab()boolean ​

Проверяет, является ли оно общим для вкладки.

Возвращает:

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

SetHidden(value: boolean)this ​

Устанавливает скрытое.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

IsHidden()boolean ​

Проверяет, скрыто ли оно.

Возвращает:

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

SetSlotHiddenByIndex(slot: number, value: boolean)this ​

Устанавливает слот, скрытый индексом.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

IsSlotHiddenByIndex(slot: number)boolean ​

Проверяет, скрыт ли слот по индексу.

  • slotnumber - Слот.

Возвращает:

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

SetSlotHiddenByKey(key: string, value: boolean)this ​

Устанавливает слот, скрытый ключом.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

IsSlotHiddenByKey(key: string)boolean ​

Проверяет, скрыт ли слот ключом.

  • keystring - Ключ.

Возвращает:

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

GetName()string ​

Получает имя.

Возвращает:

  • string - Запрошенное имя.

GetNameTranslated()string ​

Получает переведенное имя.

Возвращает:

  • string - Запрошенное имя переведено.

GetChilds()MenuOption<any>[] ​

Возвращает детей.

Возвращает:

  • MenuOption<any>[] - Массив с совпадающими значениями.

IsKeyDownOnce(checkInputCapture?: boolean)boolean ​

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

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

Возвращает:

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

IsKeyDown(checkInputCapture?: boolean)boolean ​

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

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

Возвращает:

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

GetKeyString()string ​

Получает ключевую строку.

Возвращает:

  • string - Запрошенная строка ключа.

SetImage(imagePath: string)this ​

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

  • imagePathstring - Путь изображения.

Возвращает:

  • this - Текущий экземпляр для цепочки.

SetDisabled(value: boolean)this ​

Устанавливает отключенный.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

IsDisabled()boolean ​

Проверяет, отключена ли она.

Возвращает:

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

SetSlotDisabledByIndex(slot: number, value: boolean)this ​

Устанавливает слот, отключенный по индексу.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

IsSlotDisabledByIndex(slot: number)boolean ​

Проверяет, отключен ли слот по индексу.

  • slotnumber - Слот.

Возвращает:

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

SetSlotDisabledByKey(key: string, value: boolean)this ​

Устанавливает слот, отключенный клавишей.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

IsSlotDisabledByKey(key: string)boolean ​

Проверяет, заблокирован ли слот ключом.

  • keystring - Ключ.

Возвращает:

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

SetNoTitle(value: boolean)this ​

Устанавливает отсутствие заголовка.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

IsNoTitle()boolean ​

Проверяет, нет ли заголовка.

Возвращает:

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

SetToggleBlockTipsTranslated(locale: LocaleVariant, hints: string[])this ​

Устанавливает перевод подсказок блока переключения.

  • localeLocaleVariant - Локаль для использования.
  • hintsstring[] - Подсказки.

Возвращает:

  • this - Текущий экземпляр для цепочки.

SetNotStrictAlign(value: boolean)this ​

Устанавливает не строгое выравнивание.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

SetToggleBlockLocale(locale: LocaleVariant, values: string[])this ​

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

  • localeLocaleVariant - Локаль для использования.
  • valuesstring[] - Значения, которые следует использовать.

Возвращает:

  • this - Текущий экземпляр для цепочки.

SetFolderTitleTranslated(locale: LocaleVariant, title: string)this ​

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

  • localeLocaleVariant - Локаль для использования.
  • titlestring - Название.

Возвращает:

  • this - Текущий экземпляр для цепочки.

SetNotDrawLabelAndHint(value: boolean)this ​

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

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

NotDrawLabelAndHint()this ​

Предоставляет доступ к возможности не рисовать метки и подсказки.

Возвращает:

  • this - Текущий экземпляр для цепочки.

GetNotDrawLabelAndHint()boolean ​

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

Возвращает:

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

SetTabModeForFolder(value: boolean)this ​

Устанавливает режим вкладок для папки.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

GetTabModeForFolder()boolean ​

Получает режим вкладок для папки.

Возвращает:

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

AddAliases(aliases: Array<string>)this ​

Добавляет псевдонимы.

  • aliasesArray<string> - Псевдонимы.

Возвращает:

  • this - Текущий экземпляр для цепочки.

SaveValue()this ​

Обеспечивает доступ к сохранению стоимости.

Возвращает:

  • this - Текущий экземпляр для цепочки.

LoadValue(processCallbacks?: boolean)this ​

Загружает значение.

  • processCallbacksboolean (необязательный) - Процесс callbacks.

Возвращает:

  • this - Текущий экземпляр для цепочки.

GetConfigKey()string ​

Получает ключ config.

Возвращает:

  • string - Запрошенный ключ config.

GetGeneratedConfigKey()string ​

Получает сгенерированный ключ config.

Возвращает:

  • string - Запрошенный сгенерированный ключ config.

SetOverridenConfigKey(key: string)this ​

Устанавливает переопределенный ключ config.

  • keystring - Ключ.

Возвращает:

  • this - Текущий экземпляр для цепочки.

SetOrdering(value: number)this ​

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

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

GetOrdering()number ​

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

Возвращает:

  • number - Запрошенный заказ.

SetKeyDown(value: boolean)this ​

Устанавливает ключ.

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

Возвращает:

  • this - Текущий экземпляр для цепочки.

SetWheelStopReason(stopReason: Enum.WheelStopReason, maxTimePressInS?: number)this ​

Устанавливает причину остановки колеса.

  • stopReasonEnum.WheelStopReason - Причина остановки.
  • maxTimePressInSnumber (необязательный) - Максимальное время нажатия в сек.

Возвращает:

  • this - Текущий экземпляр для цепочки.

RemoveOption()void ​

Удаляет опцию.