Класс: Phaser.Pointer

Конструктор

new Pointer(game, id, pointerMode)

Параметры

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

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

[static] BACK_BUTTON : number

Кнопка X1. Обычно это кнопка «Назад» мыши, но часто перенастраивается.
В Linux (GTK) это не поддерживается. В Windows, если установлено расширенное программное обеспечение для указателя (например, IntelliPoint), это не регистрируется.

Source code: input/Pointer.js (Line 397)

[static] ERASER_BUTTON : number

Кнопка ластика на устройствах, поддерживающих PointerEvent.

Source code: input/Pointer.js (Line 412)

[static] FORWARD_BUTTON : number

Кнопка X2. Обычно это кнопка «Вперед» мыши, но часто перенастраивается.
В Linux (GTK) это не поддерживается. В Windows, если установлено расширенное программное обеспечение для указателя (например, IntelliPoint), это не регистрируется.

Source code: input/Pointer.js (Line 405)

[static] LEFT_BUTTON : number

Левая кнопка мыши или на устройствах PointerEvent — контакт касания или контакт пера.

Source code: input/Pointer.js (Line 375)

[static] MIDDLE_BUTTON : number

Средняя кнопка мыши.

Source code: input/Pointer.js (Line 389)

[static] NO_BUTTON : number

Никаких кнопок.

Source code: input/Pointer.js (Line 368)

[static] RIGHT_BUTTON : number

Правая кнопка мыши или на устройствах PointerEvent — контакт пера с боковой кнопкой.

Source code: input/Pointer.js (Line 382)

active : boolean

Активный указатель — это указатель, который в данный момент нажат на экране. Мышь всегда активна.

Source code: input/Pointer.js (Line 316)

backButton : Phaser.DeviceButton

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

Объект DeviceButton имеет свои собственные свойства, такие как isDown, duration и методы, такие как justReleased для более тонкой
управления кнопками.

См. документацию DeviceButton для получения подробной информации об ограничениях кнопок браузера.

Source code: input/Pointer.js (Line 120)

button :any

Свойство button последнего события DOM, когда этот указатель запущен.
Не следует полагаться на это значение для точного обнаружения кнопки, вместо этого используйте свойства указателя
leftButton, rightButton, middleButton и так далее.

Source code: input/Pointer.js (Line 70)

circle : Phaser.Circle

Объект Phaser.Circle, центрированный по координатам x/y этого указателя, полезный для обнаружения попаданий.
Размер круга составляет 44 пикселя (рекомендуемый размер «кончика пальца» от Apple).

Source code: input/Pointer.js (Line 344)

clientX : number

Горизонтальная координата указателя в клиентской области приложения, в которой произошло событие (в отличие от координат на странице).

Source code: input/Pointer.js (Line 181)

clientY : number

Вертикальная координата указателя в клиентской области приложения, в которой произошло событие (в отличие от координат на странице).

Source code: input/Pointer.js (Line 186)

dirty : boolean

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

Source code: input/Pointer.js (Line 322)

[readonly] duration : number

Как долго указатель был нажат на сенсорном экране или удерживались нажатыми любые из кнопок мыши.
Если в данный момент не нажат, возвращает -1.
Если вам нужно проверить определенную кнопку мыши или пера, обратитесь к кнопкам напрямую, например, Pointer.rightButton.duration.

Source code: input/Pointer.js (Line 1192)

eraserButton : Phaser.DeviceButton

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

Объект DeviceButton имеет свои собственные свойства, такие как isDown, duration и методы, такие как justReleased для более тонкой
управления кнопками.

См. документацию DeviceButton для получения подробной информации об ограничениях кнопок браузера.

Source code: input/Pointer.js (Line 146)

exists : boolean

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

Default Value

• true

Source code: input/Pointer.js (Line 38)

forwardButton : Phaser.DeviceButton

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

Объект DeviceButton имеет свои собственные свойства, такие как isDown, duration и методы, такие как justReleased для более тонкой
управления кнопками.

См. документацию DeviceButton для получения подробной информации об ограничениях кнопок браузера.

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

game : Phaser.Game

Ссылка на запущенную игру.

Source code: input/Pointer.js (Line 21)

id : number

Идентификатор объекта указателя в игре. Каждая игра может иметь до 10 активных указателей.

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

