Класс: Phaser.InputHandler

Конструктор

new InputHandler(sprite)

Параметры

Исходный код: input/InputHandler.js (Строка 14)

Общедоступные свойства

allowHorizontalDrag : boolean

Управляет возможностью перетаскивания объекта по горизонтали.

Значение по умолчанию

• true

Исходный код: input/InputHandler.js (Строка 69)

allowVerticalDrag : boolean

Управляет возможностью перетаскивания объекта по вертикали.

Значение по умолчанию

• true

Исходный код: input/InputHandler.js (Строка 75)

boundsRect : Phaser.Rectangle

Область игрового мира, в пределах которой объект ограничен во время перетаскивания.

Исходный код: input/InputHandler.js (Строка 161)

boundsSprite : Phaser.Sprite

Объект Sprite, границы которого ограничивают данный объект при перетаскивании.

Исходный код: input/InputHandler.js (Строка 167)

bringToTop : boolean

Если true, при клике или перетаскивании объект автоматически перемещается наверх в группе, к которой он принадлежит.

Исходный код: input/InputHandler.js (Строка 81)

<internal> checked : boolean

Флаг, используемый классом Pointer для выполнения проверок приоритета.

Внутреннее:

• Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.

Исходный код: input/InputHandler.js (Строка 36)

downPoint : Phaser.Point

Объект Point, содержащий координаты указателя в момент нажатия на этот объект.

Исходный код: input/InputHandler.js (Строка 207)

dragDistanceThreshold : integer

Расстояние в пикселях, которое должен преодолеть указатель при нажатии, прежде чем объект будет считаться перетаскиваемым.

Исходный код: input/InputHandler.js (Строка 197)

dragFromCenter : boolean

Перетаскивается ли объект из центра или из точки нажатия указателя?

Исходный код: input/InputHandler.js (Строка 182)

draggable : boolean

Может ли этот объект перетаскиваться мышью? true = да, false = нет

Исходный код: input/InputHandler.js (Строка 155)

dragOffset : Phaser.Point

Смещение от позиции объекта, относительно которой происходит перетаскивание.

Исходный код: input/InputHandler.js (Строка 177)

dragStartPoint : Phaser.Point

Точка, с которой началось последнее перетаскивание. Полезно, если нужно вернуть объект в исходное положение.

Исходный код: input/InputHandler.js (Строка 192)

dragStopBlocksInputUp : boolean

Если включено, при остановке перетаскивания будет отправлено только событие onDragStop, а не событие onInputUp. Если установлено значение false, будут отправлены оба события.

Исходный код: input/InputHandler.js (Строка 187)

dragTimeThreshold : integer

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

Исходный код: input/InputHandler.js (Строка 202)

enabled : boolean

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

Исходный код: input/InputHandler.js (Строка 30)

game : Phaser.Game

Ссылка на текущую игровую сессию.

Исходный код: input/InputHandler.js (Строка 24)

isDragged : boolean

true, если объект в настоящее время перетаскивается.

Исходный код: input/InputHandler.js (Строка 63)

pixelPerfectAlpha : number

Пороговое значение альфа-канала. Если значение альфа-канала пикселя совпадает или превышает это значение, то пиксель считается попаданием.

Значение по умолчанию

• 255

Исходный код: input/InputHandler.js (Строка 149)

pixelPerfectClick : boolean

Установите в значение true, чтобы использовать точную проверку по пикселям для определения нахождения указателя над этим объектом при нажатии или касании.
Координаты x/y указателя проверяются относительно изображения в сочетании со значением InputHandler.pixelPerfectAlpha.
Эта функция работает только для отображаемых объектов с текстурами на основе изображений, таких как Sprite. Она не будет работать с BitmapText или Rope.
Предупреждение: Это дорогостоящая операция, поэтому используйте только в случае необходимости. Используйте точную проверку по пикселям при проверке кликов или касаний по объекту.

Исходный код: input/InputHandler.js (Строка 143)

pixelPerfectOver : boolean

Установите в значение true, чтобы использовать точную проверку по пикселям для определения нахождения указателя над этим объектом.
Координаты x/y указателя проверяются относительно изображения в сочетании со значением InputHandler.pixelPerfectAlpha.
Эта функция работает только для отображаемых объектов с текстурами на основе изображений, таких как Sprite. Она не будет работать с BitmapText или Rope.
Предупреждение: Это дорогостоящая операция, особенно на мобильных устройствах (где она даже не требуется!), поэтому используйте только в случае необходимости. Также см. InputHandler.pixelPerfectClick, который менее ресурсоемкий. Используйте точную проверку по пикселям при проверке нахождения указателя над объектом.

