Класс: Phaser.Events

Конструктор

new Events(sprite)

Компонент Events представляет собой коллекцию событий, генерируемых родительским объектом игры.

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

Например, чтобы определить, когда Sprite был добавлен в новую группу, вы можете привязать функцию
к сигналу onAddedToGroup:

sprite.events.onAddedToGroup.add(yourFunction, this);

Где yourFunction — это функция, которая должна быть вызвана, когда произойдёт это событие.

Дополнительную информацию о работе сигналов можно найти в классе Phaser.Signal.

События, связанные с вводом, будут отправляться только если у Sprite установлено inputEnabled в значение true,
а события, связанные с анимацией, применяются только к объектам игры с анимациями, например, к Phaser.Sprite.

Параметры

Имя	Тип	Описание
`sprite`	Phaser.Sprite	Ссылка на объект игры/Sprite, которому принадлежит этот объект Events.

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

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

onAddedToGroup : Phaser.Signal

Этот сигнал отправляется, когда этот объект игры добавлен в новую группу.
Он отправляет два аргумента:
{any} Объект игры, который был добавлен в группу.
{Phaser.Group} Группа, в которую он был добавлен.

Исходный код: gameobjects/components/Events.js (Строка 84)

onAnimationComplete : Phaser.Signal

Этот сигнал отправляется, если у объекта игры есть компонент AnimationManager,
и анимация была остановлена (через animation.stop() и аргумент dispatchComplete был установлен.
Вы также можете прослушивать Animation.onComplete вместо событий объектов игры.
Он отправляет два аргумента:
{any} Объект игры, который получил событие.
{Phaser.Animation} Объект Phaser.Animation, который был остановлен.

Исходный код: gameobjects/components/Events.js (Строка 249)

onAnimationLoop : Phaser.Signal

Этот сигнал отправляется, если у объекта игры есть компонент AnimationManager,
и анимация выполнила циклическую воспроизведение.
Вы также можете прослушивать Animation.onLoop вместо событий объектов игры.
Он отправляет два аргумента:
{any} Объект игры, который получил событие.
{Phaser.Animation} Объект Phaser.Animation, который выполнил цикл.

Исходный код: gameobjects/components/Events.js (Строка 260)

onAnimationStart : Phaser.Signal

Этот сигнал отправляется, если у объекта игры есть компонент AnimationManager,
и анимация была воспроизведена.
Вы также можете прослушивать Animation.onStart вместо событий объектов игры.
Он отправляет два аргумента:
{any} Объект игры, который получил событие.
{Phaser.Animation} Объект Phaser.Animation, который был запущен.

Исходный код: gameobjects/components/Events.js (Строка 238)

onDestroy : Phaser.Signal

Этот сигнал отправляется, когда объект игры уничтожается.
Это происходит, когда Sprite.destroy() вызывается или Group.destroy() с destroyChildren установленным в значение true.
Он отправляет один аргумент:
{any} Объект игры, который был уничтожен.

Исходный код: gameobjects/components/Events.js (Строка 109)

onDragStart : Phaser.Signal

Этот сигнал отправляется, если у объекта игры был inputEnabled и enableDrag был установлен.
Отправляется, когда Phaser.Pointer начинает перетаскивать объект игры, учитывая различные ограничения перетаскивания, которые могут быть заданы.
Отправляются четыре аргумента:
{any} Объект игры, который получил событие.
{Phaser.Pointer} Объект Phaser.Pointer, который вызвал событие.
{number} Координата x, с которой началось перетаскивание.
{number} Координата y, с которой началось перетаскивание.

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

onDragStop : Phaser.Signal

Этот сигнал отправляется, если у объекта игры был inputEnabled и enableDrag был установлен.
Отправляется, когда Phaser.Pointer прекращает перетаскивание объекта игры.
Отправляются два аргумента:
{any} Объект игры, который получил событие.
{Phaser.Pointer} Объект Phaser.Pointer, который вызвал событие.

Исходный код: gameobjects/components/Events.js (Строка 227)

onDragUpdate : Phaser.Signal

Этот сигнал отправляется, если у объекта игры был inputEnabled и enableDrag был установлен.
Отправляется, когда Phaser.Pointer активно перетаскивает объект игры.
Внимание: Это сигнал с высокой частотой отправки. Будьте внимательны, что вы привязываете к нему.
Отправляются шесть аргументов:
{any} Объект игры, который получил событие.
{Phaser.Pointer} Объект Phaser.Pointer, который вызвал событие.
{number} Новая координата x объекта игры.
{number} Новая координата y объекта игры.
{Phaser.Point} Объект Point, содержащий точку, к которой был привязан объект игры, если snapOnDrag был включен.
{boolean} fromStart логическое значение, указывает, является ли это первое обновление сразу после начала перетаскивания.

Исходный код: gameobjects/components/Events.js (Строка 217)

onEnterBounds : Phaser.Signal

Этот сигнал отправляется, когда объект игры возвращается в пределы Phaser.World, будучи ранее вне их.
Этот сигнал отправляется только если Sprite.checkWorldBounds установлен на true.
Отправляется один аргумент:
{any} Объект игры, который вошел в пределы World.

Исходный код: gameobjects/components/Events.js (Строка 146)

onInputDown : Phaser.Signal

Этот сигнал отправляется, если у объекта игры inputEnabled установлен на true,
и он получает событие вниз от Phaser.Pointer. Это фактически означает, что Pointer был
нажат (но еще не отпущен) на объекте игры.
Отправляются два аргумента:
{any} Объект игры, который получил событие.
{Phaser.Pointer} Объект Phaser.Pointer, который вызвал событие.

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

onInputOut : Phaser.Signal

Этот сигнал отправляется, если у объекта игры inputEnabled установлен на true,
и он получает событие выхода от Phaser.Pointer, который ранее был над ним.
Отправляются два аргумента:
{any} Объект игры, который получил событие.
{Phaser.Pointer} Объект Phaser.Pointer, который вызвал событие.

Исходный код: gameobjects/components/Events.js (Строка 166)

onInputOver : Phaser.Signal

Этот сигнал отправляется, если у объекта игры inputEnabled установлен на true,
и он получает событие наведения от Phaser.Pointer.
Отправляются два аргумента:
{any} Объект игры, который получил событие.
{Phaser.Pointer} Объект Phaser.Pointer, который вызвал событие.

Исходный код: gameobjects/components/Events.js (Строка 156)

onInputUp : Phaser.Signal

Этот сигнал отправляется, если у объекта игры inputEnabled установлен на true,
и он получает событие отпускания от Phaser.Pointer. Это фактически означает, что Pointer был
нажат, а затем отпущен на объекте игры.
Отправляются три аргумента:
{any} Объект игры, который получил событие.
{Phaser.Pointer} Объект Phaser.Pointer, который вызвал событие.
{boolean} isOver - Показатель, остается ли Pointer над объектом игры?

Исходный код: gameobjects/components/Events.js (Строка 189)

onKilled : Phaser.Signal

Этот метод устарел и не должен использоваться. Он может быть удален в будущем.

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

destroy()

Удаляет все события.

Исходный код: gameobjects/components/Events.js (Строка 43)