identifier : число

Свойство идентификатора Pointer, установленное событием DOM при запуске этого Pointer.

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

interactiveCandidates : массив

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

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

• []

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

isDown : логическое

Если Pointer касается сенсорного экрана или любая кнопка мыши или пера нажата, isDown устанавливается в true.
Если вам нужно проверить конкретную кнопку мыши или пера, используйте свойства кнопки, например, Pointer.rightButton.isDown.

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

isMouse : логическое

Если Pointer является мышью или пером/стилусом, это значение true, в противном случае false.

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

isUp : логическое

Если Pointer не касается сенсорного экрана или все кнопки мыши или пера отпущены, isUp устанавливается в true.
Если вам нужно проверить конкретную кнопку мыши или пера, используйте свойства кнопки, например, Pointer.rightButton.isUp.

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

• true

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

leftButton : Phaser.DeviceButton

Если этот Pointer является мышью или пером/стилусом, к его левой кнопке можно получить доступ напрямую через это свойство.

DeviceButton имеет свои собственные свойства, такие как isDown, duration, и методы, такие как justReleased, для более точного
управления кнопкой.

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

middleButton : Phaser.DeviceButton

Если этот Pointer является мышью или пером/стилусом, к его средней кнопке можно получить доступ напрямую через это свойство.

DeviceButton имеет свои собственные свойства, такие как isDown, duration, и методы, такие как justReleased, для более точного
управления кнопкой.

Для получения подробной информации о ограничениях кнопок браузера см. документацию DeviceButton.

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

movementX : число

Горизонтальное обработанное относительное перемещение Pointer в пикселях с момента последнего события.

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

movementY : число

Вертикальное обработанное относительное перемещение Pointer в пикселях с момента последнего события.

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

msSinceLastClick : число

Количество миллисекунд, прошедших с момента последнего щелчка или касания.

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

pageX : число

Горизонтальная координата Pointer относительно всего документа.

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

pageY : число

Вертикальная координата Pointer относительно всего документа.

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

pointerId : число

Свойство pointerId Pointer, заданное событием DOM при запуске этого Pointer. Браузер может и будет переиспользовать это значение.

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

pointerMode : Phaser.PointerMode

Режим работы этого указателя.

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

position : Phaser.Point

Объект Phaser.Point, содержащий текущие значения x/y указателя на экране.

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

positionDown : Phaser.Point

Объект Phaser.Point, содержащий значения x/y указателя, когда он в последний раз был в состоянии нажатия на экране.

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

positionUp : Phaser.Point

Объект Phaser.Point, содержащий значения x/y указателя, когда он был последним отпущен.

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

previousTapTime : число

Отметка времени, представляющая момент, когда Pointer был последний нажат или щелкнут.

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

rawMovementX : число

Необработанное горизонтальное относительное перемещение Pointer в пикселях с момента последнего события.

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

rawMovementY : число

Необработанное вертикальное относительное перемещение Pointer в пикселях с момента последнего события.

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

rightButton : Phaser.DeviceButton

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

У DeviceButton есть свои свойства, такие как isDown, duration и методы, такие как justReleased, для более точного управления кнопкой.

Подробную информацию о ограничениях браузера для кнопки см. в документации DeviceButton.

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

screenX : number

Горизонтальная координата указателя относительно экрана.

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

screenY : number

Вертикальная координата указателя относительно экрана.

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

target :any

Свойство target указателя, заданное событием DOM при запуске этого указателя.

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

targetObject :any

Объект Game, над / в котором / с которым в данный момент находится указатель.

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

timeDown : number

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

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

timeUp : number

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

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

totalTouches : number

Общее количество касаний указателем сенсорного экрана.

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

[только для чтения] type : number

Постоянный тип этого объекта.

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

withinGame : boolean

true, если указатель находится над игровым холстом, иначе false.

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

[только для чтения] worldX : number

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

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

[только для чтения] worldY : number

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

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

x : number

Горизонтальная координата указателя. Это значение автоматически масштабируется в соответствии с масштабом игры.

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

y : number

Вертикальная координата указателя. Это значение автоматически масштабируется в соответствии с масштабом игры.

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

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

<internal> addClickTrampoline(name, callback, callbackContext, callbackArgs)

Добавить трамплин клика к этому указателю.