Source code: input/InputHandler.js (Line 133)

priorityID : number

Используется для определения приоритета игровых объектов при возникновении событий ввода. Например, если у вас несколько перекрывающихся спрайтов, по умолчанию приоритет на события ввода получает тот, что находится сверху в списке отображения. Вы можете изменить это, контролируя значение priorityID. Чем выше значение, тем выше приоритет.

Source code: input/InputHandler.js (Line 45)

scaleLayer : boolean

ЭКСПЕРИМЕНТАЛЬНО: Пожалуйста, не используйте этот параметр, если вы не знаете, что он делает. Возможно, в будущем он изменится.

Source code: input/InputHandler.js (Line 172)

snapOffset : Phaser.Point

Объект Point, содержащий смещение при привязке к сетке.

Source code: input/InputHandler.js (Line 87)

snapOffsetX : number

Определяет координату X левого верхнего угла сетки привязки.

Source code: input/InputHandler.js (Line 117)

snapOffsetY : number

Определяет координату Y левого верхнего угла сетки привязки.

Source code: input/InputHandler.js (Line 123)

snapOnDrag : boolean

При перетаскивании спрайта управляет тем, будет ли центр спрайта привязываться к указателю при перетаскивании или нет.

Source code: input/InputHandler.js (Line 93)

snapOnRelease : boolean

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

Source code: input/InputHandler.js (Line 99)

snapPoint : Phaser.Point

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

Source code: input/InputHandler.js (Line 212)

snapX : number

Если для спрайта включена привязка, эта переменная хранит ширину сетки привязки.

Source code: input/InputHandler.js (Line 105)

snapY : number

Если для спрайта включена привязка, эта переменная хранит высоту сетки привязки.

Source code: input/InputHandler.js (Line 111)

sprite : Phaser.Sprite

Объект Sprite, к которому принадлежит этот обработчик ввода.

Source code: input/InputHandler.js (Line 19)

useHandCursor : boolean

В браузере на десктопе вы можете установить курсор 'hand', когда пользователь перемещает указатель над спрайтом.

Source code: input/InputHandler.js (Line 51)

Публичные методы

checkBoundsRect()

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

Исходный код: input/InputHandler.js (Строка 1654)

checkBoundsSprite()

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

Исходный код: input/InputHandler.js (Строка 1704)

checkPixel(x, y, pointer) → {boolean}

Выполняет проверку пиксельной точности по заданным координатам x/y спрайта, к которому привязан данный InputHandler.
Сравнивает значение альфа-канала пикселя и, если оно больше или равно InputHandler.pixelPerfectAlpha, возвращает true.

Параметры

Имя	Тип	Аргумент	Описание
x	число		Координата x для проверки.
y	число		Координата y для проверки.
pointer	Phaser.Pointer	<необязательно>	Объект указателя для получения координат x/y, если они не переданы в качестве первых двух параметров.

Возвращаемое значение

логическое -

true, если значение альфа-канала пикселя больше или равно InputHandler.pixelPerfectAlpha

Исходный код: input/InputHandler.js (Строка 799)

checkPointerDown(pointer, fastTest) → {boolean}

Проверяет, нажат ли указанный указатель и находится ли он над спрайтом, к которому принадлежит этот InputHandler.
Флаг fastTest используется для быстрого проверки только области столкновения, даже если InputHandler.pixelPerfectOver равен true.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
pointer	Phaser.Pointer
fastTest	логическое	<необязательно>	false	Вызвать проверку только области столкновения, даже если pixelPerfectOver имеет значение true для этого объекта?

Возвращаемое значение

логическое -

True, если указатель нажат, иначе false.

Исходный код: input/InputHandler.js (Строка 710)

checkPointerOver(pointer, fastTest) → {boolean}

Проверяет, находится ли указанный указатель над спрайтом, к которому принадлежит этот InputHandler.
Используйте флаг fastTest для быстрого проверки только области столкновения, даже если InputHandler.pixelPerfectOver имеет значение true.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
pointer	Phaser.Pointer
fastTest	логическое	<необязательно>	false	Вызвать проверку только области столкновения, даже если pixelPerfectOver имеет значение true для этого объекта?

