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

Input ​

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

Функции ​

GetCursorPos()[number, number] ​

Получает текущие координаты курсора.

Возвращает:

  • [number, number] - Кортеж результата вызова.

SetCursorPos(x: number, y: number)void ​

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

  • xnumber - Координата х.
  • ynumber - Они координируют.

IsCursorInBounds(x0: number, y0: number, x1: number, y1: number)boolean ​

Проверяет, находится ли курсор в указанных границах.

  • x0number - Минимальная координата x.
  • y0number - Минимальная координата y.
  • x1number - Максимальная координата x.
  • y1number - Максимальная координата y.

Возвращает:

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

IsCursorInRect(x: number, y: number, width: number, height: number, align?: Enum.ContentAlign)boolean ​

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

  • xnumber - Координата х.
  • ynumber - Они координируют.
  • widthnumber - Значение ширины.
  • heightnumber - Значение высоты.
  • alignEnum.ContentAlign (необязательный) - Значение выравнивания контента.

Возвращает:

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

IsInputCaptured()boolean ​

Проверяет, захватывается ли input пользовательским интерфейсом.

Возвращает:

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

IsKeyDown(key: Enum.ButtonCode, checkInputCapture?: boolean)boolean ​

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

  • keyEnum.ButtonCode - Ключевая ценность.
  • checkInputCaptureboolean (необязательный) - Следует ли учитывать захват input.

Возвращает:

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

IsKeyDownOnce(key: Enum.ButtonCode, checkInputCapture?: boolean)boolean ​

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

  • keyEnum.ButtonCode - Ключевая ценность.
  • checkInputCaptureboolean (необязательный) - Следует ли учитывать захват input.

Возвращает:

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

GetNearestEntityToCursorFromList<T extends Entity>(teamType: Enum.TeamType, unitList: T[])T | null ​

Извлекает ближайший к курсору объект из предоставленного списка.

  • teamTypeEnum.TeamType - Используемый командный фильтр.
  • unitListT[] - Список объектов для поиска.

Возвращает:

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

GetNearestHeroToCursor(teamType: Enum.TeamType)Hero | null ​

Возвращает ближайшего к курсору героя.

  • teamTypeEnum.TeamType - Используемый командный фильтр.

Возвращает:

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

GetNearestUnitToCursor(teamType: Enum.TeamType)NPC | null ​

Извлекает ближайшую к курсору единицу.

  • teamTypeEnum.TeamType - Используемый командный фильтр.

Возвращает:

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

IsCursorOnMinimap()boolean ​

Проверяет, находится ли курсор над minimap.

Возвращает:

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

GetWorldCursorPos()Vector ​

Получает мировую позицию под курсором.

Возвращает:

  • Vector - Запрошенная позиция мирового курсора.

GetHoveredEntityIndex()number ​

Получает индекс объекта, на котором в данный момент находится курсор.

Возвращает:

  • number - Запрошенный индекс зависающего объекта.

GetHoveredEntity()Entity | null ​

Извлекает объект, на который в данный момент наведен курсор.

Возвращает:

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