Траплин клика — это обратный вызов, который выполняется при событии 'click' в DOM; это в первую очередь
необходимо с определёнными браузерами (например, IE11), которые ограничивают некоторые действия, такие как requestFullscreen,
событию 'click' в DOM и отклоняют его для событий 'pointer*' и 'mouse*'.

Это используется внутри ScaleManager; использование трамплинов клика встречается нечасто.
Трамплины клика можно добавлять только к указателям, которые в настоящее время нажаты.

Параметры

Имя	Тип	Описание
name	string	Имя трамплина; должно быть уникальным среди активных трамплинов в этом указателе.
callback	function	Обратный вызов для выполнения/трамплина.
callbackContext	object	Контекст обратного вызова.
callbackArgs	Array.<object> | null	Дополнительные аргументы обратного вызова, если есть. Передаются в виде массива.

Внутренний:

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

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

justPressed(duration) → {boolean}

Указатель считается только что нажатым, если время его нажатия на сенсорный экран или щелчка меньше, чем justPressedRate.
Обратите внимание, что вызов justPressed не сбрасывает состояние нажатия указателя, он будет возвращать true до тех пор, пока период времени действителен.
Если вы хотите проверить, был ли указатель нажат только один раз, см. событие Sprite.events.onInputDown.

Параметры

Имя	Тип	Аргумент	Описание
duration	number	<optional>	Время для проверки. Если не указано, будет использоваться InputManager.justPressedRate.

Возвращает

boolean -

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

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

justReleased(duration) → {boolean}

Указатель считается только что отпущенным, если время его отпускания с сенсорного экрана меньше, чем justReleasedRate.
Обратите внимание, что вызов justReleased не сбрасывает состояние нажатия указателя, он будет возвращать true до тех пор, пока период времени действителен.
Если вы хотите проверить, был ли указатель отпущен только один раз, см. событие Sprite.events.onInputUp.

Параметры

Имя	Тип	Аргумент	Описание
duration	number	<optional>	Время для проверки. Если не указано, будет использоваться InputManager.justReleasedRate.

Возвращает

boolean -

true, если указатель был отпущен в течение указанного периода времени.

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

leave(event)

Вызывается, когда указатель покидает целевую область.

Параметры

Имя	Тип	Описание
event	MouseEvent | PointerEvent | TouchEvent	Событие, переданное обработчиком ввода.

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

move(event, fromClick)

Вызывается, когда указатель перемещается.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
event	MouseEvent | PointerEvent | TouchEvent			Событие, переданное обработчиком ввода.
fromClick	boolean	<optional>	false	Было ли это вызвана из события клика?

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

<internal> processInteractiveObjects(fromClick) → {boolean}

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
fromClick	boolean	<optional>	false	Было ли это вызвана из события клика?

Возвращает

boolean -

True, если этот метод обрабатывает объект (например, Sprite становится текущим объектом указателя), иначе false.

Внутренний:

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

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

reset()

Сбрасывает свойства указателя. Вызывается InputManager.reset при изменении состояния.

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

<internal> resetButtons()

Сбрасывает состояния всех булевых значений кнопок.

Внутренний:

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

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

resetMovement()

Сбрасывает свойства movementX и movementY. Используйте в обработчике обновления после получения значений.

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

start(event)

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

Параметры

Имя	Тип	Описание
event	any	Событие DOM из браузера.

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

stop(event)

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

Параметры

Имя	Тип	Описание
event	MouseEvent | PointerEvent | TouchEvent	Событие, переданное обработчиком ввода.

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

swapTarget(newTarget, silent)

Это изменит объект Pointer.targetObject на предоставленный.

Это позволяет точно управлять объектом, на который нацелен указатель.

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
newTarget	Phaser.InputHandler			Новая цель для этого указателя. Обратите внимание, что это InputHandler, поэтому не передавайте Sprite, а передайте sprite.input.
silent	boolean	<необязательно>	false	Если true, новый целевой объект и старый не будут отправлять события onInputOver или onInputOut.

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

update()

Вызывается менеджером ввода.

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

<внутренний> updateButtons(event)

Вызывается, когда свойство event.buttons изменяется с нуля.
Содержит битовую маску кнопок.

Параметры

Имя	Тип	Описание
event	MouseEvent	Событие DOM.

Внутреннее:

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

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