Возвращаемое значение

логическое -

Исходный код: input/InputHandler.js (Строка 755)

destroy()

Освобождение памяти.

Исходный код: input/InputHandler.js (Строка 430)

disableDrag()

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

Исходный код: input/InputHandler.js (Строка 1441)

disableSnap()

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

Исходный код: input/InputHandler.js (Строка 1642)

downDuration(pointerId) → {number}

Если указатель в данный момент находится над этим спрайтом, возвращает время, в течение которого он там находился (в миллисекундах).

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
pointerId	целое	<необязательно>	0

Возвращаемое значение

число -

Количество миллисекунд, в течение которого указатель был нажат на спрайте, или -1, если он не находится над ним.

Исходный код: input/InputHandler.js (Строка 1363)

enableDrag(lockCenter, bringToTop, pixelPerfect, alphaThreshold, boundsRect, boundsSprite)

Разрешить перетаскивание этого спрайта любым допустимым указателем.

При начале перетаскивания будет вызван Sprite.events.onDragStart.

При завершении перетаскивания (пользователь отпускает указатель) будет вызван Sprite.events.onDragStop.

Вы можете управлять порогами начала перетаскивания, используя свойства:

Pointer.dragDistanceThreshold расстояние, в пикселях, которое должен пройти указатель,
прежде чем начнется перетаскивание.

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

Вы можете установить любое из этих свойств (или оба) после включения перетаскивания для спрайта.

В течение перетаскивания будет вызываться событие Sprite.events.onDragUpdate. Это событие вызывается только при фактическом
изменении положения указателя и перемещении. Событие отправляет 5 параметров: sprite, pointer, dragX, dragY и snapPoint.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
lockCenter	boolean	<optional>	false	Если false, спрайт будет перетаскиваться из точки клика минус смещение dragOffset. Если true, спрайт будет центрироваться на указателе мыши.
bringToTop	boolean	<optional>	false	Если true, спрайт будет помещен в верхнюю часть списка отрисовки в текущей группе.
pixelPerfect	boolean	<optional>	false	Если true, будет использоваться точное проверка пикселей для определения нажатия на спрайт. Если false, используется ограничивающая рамка.
alphaThreshold	boolean	<optional>	255	Если используется точное проверка пикселей, это значение задает уровень альфа-канала от 0 до 255, выше которого происходит проверка столкновения.
boundsRect	Phaser.Rectangle	<optional>	null	Если нужно ограничить перетаскивание спрайта определённой прямоугольной областью, передайте здесь Phaser.Rectangle, иначе спрайт можно перетаскивать куда угодно.
boundsSprite	Phaser.Sprite	<optional>	null	Если нужно ограничить перетаскивание спрайта рамками другого спрайта, передайте его сюда.

Исходный код: input/InputHandler.js (Строка 1383)

enableSnap(snapX, snapY, onDrag, onRelease, snapOffsetX, snapOffsetY)

Принудительно привязывает спрайт к сетке во время перетаскивания или при отпускании.
Например, snapX и snapY равные 16x16 приведут к привязке спрайта к каждой 16-й пиксельной отметке.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
snapX	number			Ширина ячейки сетки для привязки.
snapY	number			Высота ячейки сетки для привязки.
onDrag	boolean	<optional>	true	Если true, спрайт будет привязываться к сетке во время перетаскивания.
onRelease	boolean	<optional>	false	Если true, спрайт будет привязываться к сетке при отпускании.
snapOffsetX	number	<optional>	0	Смещение начала сетки привязки по горизонтали.
snapOffsetY	number	<optional>	0	Смещение начала сетки привязки по вертикали.

Исходный код: input/InputHandler.js (Строка 1614)

globalToLocalX(x)

Предупреждение: ЭКСПЕРИМЕНТАЛЬНО

Параметры

Имя	Тип	Описание
x	number

Исходный код: input/InputHandler.js (Строка 1524)

globalToLocalY(y)

Предупреждение: ЭКСПЕРИМЕНТАЛЬНО

Параметры

Имя	Тип	Описание
y	number

Исходный код: input/InputHandler.js (Строка 1542)

isPixelPerfect() → {boolean}

Используется ли проверка на точное попадание по пикселям?

Возвращает

boolean -

