Класс: Phaser.Mouse

Конструктор

new Mouse(game)

Параметры

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

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

[static] BACK_BUTTON : number

Source code: input/Mouse.js (Line 190)

[static] FORWARD_BUTTON : number

Source code: input/Mouse.js (Line 196)

[static] LEFT_BUTTON : number

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

[static] MIDDLE_BUTTON : number

Source code: input/Mouse.js (Line 178)

[static] NO_BUTTON : number

Source code: input/Mouse.js (Line 166)

[static] RIGHT_BUTTON : number

Source code: input/Mouse.js (Line 184)

[static] WHEEL_DOWN : number

Source code: input/Mouse.js (Line 208)

[static] WHEEL_UP : number

Source code: input/Mouse.js (Line 202)

button : number

Это свойство было удалено в Phaser 2.4 и больше не должно использоваться.
Вместо этого, пожалуйста, обратитесь к свойствам кнопки указателя, таким как Pointer.leftButton, Pointer.rightButton и так далее.
Или Pointer.button хранит значение кнопки DOM-события, если вам это нужно.

Source code: input/Mouse.js (Line 76)

callbackContext : Object

Контекст, в котором вызываются обратные вызовы.

Source code: input/Mouse.js (Line 37)

capture : boolean

Если true, DOM-события мыши будут иметь event.preventDefault, если false — они будут полностью распространяться.

Source code: input/Mouse.js (Line 67)

enabled : boolean

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

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

• true

Source code: input/Mouse.js (Line 89)

event :MouseEvent | null

DOM-событие браузера мыши. Будет null, если событие мыши никогда не было получено.
Обращайтесь к этому свойству только внутри обработчика событий мыши и не сохраняйте ссылки на него.

Тип

• MouseEvent | null

Source code: input/Mouse.js (Line 115)

game : Phaser.Game

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

Source code: input/Mouse.js (Line 26)

<internal> input : Phaser.Input

Ссылка на менеджер ввода Phaser.

Внутреннее:

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

Source code: input/Mouse.js (Line 32)

locked : boolean

Если мышь была успешно заблокирована, это будет установлено в true.

Source code: input/Mouse.js (Line 95)

mouseDownCallback : Function

Обратный вызов, который может быть вызван при нажатии кнопки мыши.

Source code: input/Mouse.js (Line 42)

mouseOutCallback : Function

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

Source code: input/Mouse.js (Line 52)

mouseOverCallback : Function

Обратный вызов, который может быть вызван, когда курсор мыши входит на холст игры (обычно после выхода).

Source code: input/Mouse.js (Line 57)

mouseUpCallback : Function

Обратный вызов, который может быть вызван, когда кнопка мыши отпущена.

Source code: input/Mouse.js (Line 47)

mouseWheelCallback : Function

Обратный вызов, который может быть вызван при использовании колесика мыши.

Source code: input/Mouse.js (Line 62)

pointerLock : Phaser.Signal

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

Source code: input/Mouse.js (Line 107)

stopOnGameOut : boolean

Если true, Pointer.stop будет вызван, если мышь покинет холст игры.

Source code: input/Mouse.js (Line 101)

wheelDelta : number

Направление последнего использования колесика мыши 1 для вверх, -1 для вниз.

Source code: input/Mouse.js (Line 82)

Методы публичного доступа

onMouseDown(event)

Внутренний метод, обрабатывающий событие нажатия мыши в браузере.

Параметры

Имя	Тип	Описание
event	MouseEvent	Родное событие из браузера. Оно хранится в Mouse.event.

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

onMouseMove(event)

Внутренний метод, обрабатывающий событие перемещения мыши в браузере.

Параметры

Имя	Тип	Описание
event	MouseEvent	Родное событие из браузера. Оно хранится в Mouse.event.

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

onMouseOut(event)

Внутренний метод, обрабатывающий событие выхода мыши из области в браузере.

Параметры

Имя	Тип	Описание
event	MouseEvent	Родное событие из браузера. Оно хранится в Mouse.event.

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

onMouseOutGlobal(event)

Внутренний метод, обрабатывающий событие выхода мыши за пределы окна браузера.

Параметры

Имя	Тип	Описание
event	MouseEvent	Родное событие из браузера. Оно хранится в Mouse.event.

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

onMouseOver(event)

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

Параметры

Имя	Тип	Описание
event	MouseEvent	Родное событие из браузера. Оно хранится в Mouse.event.

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

onMouseUp(event)

Внутренний метод, обрабатывающий событие отпускания кнопки мыши в браузере.

Параметры

Имя	Тип	Описание
event	MouseEvent	Родное событие из браузера. Оно хранится в Mouse.event.

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

onMouseUpGlobal(event)

Внутренний метод, обрабатывающий событие отпускания кнопки мыши в окне браузера.

Параметры

Имя	Тип	Описание
event	MouseEvent	Родное событие из браузера. Оно хранится в Mouse.event.

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

onMouseWheel(event)

Внутренний метод, обрабатывающий событие прокрутки мыши в браузере.

Параметры

Имя	Тип	Описание
event	MouseEvent	Родное событие из браузера.

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

pointerLockChange(event)

Внутренний обработчик pointerLockChange.

Параметры

Имя	Тип	Описание
event	Event	Родное событие из браузера. Оно хранится в Mouse.event.

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

releasePointerLock()

Внутренний обработчик освобождения блокировки курсора.

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

requestPointerLock()

Если браузер поддерживает, можно запросить блокировку курсора в окне браузера.
Это классический способ реализации «контроля FPS», где курсор не может выйти за пределы окна до нажатия пользователем клавиши выхода.
Если браузер успешно перешёл в заблокированное состояние, будет отправлено событие Phaser.Mouse.pointerLock, и первым параметром будет «true».

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

start()

Запускает прослушивание событий.

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

stop()

Останавливает прослушивание событий.

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