True, если в InputHandler установлено значение pixelPerfectClick или pixelPerfectOver равно true.

Исходный код: input/InputHandler.js (Строка 495)

justOut(pointerId, delay) → {boolean}

Возвращает true, если указатель покинул спрайт в течение заданного времени задержки (по умолчанию 500мс, полсекунды)

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
pointerId	integer	<optional>	0
delay	number			Время, в течение которого указатель считается вышедшим.

Возвращает

boolean -

Исходный код: input/InputHandler.js (Строка 1292)

justOver(pointerId, delay) → {boolean}

Возвращает true, если указатель вошёл в спрайт в течение заданного времени задержки (по умолчанию 500мс, полсекунды)

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
pointerId	integer	<optional>	0
delay	number			Время, в течение которого указатель считается вошедшим.

Возвращает

boolean -

Исходный код: input/InputHandler.js (Строка 1275)

justPressed(pointerId, delay) → {boolean}

Возвращает true, если указатель коснулся или кликнул по спрайту в течение заданного времени задержки (по умолчанию 500мс, полсекунды)

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
pointerId	integer	<optional>	0
delay	number			Время, в течение которого указатель считается нажатым.

Возвращает

boolean -

Source code: input/InputHandler.js (Line 1309)

justReleased(pointerId, delay) → {boolean}

Возвращает true, если указатель касался этого спрайта, но был отпущен в течение указанного интервала времени (по умолчанию 500 мс, полсекунды)

Parameters

Name	Type	Argument	Default	Description
pointerId	integer	<optional>	0
delay	number			Время, после которого указатель считается вышедшим.

Returns

boolean -

Source code: input/InputHandler.js (Line 1326)

overDuration(pointerId) → {number}

Если указатель в данный момент находится над этим спрайтом, возвращает продолжительность нахождения в миллисекундах.

Parameters

Name	Type	Argument	Default	Description
pointerId	integer	<optional>	0

Returns

number -

Количество миллисекунд, в течение которых указатель находился над спрайтом, или -1, если указатель не находится над ним.

Source code: input/InputHandler.js (Line 1343)

pointerDown(pointerId) → {boolean}

Если указатель нажат, возвращает true.
Это только проверяет, нажат ли указатель, а не то, нажат ли он над каким-либо конкретным спрайтом.

Parameters

Name	Type	Argument	Default	Description
pointerId	integer	<optional>	0

Returns

boolean -

• True, если указанный указатель нажат, иначе false.

Source code: input/InputHandler.js (Line 539)

pointerDragged(pointerId) → {boolean}

Перетаскивается ли этот спрайт мышью или нет?

Parameters

Name	Type	Argument	Default	Description
pointerId	integer	<optional>	0

Returns

boolean -

True, если указатель перетаскивает объект, иначе false.

Source code: input/InputHandler.js (Line 695)

pointerOut(pointerId) → {boolean}

Находится ли указатель вне этого спрайта?

Parameters

Name	Type	Argument	Default	Description
pointerId	integer	<optional>	(все)	Идентификатор указателя для проверки. Если не указан, проверяются все указатели.

Returns

boolean -

True, если указанный указатель (или любой, если не указан) находится вне объекта.

Source code: input/InputHandler.js (Line 634)

pointerOver(pointerId) → {boolean}

Находится ли указатель над этим спрайтом?

Parameters

Name	Type	Argument	Default	Description
pointerId	integer	<optional>	(все)	Идентификатор указателя для проверки. Если не указан, проверяются все указатели.

Returns

boolean -

• True, если указанный указатель (или любой, если не указан) находится над объектом.

Source code: input/InputHandler.js (Line 601)

pointerTimeDown(pointerId) → {number}

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

Parameters

Name	Type	Argument	Default	Description
pointerId	integer	<optional>	(все)

Returns

number -

Source code: input/InputHandler.js (Line 571)

pointerTimeOut(pointerId) → {number}

Отметка времени, когда указатель покинул сенсорный экран.

Parameters

Name	Type	Argument	Default	Description
pointerId	integer	<optional>	0

Returns

number -

Source code: input/InputHandler.js (Line 680)

pointerTimeOver(pointerId) → {number}

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

Parameters

Name	Type	Argument	Default	Description
pointerId	integer	<optional>	0

Returns

number -

Исходный код: input/InputHandler.js (Строка 665)

pointerTimeUp(pointerId) → {число}

Отметка времени, когда указатель покинул сенсорный экран.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
pointerId	целое число	<необязательно>	0

Возвращает

число -

Исходный код: input/InputHandler.js (Строка 586)

pointerUp(pointerId) → {логическое}

Возвращает true, если указатель опущен.
Эта функция только проверяет, опущен ли указатель, а не находится ли он над конкретным спрайтом.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
pointerId	целое число	<необязательно>	0

Возвращает

логическое -

• true, если указанный указатель опущен, иначе false.

Исходный код: input/InputHandler.js (Строка 555)

pointerX(pointerId) → {число}

Координата x указателя Input, относительно левого верхнего угла родительского спрайта.
Это значение устанавливается только при наведении указателя на этот спрайт.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
pointerId	целое число	<необязательно>	0

Возвращает

число -

Координата x указателя Input.

Исходный код: input/InputHandler.js (Строка 507)

pointerY(pointerId) → {число}

Координата y указателя Input, относительно левого верхнего угла родительского спрайта.
Это значение устанавливается только при наведении указателя на этот спрайт.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
pointerId	целое число	<необязательно>	0

Возвращает

число -

Координата y указателя Input.

Исходный код: input/InputHandler.js (Строка 523)

reset()

Сбрасывает обработчик Input и отключает его.

Исходный код: input/InputHandler.js (Строка 382)

setDragLock(allowHorizontal, allowVertical)

Ограничивает перемещение этого спрайта при перетаскивании только по заданной оси. Примечание: если оба значения установлены в false, спрайт не будет перемещаться!

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
allowHorizontal	логическое	<необязательно>	true	Чтобы разрешить перетаскивание спрайта по горизонтали, установите значение true, иначе false.
allowVertical	логическое	<необязательно>	true	Чтобы разрешить перетаскивание спрайта по вертикали, установите значение true, иначе false.

Исходный код: input/InputHandler.js (Строка 1597)

start(priority, useHandCursor) → {Phaser.Sprite}

Запускает обработчик Input. Это происходит автоматически, когда вы включаете ввод на спрайт, или может быть вызвано напрямую, если вам нужно установить определённый приоритет.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
priority	число	<необязательно>	0	Спрайты с более высоким приоритетом получают приоритет клика по сравнению со спрайтами с низким приоритетом, когда они расположены друг над другом.
useHandCursor	логическое	<необязательно>	false	Если true, спрайт покажет указатель «рука» при наведении (не применяется к мобильным браузерам)

Возвращает

Phaser.Sprite -

Объект спрайта, к которому привязан обработчик Input.

Исходный код: input/InputHandler.js (Строка 284)

startDrag(pointer)

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

Параметры

Имя	Тип	Описание
pointer	Phaser.Pointer

Исходный код: input/InputHandler.js (Строка 1464)

stop()

Останавливает работу обработчика Input.

Исходный код: input/InputHandler.js (Строка 410)

stopDrag(pointer)

Вызывается указателем, когда перетаскивание завершается на этом спрайте. Обычно не следует вызывать напрямую.

Параметры

Имя	Тип	Описание
pointer	Phaser.Pointer

Исходный код: input/InputHandler.js (Строка 1560)

<внутренняя> update(pointer) → {логическое}

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

Параметры

Имя	Тип	Описание
pointer	Phaser.Pointer

Возвращает

boolean -

Истинно, если указатель всё ещё активен, иначе ложно.

Внутреннее:

• Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.

Исходный код: input/InputHandler.js (Строка 868)

<internal> validForInput(highestID, highestRenderID, includePixelPerfect) → {boolean}

Проверяет, является ли объект, к которому привязан этот обработчик ввода, допустимым для рассмотрения в событии перемещения указателя.
Вызывается Phaser.Pointer и обычно не должен вызываться напрямую.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
highestID	number			Наибольший ID, обрабатываемый в данный момент указателем.
highestRenderID	number			Наибольший ID порядка отрисовки, обрабатываемый в данный момент указателем.
includePixelPerfect	boolean	<optional>	true	Если для этого объекта установлены pixelPerfectClick или pixelPerfectOver, должен ли он считаться допустимым?

Возвращает

boolean -

Истинно, если объект, к которому привязан этот обработчик ввода, должен считаться допустимым для обнаружения ввода.

Внутреннее:

• Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.

Исходный код: input/InputHandler.js (Строка 456)