Класс: Phaser.Particles.Arcade.Emitter

Конструктор

new Emitter(game, x, y, maxParticles)

Параметры

Исходный код: particles/arcade/Emitter.js (Строка 20)

Расширяет

• Phaser.Group

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

alive : boolean

Свойство alive полезно для групп, являющихся дочерними элементами других групп, и требующих включения/исключения в проверки, такие как forEachAlive.

Унаследовано от

• Phaser.Group#alive

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

• true

Исходный код: core/Group.js (Строка 93)

alpha : number

Значение альфа-канала контейнера группы.

Унаследовано от

• Phaser.Group#alpha

Исходный код: core/Group.js (Строка 3003)

alphaData :array

Массив рассчитанных данных плавного изменения альфа-канала, применяемых к частицам с alphaRates > 0.

Исходный код: particles/arcade/Emitter.js (Строка 109)

angle : number

Угол поворота контейнера группы в градусах.

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

Это не влияет на свойства вращения/угла потомков, но обновит их worldTransform
и ориентацию/позицию на экране.

Унаследовано от

• Phaser.Group#angle

Исходный код: core/Group.js (Строка 2682)

angularDrag : number

Компонент углового сопротивления частиц, запущенных из эмиттера, если они вращаются.

Исходный код: particles/arcade/Emitter.js (Строка 132)

area : Phaser.Rectangle

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

Исходный код: particles/arcade/Emitter.js (Строка 51)

autoAlpha : boolean

При создании новой частицы это свойство определяет, будет ли автоматически изменён её альфа-канал. Используйте Emitter.setAlpha для настройки.

Исходный код: particles/arcade/Emitter.js (Строка 193)

autoScale : boolean

При создании новой частицы это свойство определяет, будет ли автоматически изменён её масштаб. Используйте Emitter.setScale для настройки.

Исходный код: particles/arcade/Emitter.js (Строка 188)

blendMode : number

Режим смешивания, установленный для частицы при выходе из эмиттера. По умолчанию NORMAL. Требуется поддержка режимов смешивания canvas в браузере (большинство не поддерживаются в WebGL).

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

[readonly] bottom : number

Получает нижнюю позицию эмиттера.

Исходный код: particles/arcade/Emitter.js (Строка 990)

bounce : Phaser.Point

Величина отражения частицы по каждой оси. 1 = полное отражение, 0 = отсутствие отражения.

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

cameraOffset : Phaser.Point

Если этот объект fixedToCamera, то здесь хранится смещение x/y относительно верхнего левого угла камеры.
Если родитель этой группы также fixedToCamera, то смещение здесь дополнительно к этому и обычно должно быть отключено.

Унаследовано от

• Phaser.Group#cameraOffset

Исходный код: core/Group.js (Строка 272)

centerX : number

Координата центра x этой группы.

Она вычисляется путём вызова getBounds, вычисления размеров группы на основе видимых потомков.

Унаследовано от

• Phaser.Group#centerX

Исходный код: core/Group.js (Строка 2705)

centerY : number

Координата центра y этой группы.

Она вычисляется путём вызова getBounds, вычисления размеров группы на основе видимых потомков.

Унаследовано от

• Phaser.Group#centerY

Исходный код: core/Group.js (Строка 2733)

[readonly] children : Array.<DisplayObject>

[только для чтения] Массив потомков этого контейнера.

Тип

• Array.<DisplayObject>

Унаследовано от

• PIXI.DisplayObjectContainer#children

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 17)

classType : Object

Тип объектов, которые будут созданы при использовании create или createMultiple.

Можно использовать любой объект, но он должен быть расширением Sprite или Image и принимать те же аргументы конструктора:
при создании нового объекта ему передаются следующие параметры в его конструктор: (game, x, y, key, frame).

Унаследовано от

• Phaser.Group#classType

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

• Phaser.Sprite

Исходный код: core/Group.js (Строка 130)

cursor : DisplayObject

Текущий объект отображения, на который указывает курсор группы, если таковой есть. (Может быть установлен вручную.)

Курсор — способ перебора потомков в группе с помощью next и previous.

Унаследовано от

• Phaser.Group#cursor

Исходный код: core/Group.js (Строка 138)

[readonly] cursorIndex : integer

Текущий индекс курсора группы. Увеличивайте его с помощью Group.next.

Inherited From

• Phaser.Group#cursorIndex

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

emitX : number

Точка, из которой испускаются частицы.
Emitter.x и Emitter.y управляют расположением контейнера, что обновляет все текущие частицы
Emitter.emitX и Emitter.emitY управляют местоположением испускания относительно позиции x/y.

Исходный код: particles/arcade/Emitter.js (Строка 175)

emitY : number

Точка, из которой испускаются частицы.
Emitter.x и Emitter.y управляют расположением контейнера, что обновляет все текущие частицы
Emitter.emitX и Emitter.emitY управляют местоположением испускания относительно позиции x/y.

Исходный код: particles/arcade/Emitter.js (Строка 183)

enableBody : boolean

Если true, у всех Sprites, созданных или добавленных в эту группу, будет включён физический объект.

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

Тип тела по умолчанию управляется свойством physicsBodyType.

Inherited From

• Phaser.Group#enableBody

Исходный код: core/Group.js (Строка 208)

enableBodyDebug : boolean

Если true, при создании физического тела (через enableBody) также будет создан объект отладки физики.

Работает только для тел P2.

Inherited From

• Phaser.Group#enableBodyDebug

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

exists : boolean

Если exists имеет значение true, группа обновляется, в противном случае она пропускается.

Inherited From

• Phaser.Group#exists

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

• true

Исходный код: core/Group.js (Строка 100)

fixedToCamera : boolean

Группа, привязанная к камере, использует свои координаты x/y как смещения от левого верхнего угла камеры. Они хранятся в Group.cameraOffset.

Обратите внимание, что значения cameraOffset добавляются к любому родителю в списке отображения.
Поэтому, если эта группа находится в группе с x: 200, это будет добавлено к cameraOffset.x

Inherited From

• Phaser.Group#fixedToCamera

Исходный код: core/Group.js (Строка 265)

frequency : number

Частота испускания частиц в мс (если эмиттер запущен с Explode === false).

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

• 100

Исходный код: particles/arcade/Emitter.js (Строка 138)

<internal> game : Phaser.Game

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

Inherited From

• Phaser.Group#game

Внутреннее:

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

Исходный код: core/Group.js (Строка 38)

gravity : number

Устанавливает body.gravity.y каждого спрайта частицы на это значение при запуске.

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

• 100

Исходный код: particles/arcade/Emitter.js (Строка 115)

hash :array

Массив hash принадлежит этой группе, в которую можно добавить любых её дочерних элементов через Group.addToHash и Group.removeFromHash.

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

Этот массив автоматически используется Phaser Arcade Physics для выполнения сортировки без учёта z-индекса.
Однако, если вы не используете Arcade Physics или это не группа с физикой, то можете использовать массив для выполнения собственной
сортировки и фильтрации дочерних элементов группы без изменения их z-индекса (и, следовательно, порядка отрисовки)

Inherited From

• Phaser.Group#hash

Исходный код: core/Group.js (Строка 285)

height : number

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

Исходный код: particles/arcade/Emitter.js (Строка 903)

ignoreChildInput : boolean

Если ignoreChildInput равно false, это позволит рассматривать дочерние объекты как действительные для событий Input.

Если это свойство равно true, то дочерние объекты не будут рассматриваться как действительные для событий Input.

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

Inherited From

• PIXI.DisplayObjectContainer#ignoreChildInput

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

ignoreDestroy : boolean

Группа с ignoreDestroy, установленным в true, игнорирует все вызовы метода destroy.

Inherited From

• Phaser.Group#ignoreDestroy

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

inputEnableChildren : boolean

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

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

Inherited From

• Phaser.Group#inputEnableChildren

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

[readonly] left : number

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

Исходный код: particles/arcade/Emitter.js (Строка 951)

[readonly] length : целое число

Общее количество дочерних элементов в этой группе, независимо от состояния существования/жизни.

Унаследовано от

• Phaser.Group#length

Исходный код: core/Group.js (Строка 2665)

lifespan : число

Время жизни каждой частицы после её выброса в мс. По умолчанию 2 секунды. Установите lifespan в 'ноль' для вечной жизни частиц.

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

• 2000

Исходный код: particles/arcade/Emitter.js (Строка 144)

maxParticleAlpha : число

Максимальное возможное значение альфа частицы.

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

• 1

Исходный код: particles/arcade/Emitter.js (Строка 104)

maxParticles : число

Общее количество частиц в этом эмиттере.

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

maxParticleScale : число

Максимальное возможное масштабирование частицы. Применяется к осям X и Y. Если нужно управлять каждой осью, используйте maxParticleScaleX.

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

• 1

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

maxParticleSpeed : Phaser.Point

Максимальная возможная скорость частицы.

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

maxRotation : число

Максимальное возможное угловое ускорение частицы.

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

• 360

Исходный код: particles/arcade/Emitter.js (Строка 92)

minParticleAlpha : число

Минимальное возможное значение альфа частицы.

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

• 1

Исходный код: particles/arcade/Emitter.js (Строка 98)

minParticleScale : число

Минимальное возможное масштабирование частицы. Применяется к осям X и Y. Если нужно управлять каждой осью, используйте minParticleScaleX.

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

• 1

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

minParticleSpeed : Phaser.Point

Минимальная возможная скорость частицы.

Исходный код: particles/arcade/Emitter.js (Строка 57)

minRotation : число

Минимальное возможное угловое ускорение частицы.

Исходный код: particles/arcade/Emitter.js (Строка 86)

name : строка

Удобное строковое имя для этого эмиттера. Может быть любым.

Исходный код: particles/arcade/Emitter.js (Строка 33)

on : логическое значение

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

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

onChildInputDown : Phaser.Signal

Этот Сигнал отправляется всякий раз, когда дочерний элемент этой Группы отправляет onInputDown сигнал в результате
взаимодействия с указателем. Вы можете связать функции с этим Сигналом вместо того,
чтобы связывать их с каждым дочерним спрайтом.

Этот Сигнал отправляет 2 аргумента: Ссылку на Спрайт, который вызвал сигнал, и
ссылку на Указатель, который его вызвал.

Унаследовано от

• Phaser.Group#onChildInputDown

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

onChildInputOut : Phaser.Signal

Этот Сигнал отправляется всякий раз, когда дочерний элемент этой Группы отправляет onInputOut сигнал в результате
взаимодействия с указателем. Вы можете связать функции с этим Сигналом вместо того,
чтобы связывать их с каждым дочерним спрайтом.

Этот Сигнал отправляет 2 аргумента: Ссылку на Спрайт, который вызвал сигнал, и
ссылку на Указатель, который его вызвал.

Унаследовано от

• Phaser.Group#onChildInputOut

Исходный код: core/Group.js (Строка 198)

onChildInputOver : Phaser.Signal

Этот Сигнал отправляется всякий раз, когда дочерний элемент этой Группы отправляет onInputOver сигнал в результате
взаимодействия с указателем. Вы можете связать функции с этим Сигналом вместо того,
чтобы связывать их с каждым дочерним спрайтом.

Этот Сигнал отправляет 2 аргумента: Ссылку на Спрайт, который вызвал сигнал, и
ссылку на Указатель, который его вызвал.

Унаследовано от

• Phaser.Group#onChildInputOver

Исходный код: core/Group.js (Строка 186)

onChildInputUp : Phaser.Signal

Этот Сигнал отправляется всякий раз, когда дочерний элемент этой Группы отправляет onInputUp сигнал в результате
взаимодействия с указателем. Вы можете связать функции с этим Сигналом вместо того,
чтобы связывать их с каждым дочерним спрайтом.

Этот Сигнал отправляет 3 аргумента: Ссылку на Спрайт, который вызвал сигнал,
ссылку на Указатель, который его вызвал, и логическое значение isOver, которое указывает,
находится ли Указатель ещё над спрайтом или нет.

Унаследованно от

• Phaser.Group#onChildInputUp

Исходный код: core/Group.js (Строка 174)

onDestroy : Phaser.Signal

Этот сигнал отправляется, когда группа уничтожается.

Унаследованно от

• Phaser.Group#onDestroy

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

particleAnchor : Phaser.Point

При создании частицы её якорь будет установлен в соответствии с этим объектом Point (по умолчанию x/y: 0,5 для облегчения вращения).

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

particleBringToTop : boolean

Если это true, то при выбросе частицы она будет выведена наверх списка отображения излучателя.

Исходный код: particles/arcade/Emitter.js (Строка 199)

particleClass :any

Для вывода ваших собственных типов класса частиц. Они должны расширять Phaser.Particle.

Исходный код: particles/arcade/Emitter.js (Строка 121)

particleDrag : Phaser.Point

Компоненты X и Y сопротивления частиц, выпущенных из излучателя.

Исходный код: particles/arcade/Emitter.js (Строка 126)

particleSendToBack : boolean

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

Исходный код: particles/arcade/Emitter.js (Строка 205)

pendingDestroy : boolean

Группа, у которой pendingDestroy установлено в значение true, помечается для вызова её метода уничтожения
на следующем логическом обновлении.
Вы можете установить его напрямую, чтобы пометить группу на уничтожение на следующем обновлении.

Это очень полезно, если вы хотите уничтожить группу из одного из её собственных обратных вызовов
или обратного вызова одного из её дочерних элементов.

Унаследованно от

• Phaser.Group#pendingDestroy

Исходный код: core/Group.js (Строка 119)

physicsBodyType : integer

Если enableBody имеет значение true, это тип физического тела, создаваемого на новых спрайтах.

Допустимые значения: Phaser.Physics.ARCADE, Phaser.Physics.P2JS, Phaser.Physics.NINJA и т.д.

Унаследованно от

• Phaser.Group#physicsBodyType

Исходный код: core/Group.js (Строка 225)

physicsSortDirection : integer

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

Должно быть установлено на одно из констант направлений сортировки Phaser.Physics.Arcade:

Phaser.Physics.Arcade.SORT_NONE
Phaser.Physics.Arcade.LEFT_RIGHT
Phaser.Physics.Arcade.RIGHT_LEFT
Phaser.Physics.Arcade.TOP_BOTTOM
Phaser.Physics.Arcade.BOTTOM_TOP

Если установлено значение null, группа будет использовать то значение, которое установлено в Phaser.Physics.Arcade.sortDirection. Это поведение по умолчанию.

Унаследованно от

• Phaser.Group#physicsSortDirection

Исходный код: core/Group.js (Строка 243)

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

Тип физического тела по умолчанию для этого объекта.

Исходный код: particles/arcade/Emitter.js (Строка 45)

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

Возвращает правую позицию излучателя.

Исходный код: particles/arcade/Emitter.js (Строка 964)

rotation : number

Угол поворота контейнера группы в радианах.

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

Унаследованно от

• Phaser.Group#rotation

Исходный код: core/Group.js (Строка 2987)

scaleData :array

Массив рассчитанных данных сглаживания масштаба, применяемых к частицам со значениями scaleRates > 0.

Исходный код: particles/arcade/Emitter.js (Строка 80)

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

Возвращает верхнюю позицию излучателя.

Исходный код: particles/arcade/Emitter.js (Строка 977)

[только для чтения] total : integer

Общее количество существующих дочерних элементов в группе.

Унаследованно от

• Phaser.Group#total

Исходный код: core/Group.js (Строка 2648)

<внутренний> type : number

Внутреннее значение типа Phaser.

Внутреннее:

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

Исходный код: particles/arcade/Emitter.js (Строка 39)

visible : boolean

Состояние видимости группы. Невидимые группы и все их дочерние элементы не отображаются.

Унаследованно от

• Phaser.Group#visible

Исходный код: core/Group.js (Строка 2996)

width : number

Получает или задаёт ширину эмиттера. Это область, в которой может быть выпущен частица.

Source code: particles/arcade/Emitter.js (Line 887)

x : number

Получает или задаёт положение x эмиттера.

Source code: particles/arcade/Emitter.js (Line 919)

y : number

Получает или задаёт положение y эмиттера.

Source code: particles/arcade/Emitter.js (Line 935)

[readonly] z : integer

Значение z-глубины этого объекта в его родительском контейнере/группе - Мир тоже является группой.
Это значение должно быть уникальным для каждого дочернего элемента в группе.

Inherited From

• Phaser.Group#z

Source code: core/Group.js (Line 57)

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

add(child, silent, index) → {DisplayObject}

Добавляет существующий объект в качестве верхнего дочернего элемента в эту группу.

Дочерний элемент автоматически добавляется в верхнюю часть группы и отображается над всеми предыдущими дочерними элементами.

Или, если указан необязательный параметр index, дочерний элемент добавляется в указанную позицию, определяемую значением индекса;
это позволяет контролировать порядок дочерних элементов.

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

Если Group.enableBody установлено, то на объект будет создан физический объект, если таковой еще не существует.

Если Group.inputEnableChildren установлено, то на объект будет создан обработчик ввода, если таковой еще не существует.

Для управления позицией добавления дочернего элемента используйте addAt. Для создания и добавления нового дочернего элемента используйте create.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
child	DisplayObject			Объект отображения, добавляемый в качестве дочернего элемента.
silent	boolean	<optional>	false	Если true, дочерний элемент не будет отправлять событие onAddedToGroup.
index	integer	<optional>		Индекс в группе для вставки дочернего элемента. Где 0 - нижняя часть группы.

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

DisplayObject -

Дочерний элемент, добавленный в группу.

Унаследовано от

• Phaser.Group#add

Исходный код: core/Group.js (Строка 341)

addAll(property, amount, checkAlive, checkVisible)

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

Group.addAll('x', 10) добавит 10 к значению child.x для каждого дочернего элемента.

Параметры

Имя	Тип	Описание
property	string	Свойство для инкремента, например, 'body.velocity.x' или 'angle'.
amount	number	Количество для прибавления к свойству. Если child.x = 10, то addAll('x', 40) сделает child.x = 50.
checkAlive	boolean	Если true, свойство будет изменено только если дочерний элемент жив.
checkVisible	boolean	Если true, свойство будет изменено только если дочерний элемент видим.

Унаследовано от

• Phaser.Group#addAll

Исходный код: core/Group.js (Строка 1386)

addAt(child, index, silent) → {DisplayObject}

Добавляет существующий объект в эту группу.

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

Если Group.enableBody установлено, то на объект будет создан физический объект, если таковой еще не существует.

Если Group.inputEnableChildren установлено, то на объект будет создан обработчик ввода, если таковой еще не существует.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
child	DisplayObject			Объект отображения, добавляемый в качестве дочернего элемента.
index	integer	<optional>	0	Индекс в группе для вставки дочернего элемента.
silent	boolean	<optional>	false	Если true, дочерний элемент не будет отправлять событие onAddedToGroup.

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

DisplayObject -

Дочерний элемент, добавленный в группу.

Унаследовано от

• Phaser.Group#addAt

Исходный код: core/Group.js (Строка 418)

addChild(child) → {DisplayObject}

Добавляет дочерний элемент в контейнер.

Параметры

Имя	Тип	Описание
child	DisplayObject	Объект DisplayObject для добавления в контейнер

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

DisplayObject -

Дочерний элемент, который был добавлен.

Унаследовано от

• PIXI.DisplayObjectContainer#addChild

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 42)

addChildAt(child, index) → {DisplayObject}

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

Параметры

Имя	Тип	Описание
child	DisplayObject	Дочерний элемент для добавления
index	Number	Индекс, в который необходимо поместить дочерний элемент

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

DisplayObject -

Дочерний элемент, который был добавлен.

Унаследовано от

• PIXI.DisplayObjectContainer#addChildAt

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

addMultiple(children, silent) → {Array.<DisplayObject> | Phaser.Group}

Добавляет массив существующих объектов Display Object в эту группу.

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

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

Если Group.enableBody установлено, то на объекты будет создан физический объект, если таковой еще не существует.

Если Group.inputEnableChildren установлено, то на объекты будет создан обработчик ввода, если таковой еще не существует.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
children	Array.<DisplayObject> | Phaser.Group			Массив графических объектов или Phaser.Group. Если задан Group, то все дочерние элементы будут перемещены из него.
silent	boolean	<optional>	false	Если true, дочерние элементы не будут отправлять событие onAddedToGroup.

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

Array.<DisplayObject> | Phaser.Group -

Массив дочерних элементов или группа дочерних элементов, которые были добавлены в эту группу.

Унаследовано от

• Phaser.Group#addMultiple

Исходный код: core/Group.js (Строка 489)

addToHash(child) → {boolean}

Добавляет дочерний элемент этой группы в массив хешей.
Этот вызов вернёт false, если дочерний элемент не является дочерним элементом этой группы или уже находится в хеше.

Параметры

Имя	Тип	Описание
child	DisplayObject	Графический объект для добавления в хеш этой группы. Должен быть членом этой группы и не присутствовать в хеше.

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

boolean -

True, если дочерний элемент был успешно добавлен в хеш, иначе false.

Унаследовано от

• Phaser.Group#addToHash

Исходный код: core/Group.js (Строка 439)

align(width, height, cellWidth, cellHeight, position, offset) → {boolean}

Этот метод итерируется по всем дочерним элементам в группе (независимо от того, видны они или существуют)
и затем изменяет их положение, чтобы они были расположены в сетке. Дочерние элементы должны иметь
метод alignTo, чтобы их можно было разместить с помощью этого вызова. Все стандартные объекты Phaser Game имеют
это.

Размеры сетки определяются первыми четырьмя аргументами. Аргументы width и height соответствуют ширине и высоте сетки соответственно.

Например, если в группе было 100 дочерних элементов:

Group.align(10, 10, 32, 32)

Это выровняет все дочерние элементы в сетку 10x10, используя 32 пикселя на
ячейку сетки. Если вы хотите более широкую сетку, вы можете сделать:

Group.align(25, 4, 32, 32)

Это выровняет дочерние элементы в сетку 25x4, опять же, используя 32 пикселя на ячейку сетки.

Вы можете установить либо значение width, либо значение height в -1. Это говорит методу
продолжать выравнивание дочерних элементов до тех пор, пока не останется ни одного дочернего элемента. Например, если у этой группы
было 48 дочерних элементов, то следующее:

Group.align(-1, 8, 32, 32)

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

Вы также можете сделать:

Group.align(10, -1, 32, 32)

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

Свойство position позволяет контролировать, где в каждой ячейке сетки находится дочерний элемент.
Это константа и может быть одной из Phaser.TOP_LEFT (по умолчанию), Phaser.TOP_CENTER,
Phaser.TOP_RIGHT, Phaser.LEFT_CENTER, Phaser.CENTER, Phaser.RIGHT_CENTER,
Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER или Phaser.BOTTOM_RIGHT.

Последний аргумент; offset позволяет начать выравнивание с определенного индекса дочернего элемента.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
width	integer			Ширина сетки в элементах (а не пикселях). Устанавливается в -1 для динамической ширины. Если -1, то необходимо задать явное значение высоты.
height	integer			Высота сетки в элементах (а не пикселях). Устанавливается в -1 для динамической высоты. Если -1, то необходимо задать явное значение ширины.
cellWidth	integer			Ширина каждой ячейки сетки в пикселях.
cellHeight	integer			Высота каждой ячейки сетки в пикселях.
position	integer	<optional>		Константа позиции. Одна из Phaser.TOP_LEFT (по умолчанию), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER, Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER или Phaser.BOTTOM_RIGHT.
offset	integer	<optional>	0	Необязательный индекс, с которого начать выравнивание. По умолчанию ноль, первый дочерний элемент в группе, но может быть установлен на любое допустимое значение индекса дочернего элемента.

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

boolean -

True, если дочерние элементы группы были выровнены, иначе false.

Унаследовано от

• Phaser.Group#align

Исходный код: core/Group.js (Строка 682)

alignIn(container, position, offsetX, offsetY) → {Phaser.Group}

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

Контейнер должен быть объектом игры или объектом Phaser.Rectangle. Это может включать свойства
такие как World.bounds или Camera.view, для выравнивания групп внутри мира
и границ камеры. Или это могут быть другие спрайты, изображения, текстовые объекты, BitmapText,
TileSprites или кнопки.

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

Константы положения, которые вы можете использовать:

Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER,
Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT,
Phaser.BOTTOM_CENTER и Phaser.BOTTOM_RIGHT.

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

Необязательные аргументы offsetX и offsetY позволяют вам добавить дополнительный отступ к конечному
выровненному положению группы. Например:

group.alignIn(background, Phaser.BOTTOM_RIGHT, -20, -20)

Выровняло бы group в нижний правый угол, но сместило его на 20 пикселей от угла.
Подумайте об отступах как об применении корректировки к границам контейнера перед выравниванием.
Таким образом, отрицательный отступ «сузит» границы контейнера на эту величину, а положительный
расширит их.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
container	Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite			Объект игры или прямоугольник, относительно которого выравнивается эта группа. Также может содержать свойства, такие как World.bounds или Camera.view.
position	целое число	<необязательно>		Константа позиции. Одна из Phaser.TOP_LEFT (по умолчанию), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER, Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER или Phaser.BOTTOM_RIGHT.
offsetX	целое число	<необязательно>	0	Горизонтальная корректировка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения.
offsetY	целое число	<необязательно>	0	Вертикальная корректировка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения.

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

Phaser.Group -

Эта группа.

Унаследовано от

• Phaser.Group#alignIn

Исходный код: core/Group.js (Строка 2873)

alignTo(parent, position, offsetX, offsetY) → {Phaser.Group}

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

Родитель должен быть объектом игры или объектом Phaser.Rectangle. Это может включать свойства, такие как World.bounds или Camera.view, для выравнивания групп в пределах мира и границ камеры. Или это могут быть другие Sprites, Images, Text, BitmapText, TileSprites или Button.

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

Константы позиций, которые вы можете использовать:

Phaser.TOP_LEFT (по умолчанию), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_TOP,
Phaser.LEFT_CENTER, Phaser.LEFT_BOTTOM, Phaser.RIGHT_TOP, Phaser.RIGHT_CENTER,
Phaser.RIGHT_BOTTOM, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER
и Phaser.BOTTOM_RIGHT.

Группы размещаются таким образом, что их границы выравниваются с родителем, учитывая вращение и масштаб дочерних элементов.
Это позволяет аккуратно выравнивать группы, независимо от их значения позиции.

Дополнительные аргументы offsetX и offsetY позволяют вам применить дополнительный отступ к окончательному выровненному положению группы. Например:

group.alignTo(background, Phaser.BOTTOM_RIGHT, -20, -20)

Выровняло бы group в нижний правый угол, но сместило на 20 пикселей от угла.
Представьте, что смещения применяют корректировку к границам родителя перед выравниванием. Таким образом, предоставление отрицательного смещения уменьшит границы родителя на эту величину, а положительного — увеличит.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
parent	Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite			Объект игры или прямоугольник, относительно которого выравнивается эта группа. Также может содержать свойства, такие как World.bounds или Camera.view.
position	целое число	<необязательно>		Константа позиции. Одна из Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_TOP, Phaser.LEFT_CENTER, Phaser.LEFT_BOTTOM, Phaser.RIGHT_TOP, Phaser.RIGHT_CENTER, Phaser.RIGHT_BOTTOM, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER или Phaser.BOTTOM_RIGHT.
offsetX	целое число	<необязательно>	0	Горизонтальная корректировка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения.
offsetY	целое число	<необязательно>	0	Вертикальная корректировка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения.

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

Phaser.Group -

Эта группа.

Унаследовано от

• Phaser.Group#alignTo

Исходный код: core/Group.js (Строка 2915)

<internal> ascendingSortHandler(a, b)

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

Параметры

Имя	Тип	Описание
a	объект	Первый сортируемый объект.
b	объект	Второй сортируемый объект.

Унаследовано от

• Phaser.Group#ascendingSortHandler

Внутренний:

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

Исходный код: core/Group.js (Строка 1919)

at(object) → {Phaser.Particles.Arcade.Emitter}

Изменяет центр эмиттера, чтобы он соответствовал центру любого объекта со свойством center, например, Sprite.
Если у объекта нет свойства center, оно будет установлено в object.x + object.width / 2

Параметры

Имя	Тип	Описание
object	объект | Phaser.Sprite | Phaser.Image | Phaser.TileSprite | Phaser.Text | PIXI.DisplayObject	Объект, центр которого вы хотите использовать.

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

Phaser.Particles.Arcade.Emitter -

Экземпляр этого эмиттера.

Исходный код: particles/arcade/Emitter.js (Строка 862)

bringToTop(child) → {any}

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

Parameters

Name	Type	Description
child	any	Потомок, который нужно переместить в начало группы.

Returns

any -

Потомок, который был перемещен.

Inherited From

• Phaser.Group#bringToTop

Source code: core/Group.js (Line 907)

callAll(method, context, args)

Вызывает функцию, заданную по имени, у всех потомков.

Функция вызывается для всех потомков, независимо от того, живы они или мертвы (см. callAllExists для других вариантов).
После параметра method и context можно добавить любое количество дополнительных параметров, которые будут переданы потомку.

Parameters

Name	Type	Argument	Default	Description
method	string			Имя функции у потомка, которую нужно вызвать. Поддерживается глубокий поиск по свойствам.
context	string	<optional>	null	Строка, содержащая контекст, в котором будет выполняться метод. Устанавливается в null для использования контекста потомка по умолчанию.
args	any	<repeatable>		Дополнительные параметры, которые будут переданы методу.

Inherited From

• Phaser.Group#callAll

Source code: core/Group.js (Line 1538)

callAllExists(callback, existsValue, parameter)

Вызывает функцию, заданную по имени, у всех потомков в группе, которые существуют (или не существуют).

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

Parameters

Name	Type	Argument	Description
callback	string		Имя функции у потомков, которую нужно вызвать.
existsValue	boolean		Будут вызываться только потомки с exists=existsValue.
parameter	any	<repeatable>	Дополнительные параметры, которые будут переданы обратно вызываемому методу.

Inherited From

• Phaser.Group#callAllExists

Source code: core/Group.js (Line 1454)

<internal> callbackFromArray(child, callback, length)

Возвращает ссылку на функцию, которая существует у потомка группы, на основе заданного массива callback.

Parameters

Name	Type	Description
child	object	Объект для проверки.
callback	array	Массив имён функций.
length	integer	Размер массива (вычислен в callAll).

Inherited From

• Phaser.Group#callbackFromArray

Internal:

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

Source code: core/Group.js (Line 1488)

checkAll(key, value, checkAlive, checkVisible, force)

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

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

Parameters

Name	Type	Argument	Default	Description
key	string			Свойство в виде строки, которое нужно установить. Например: 'body.velocity.x'
value	any			Значение, которое будет проверено.
checkAlive	boolean	<optional>	false	Если установлено, то будут проверены только потомки с alive=true. Это включает любые группы, которые являются потомками.
checkVisible	boolean	<optional>	false	Если установлено, то будут проверены только потомки с visible=true. Это включает любые группы, которые являются потомками.
force	boolean	<optional>	false	Если force равно true, то свойство будет проверено у потомка независимо от того, существует ли оно уже или нет. Если true и свойство не существует, будет возвращено false.

Inherited From

• Phaser.Group#checkAll

Source code: core/Group.js (Line 1353)

checkProperty(child, key, value, force) → {boolean}

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

Parameters

Name	Type	Argument	Default	Description
child	any			Потомок, у которого нужно проверить значение свойства.
key	array			Массив строк, составляющих свойство, которое будет установлено.
value	any			Значение, которое будет проверено.
force	boolean	<optional>	false	Если force равно true, то свойство будет проверено у потомка независимо от того, существует ли оно уже или нет. Если true и свойство не существует, будет возвращено false.

Returns

boolean -

True, если свойство было равно значению, false — если нет.

Унаследовано от

• Phaser.Group#checkProperty

Исходный код: core/Group.js (Строка 1217)

contains(child) → {Булево}

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

Параметры

Имя	Тип	Описание
child	DisplayObject	-

Возвращает

Булево -

Унаследовано от

• PIXI.DisplayObjectContainer#contains

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 449)

countDead() → {целое}

Получить количество мертвых дочерних элементов в этой группе.

Возвращает

целое -

Количество дочерних элементов, помеченных как мертвые.

Унаследовано от

• Phaser.Group#countDead

Исходный код: core/Group.js (Строка 2338)

countLiving() → {целое}

Получить количество живых дочерних элементов в этой группе.

Возвращает

целое -

Количество дочерних элементов, помеченных как живые.

Унаследовано от

• Phaser.Group#countLiving

Исходный код: core/Group.js (Строка 2326)

create(x, y, key, frame, exists, index) → {DisplayObject}

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

Используйте classType для изменения типа создаваемого объекта.

Дочерний элемент автоматически добавляется в верхнюю часть группы и отображается над каждым предыдущим дочерним элементом.

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

Если Group.enableBody установлено, то на объекте будет создано физическое тело, если оно еще не существует.

Если Group.inputEnableChildren установлено, то на объекте будет создан обработчик ввода, если он еще не существует.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
x	число			Координата x для отображения только что созданного Sprite. Значение относится к точке group.x.
y	число			Координата y для отображения только что созданного Sprite. Значение относится к точке group.y.
key	строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture	<необязательно>		Это изображение или текстура, используемые Sprite при отрисовке. Это может быть строка, являющаяся ссылкой на запись Cache Image, или экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
frame	строка | число	<необязательно>		Если этот Sprite использует часть спрайт-листа или атласа текстур, вы можете указать точный кадр, используя строку или числовой индекс.
exists	логическое	<необязательно>	true	Стандартное состояние существует Sprite.
index	целое	<необязательно>		Индекс в группе для вставки дочернего элемента. Где 0 - это низ группы.

Возвращает

DisplayObject -

Созданный дочерний элемент: будет Phaser.Sprite, если #classType не изменен.

Унаследовано от

• Phaser.Group#create

Исходный код: core/Group.js (Строка 544)

createMultiple(quantity, key, frame, exists) → {массив}

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

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

Используйте classType для изменения типа создаваемого объекта.

Вы можете указать массив в качестве аргументов key и/или frame. Когда вы это делаете,
он создаст quantity спрайтов для каждого ключа (и кадра) в массивах.

Например:

createMultiple(25, ['ball', 'carrot'])

В приведенном выше коде есть 2 ключа (мяч и морковь), что означает, что будет создано 50 спрайтов в целом, 25 каждого.
Вы также можете указать frame как массив:

createMultiple(5, 'bricks', [0, 1, 2, 3])

В приведенном выше примере есть один ключ (кирпичи), который является спрайт-листом. Массив кадров сообщает этому методу использовать кадры 0, 1, 2 и 3. Итого будет создано 20 спрайтов, потому что
количество было установлено в 5, так что это 5 спрайтов кирпичей с кадром 0, 5 спрайтов кирпичей с кадром 1 и т. д.

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

createMultiple(20, ['diamonds', 'balls'], [0, 1, 2])

Выше приведенное создаст 20 «алмазов» кадра 0, 20 с кадром 1 и 20 с кадром 2.
Затем он создаст 20 «мячей» кадра 0, 20 с кадром 1 и 20 с кадром 2.
В итоге он создаст 120 спрайтов.

По умолчанию у спрайтов свойство exists будет установлено в false, и они будут
размещены в 0x0 относительно значений Group.x / y.

Если Group.enableBody установлено, то на объектах будет создано физическое тело, если оно еще не существует.

Если Group.inputEnableChildren установлено, то на объектах будет создан обработчик ввода, если он еще не существует.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
quantity	целое число			Количество создаваемых спрайтов.
key	строка | массив			Ключ кэша изображения, которое будут использовать спрайты. Или массив ключей. Подробности о количестве при использовании массивов см. в описании.
frame	целое число | строка | массив	<необязательно>	0	Если изображение спрайта содержит несколько кадров, здесь можно указать, какой из них использовать. Или массив кадров. Подробности о количестве при использовании массивов см. в описании.
exists	логическое значение	<необязательно>	false	Стандартное состояние существования спрайта.

Возвращает

массив -

Массив, содержащий все созданные спрайты.

Унаследовано от

• Phaser.Group#createMultiple

Исходный код: core/Group.js (Строка 581)

customSort(sortHandler, context)

Сортирует детей в группе в соответствии с пользовательской функцией сортировки.

Функции sortHandler передаются два параметра: два вовлеченных в сравнение ребенка (a и b).
Она должна вернуть -1, если a > b, 1, если a < b или 0, если a === b.

Параметры

Имя	Тип	Аргумент	Описание
sortHandler	функция		Пользовательская функция сортировки.
context	объект	<необязательно>	Контекст, в котором вызывается sortHandler.

Унаследовано от

• Phaser.Group#customSort

Исходный код: core/Group.js (Строка 1895)

<внутренний> descendingSortHandler(a, b)

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

Параметры

Имя	Тип	Описание
a	объект	Первый сортируемый объект.
b	объект	Второй сортируемый объект.

Унаследовано от

• Phaser.Group#descendingSortHandler

Внутренний:

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

Исходный код: core/Group.js (Строка 1951)

destroy()

Уничтожает этот Emitter, все связанные дочерние частицы, а затем удаляет себя из менеджера частиц.

Исходный код: particles/arcade/Emitter.js (Строка 681)

divideAll(property, amount, checkAlive, checkVisible)

Делит указанное свойство на количество по всем дочерним элементам в этой группе.

Group.divideAll('x', 2) разделит значение child.x для каждого ребенка пополам.

Параметры

Имя	Тип	Описание
property	строка	Свойство для деления, например, 'body.velocity.x' или 'angle'.
amount	число	Значение для деления свойства. Если child.x = 100, то divideAll('x', 2) сделает child.x = 50.
checkAlive	логическое значение	Если true, свойство будет изменено только если ребенок жив.
checkVisible	логическое значение	Если true, свойство будет изменено только если ребенок видим.

Унаследовано от

• Phaser.Group#divideAll

Исходный код: core/Group.js (Строка 1437)

emitParticle(x, y, key, frame) → {boolean}

Эта функция используется внутренне для вывода следующей частицы в очереди.

Однако ее также можно вызвать внешне для вывода частицы.

При вызове внешне вы можете использовать аргументы для переопределения любых значений по умолчанию, установленных Emitter.

Параметры

Имя	Тип	Аргумент	Описание
x	число	<необязательно>	Координата x для вывода частицы. Если null или undefined, она будет использовать Emitter.emitX, или, если у Emitter ширина > 1, случайное значение между Emitter.left и Emitter.right.
y	число	<необязательно>	Координата y для вывода частицы. Если null или undefined, она будет использовать Emitter.emitY, или, если у Emitter высота > 1, случайное значение между Emitter.top и Emitter.bottom.
key	строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture	<необязательно>	Это изображение или текстура, используемые частицей во время рендеринга. Это может быть строка, которая является ссылкой на запись кэшированного изображения, или экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
frame	строка | число	<необязательно>	Если эта частица использует часть спрайт-листа или атласа текстур, вы можете указать точный кадр, указав строку или числовой индекс.

Возвращает

логическое значение -

True, если частица была выведена, в противном случае false.

Исходный код: particles/arcade/Emitter.js (Строка 553)

explode(lifespan, quantity) → {Phaser.Particles.Arcade.Emitter}

Вызовите эту функцию, чтобы вывести заданное количество частиц сразу (взрыв)

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
lifespan	number	<optional>	0	Сколько времени живет каждая частица после выброса в мс. 0 = навсегда.
quantity	number	<optional>	0	Сколько частиц запустить.

Возвращает

Phaser.Particles.Arcade.Emitter -

Экземпляр этого эмиттера.

Исходный код: particles/arcade/Emitter.js (Строка 438)

filter(predicate, checkExists) → {Phaser.ArraySet}

Найти дочерние элементы, соответствующие определенному предикату.

Например:

var healthyList = Group.filter(function(child, index, children) {
    return child.health > 10 ? true : false;
}, true);
healthyList.callAll('attack');

Примечание: В настоящее время это пропустит любые дочерние элементы, которые сами являются группами.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
predicate	function			Функция, с которой будет оцениваться каждый дочерний элемент. Каждый дочерний элемент группы будет передан в качестве первого параметра, индекс — как второй, а весь массив дочерних элементов — как третий.
checkExists	boolean	<optional>	false	Если true, для выбора будут отобраны только существующие; в противном случае все дочерние элементы могут быть выбраны и будут переданы в предикат.

Возвращает

Phaser.ArraySet -

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

Унаследовано от

• Phaser.Group#filter

Исходный код: core/Group.js (Строка 1677)

flow(lifespan, frequency, quantity, total, immediate) → {Phaser.Particles.Arcade.Emitter}

Вызовите эту функцию, чтобы начать выпуск потока частиц с заданной частотой.
Он будет продолжаться, пока не будет достигнуто заданное значение.
При каждом запуске потока будет выпущено заданное количество частиц вместе.
Если вы зададите общее значение 20 и количество 5, то поток выпустит 4 раза в общей сложности (4 x 5 = 20 в общей сложности)
Если вы зададите общее значение -1, то ограничение по количеству не используется, и выпуск будет продолжаться.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
lifespan	number	<optional>	0	Сколько времени живет каждая частица после выброса в мс. 0 = навсегда.
frequency	number	<optional>	250	Частота выпуска частиц, заданная в мс.
quantity	number	<optional>	1	Сколько частиц выпустить каждый раз, когда достигается частота. Не может быть > Emitter.maxParticles.
total	number	<optional>	-1	Сколько частиц выпустить в общей сложности. Если -1, выпуск будет продолжаться неограниченно.
immediate	boolean	<optional>	true	Начать поток сразу (true) или подождать события первой частоты (false)?

Возвращает

Phaser.Particles.Arcade.Emitter -

Экземпляр этого эмиттера.

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

forEach(callback, callbackContext, checkExists, args)

Вызвать функцию для каждого дочернего элемента в этой группе.

Дополнительные аргументы для обратного вызова могут быть указаны после параметра checkExists. Например,

Group.forEach(awardBonusGold, this, true, 100, 500)

вызовет функцию awardBonusGold с параметрами (child, 100, 500).

Примечание: Этот проверка пропустит любые дочерние элементы, которые являются сами группами.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
callback	function			Функция, которая будет вызываться для каждого соответствующего дочернего элемента. Дочерний элемент будет передан в качестве первого аргумента.
callbackContext	object			Контекст, в котором должна быть вызвана функция (обычно «this»).
checkExists	boolean	<optional>	false	Если установлено, то только дочерние элементы, для которых exists имеет значение true, будут переданы в обратный вызов, в противном случае будут переданы все дочерние элементы.
args	any	<optional> <repeatable>	(none)	Дополнительные аргументы для передачи в функцию обратного вызова после элемента дочернего элемента.

Унаследовано от

• Phaser.Group#forEach

Исходный код: core/Group.js (Строка 1717)

forEachAlive(callback, callbackContext, args)

Вызвать функцию для каждого живого дочернего элемента в этой группе.

См. forEach для получения подробностей.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
callback	function			Функция, которая будет вызываться для каждого соответствующего дочернего элемента. Дочерний элемент будет передан в качестве первого аргумента.
callbackContext	object			Контекст, в котором должна быть вызвана функция (обычно «this»).
args	any	<optional> <repeatable>	(none)	Дополнительные аргументы для передачи в функцию обратного вызова после элемента дочернего элемента.

Унаследовано от

• Phaser.Group#forEachAlive

Исходный код: core/Group.js (Строка 1799)

forEachDead(callback, callbackContext, args)

Вызвать функцию для каждого мертвого дочернего элемента в этой группе.

См. forEach для получения подробностей.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
callback	функция			Функция, которая будет вызвана для каждого соответствующего дочернего элемента. Дочерний элемент будет передан в качестве первого аргумента.
callbackContext	объект			Контекст, в котором должна быть вызвана функция (обычно 'this').
args	любое	<необязательно> <повторяемо>	(нет)	Дополнительные аргументы, которые нужно передать в функцию обратного вызова после элемента дочернего элемента.

Унаследовано от

• Phaser.Group#forEachDead

Исходный код: core/Group.js (Строка 1827)

forEachExists(callback, callbackContext, args)

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

См. forEach для получения подробностей.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
callback	функция			Функция, которая будет вызвана для каждого соответствующего дочернего элемента. Дочерний элемент будет передан в качестве первого аргумента.
callbackContext	объект			Контекст, в котором должна быть вызвана функция (обычно 'this').
args	любое	<необязательно> <повторяемо>	(нет)	Дополнительные аргументы, которые нужно передать в функцию обратного вызова после элемента дочернего элемента.

Унаследовано от

• Phaser.Group#forEachExists

Исходный код: core/Group.js (Строка 1771)

getAll(property, value, startIndex, endIndex) → {любое}

Возвращает всех дочерних элементов в этой группе.

Вы можете необязательно указать критерии сопоставления, используя аргументы property и value.

Например: getAll('exists', true) вернёт только дочерние элементы, у которых свойство exists установлено.

Необязательно можно указать начальный и конечный индекс. Например, если у этой группы было 100 дочерних элементов,
и вы установили startIndex в 0 и endIndex в 50, он вернёт случайный дочерний элемент только
из первых 50 дочерних элементов в группе.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
property	строка	<необязательно>		Необязательное свойство для проверки по аргументу value.
value	любое	<необязательно>		Если свойство задано, Child.property должно строго совпадать с этим значением, чтобы быть включённым в результаты.
startIndex	целое число	<необязательно>	0	Индекс первого дочернего элемента, с которого начинать поиск.
endIndex	целое число	<необязательно>		Последний индекс дочернего элемента для поиска.

Возвращает

любое -

Случайный существующий дочерний элемент этой группы.

Унаследовано от

• Phaser.Group#getAll

Исходный код: core/Group.js (Строка 2392)

getAt(index) → {DisplayObject | целое число}

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

Параметры

Имя	Тип	Описание
index	целое число	Индекс для возврата дочернего элемента.

Возвращает

DisplayObject | целое число -

Дочерний элемент, который был найден по заданному индексу, или -1 для недопустимого индекса.

Унаследовано от

• Phaser.Group#getAt

Исходный код: core/Group.js (Строка 524)

getBottom() → {любое}

Возвращает дочерний элемент внизу этой группы.

Дочерний элемент внизу — это дочерний элемент, отображаемый (отображаемый) ниже всех других дочерних элементов.

Возвращает

любое -

Дочерний элемент в нижней части группы.

Унаследовано от

• Phaser.Group#getBottom

Исходный код: core/Group.js (Строка 2221)

getBounds(targetCoordinateSpace) → {Прямоугольник}

Получает глобальные границы displayObjectContainer в виде прямоугольника. Вычисление границ учитывает все видимые дочерние элементы.

Параметры

Имя	Тип	Аргумент	Описание
targetCoordinateSpace	PIXIDisplayObject | PIXIMatrix	<необязательно>	Возвращает прямоугольник, определяющий область отображения объекта относительно системы координат объекта targetCoordinateSpace.

Возвращает

Прямоугольник -

Прямоугольная область ограничивающей рамки

Унаследовано от

• PIXI.DisplayObjectContainer#getBounds

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 280)

getByName(name) → {любое}

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

Параметры

Имя	Тип	Описание
name	строка	Имя для поиска.

Возвращает

любое -

Первый дочерний элемент с соответствующим именем или null, если не было найдено ни одного.

Унаследовано от

• Phaser.Group#getByName

Исходный код: core/Group.js (Строка 1042)

getChildAt(index) → {DisplayObject}

Возвращает потомка по указанному индексу.

Параметры

Имя	Тип	Описание
index	Число	Индекс потомка.

Возвращает

DisplayObject -

Потомок по указанному индексу, если он существует.

Унаследовано от

• PIXI.DisplayObjectContainer#getChildAt

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 153)

getChildIndex(child) → {Число}

Возвращает индекс позиции потомка DisplayObject.

Параметры

Имя	Тип	Описание
child	DisplayObject	Потомок DisplayObject для определения.

Возвращает

Число -

Позиционный индекс объекта отображения потомка.

Унаследовано от

• PIXI.DisplayObjectContainer#getChildIndex

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 112)

getClosestTo(object, callback, callbackContext) → {any}

Находит потомка, ближайшего к заданному объекту. Позволяет использовать необязательный callback для фильтрации потомков.

Это может быть Sprite, Group, Image или любой объект с общедоступными свойствами x и y.

«Близость» определяется расстоянием между свойствами объектов x и y и свойствами потомков x и y.

Необязательный аргумент callback позволяет применять собственную фильтрацию к проверкам расстояния.
Если потомок ближе, чем предыдущий, он передаётся в callback в качестве первого аргумента,
а расстояние — во втором. Функция callback должна возвращать true, если потомок соответствует критериям,
иначе — false.

Параметры

Имя	Тип	Аргумент	Описание
object	any		Объект для определения расстояния. Может быть Sprite, Group, Image или любой объект со свойствами x и y.
callback	function	<optional>	Функция, применяемая к каждому потомку. Она получает потомка как первый аргумент, а расстояние — как второй. Должна возвращать true, если потомок соответствует условиям.
callbackContext	object	<optional>	Контекст вызова функции (обычно 'this').

Возвращает

any -

Ближайший потомок или null, если потомок не найден.

Унаследовано от

• Phaser.Group#getClosestTo

Исходный код: core/Group.js (Строка 2238)

getFirstAlive(createIfNull, x, y, key, frame) → {DisplayObject}

Возвращает первого живого потомка (child.alive === true).

Полезно для выбора лидера отряда и т.п.

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

Работает, вызывая Group.create с переданными параметрами и возвращая нового потомка.

Если потомок найден, createIfNull имеет значение false, а вы передали дополнительные аргументы, то потомок
будет сброшен и/или получит новую текстуру. Это обрабатывается функцией Group.resetChild.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
createIfNull	boolean	<optional>	false	Если true и живых потомков нет, создаётся новый.
x	number	<optional>		Координата x для сброса потомка. Значение относительно точки group.x.
y	number	<optional>		Координата y для сброса потомка. Значение относительно точки group.y.
key	string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture	<optional>		Изображение или текстура, используемые Sprite при отрисовке. Может быть строкой, ссылающейся на запись Cache Image, или экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.
frame	string | number	<optional>		Если Sprite использует часть спрайт-листа или атласа текстур, вы можете указать нужный кадр, используя строку или числовой индекс.

Возвращает

DisplayObject -

Живой потомок или null, если не найден и createIfNull было false.

Унаследовано от

• Phaser.Group#getFirstAlive

Исходный код: core/Group.js (Строка 2105)

getFirstDead(createIfNull, x, y, key, frame) → {DisplayObject}

Возвращает первого мёртвого потомка (child.alive === false).

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

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

Работает, вызывая Group.create с переданными параметрами и возвращая нового потомка.

Если потомок найден, createIfNull имеет значение false, а вы передали дополнительные аргументы, то потомок
будет сброшен и/или получит новую текстуру. Это обрабатывается функцией Group.resetChild.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
createIfNull	boolean	<optional>	false	Если true и не найдены мёртвые дочерние элементы, создается новый.
x	number	<optional>		Координата x, для сброса дочернего элемента. Значение относительно точки group.x.
y	number	<optional>		Координата y, для сброса дочернего элемента. Значение относительно точки group.y.
key	string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture	<optional>		Изображение или текстура, используемая Sprite во время отрисовки. Может быть строкой, являющейся ссылкой на запись Cache Image, или экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.
frame	string | number	<optional>		Если этот Sprite использует часть спрайт-листа или текстурного атласа, вы можете указать точный кадр, используя строку или числовой индекс.

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

DisplayObject -

Первый мёртвый дочерний элемент, или null если не найден, и createIfNull было false.

Унаследовано от

• Phaser.Group#getFirstDead

Исходный код: core/Group.js (Строка 2135)

getFirstExists(exists, createIfNull, x, y, key, frame) → {DisplayObject}

Получить первый существующий отображаемый объект или не существующий.

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

Он работает, вызывая Group.create, передавая ему параметры, заданные для этого метода, и возвращая нового дочернего элемента.

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

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
exists	boolean	<optional>	true	Если true, найти первый существующий дочерний элемент; в противном случае найти первый несуществующий дочерний элемент.
createIfNull	boolean	<optional>	false	Если true и не найдены живые дочерние элементы, создается новый.
x	number	<optional>		Координата x, для сброса дочернего элемента. Значение относительно точки group.x.
y	number	<optional>		Координата y, для сброса дочернего элемента. Значение относительно точки group.y.
key	string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture	<optional>		Изображение или текстура, используемая Sprite во время отрисовки. Может быть строкой, являющейся ссылкой на запись Cache Image, или экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.
frame	string | number	<optional>		Если этот Sprite использует часть спрайт-листа или текстурного атласа, вы можете указать точный кадр, используя строку или числовой индекс.

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

DisplayObject -

Первый дочерний элемент, или null если не найден, и createIfNull было false.

Унаследовано от

• Phaser.Group#getFirstExists

Исходный код: core/Group.js (Строка 2071)

getFurthestFrom(object, callback, callbackContext) → {any}

Получить дочерний элемент, наиболее удалённый от заданного объекта, с необязательным обратным вызовом для фильтрации дочерних элементов.

Это может быть Sprite, Group, Image или любой объект с публичными свойствами x и y.

'Наиболее удалённый' определяется расстоянием от свойств объектов x и y по сравнению со свойствами childs x и y.

Вы можете использовать необязательный аргумент callback, чтобы применить собственный фильтр к проверкам расстояния.
Если дочерний элемент находится ближе, чем предыдущий, он будет отправлен в callback в качестве первого аргумента,
с расстоянием как вторым. Обратный вызов должен вернуть true, если он проходит ваши
критерии фильтрации, в противном случае он должен вернуть false.

Параметры

Имя	Тип	Аргумент	Описание
object	any		Объект, используемый для определения расстояния. Это может быть Sprite, Group, Image или любой объект со свойствами x и y.
callback	function	<optional>	Функция, с которой будет проверяться каждый дочерний элемент. Каждый дочерний элемент группы будет передан ему в качестве первого параметра, а расстояние — как второе. Он должен вернуть true, если дочерний элемент соответствует критериям.
callbackContext	object	<optional>	Контекст, в котором должна быть вызвана функция (обычно 'this').

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

any -

Дочерний элемент, наиболее удалённый от заданного объекта, или null если не было найдено дочерних элементов.

Унаследовано от

• Phaser.Group#getFurthestFrom

Исходный код: core/Group.js (Строка 2282)

getIndex(child) → {integer}

Получить индекс дочернего элемента в этой группе, который должен соответствовать свойству child's z.

Параметры

Имя	Тип	Описание
child	any	Дочерний элемент, для которого необходимо получить индекс.

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

integer -

Индекс дочернего элемента или -1, если он не является членом этой группы.

Унаследовано от

• Phaser.Group#getIndex

Исходный код: core/Group.js (Строка 1029)

getLocalBounds() → {Rectangle}

Возвращает локальные границы объекта без глобальных преобразований в виде прямоугольника. Расчёт учитывает все видимые дочерние элементы.

Возвращает

Rectangle -

Прямоугольная область

Унаследовано от

• PIXI.DisplayObjectContainer#getLocalBounds

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 437)

getRandom(startIndex, length) → {any}

Возвращает случайного потомка из группы.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
startIndex	целое число	<опционально>	0	Смещение от начала группы (самого нижнего потомка).
length	целое число	<опционально>	(до верха)	Ограничение на количество значений, которые нужно случайным образом выбрать.

Возвращает

any -

Случайный потомок этой группы.

Унаследовано от

• Phaser.Group#getRandom

Исходный код: core/Group.js (Строка 2350)

getRandomExists(startIndex, endIndex) → {any}

Возвращает случайного потомка из группы, у которого свойство exists установлено в значение true.

Можно указать начальный и конечный индексы. Например, если в этой группе 100 потомков,
и вы установите startIndex в 0 и endIndex в 50, то будет возвращен случайный потомок
только из первых 50 потомков в группе.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
startIndex	целое число	<опционально>	0	Индекс первого потомка для начала поиска.
endIndex	целое число	<опционально>		Индекс последнего потомка для поиска.

Возвращает

any -

Случайный существующий потомок этой группы.

Унаследовано от

• Phaser.Group#getRandomExists

Исходный код: core/Group.js (Строка 2372)

getTop() → {any}

Возвращает потомка вверху этой группы.

Потомок вверху – это потомок, отображаемый (рендерящийся) выше всех остальных потомков.

Возвращает

any -

Потомок вверху группы.

Унаследовано от

• Phaser.Group#getTop

Исходный код: core/Group.js (Строка 2204)

hasProperty(child, key) → {boolean}

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

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

Параметры

Имя	Тип	Описание
child	any	Потомок, у которого проверяется наличие свойства.
key	Array.<string>	Массив строк, составляющих свойство.

Возвращает

boolean -

true, если потомок обладает свойством, иначе false.

Унаследовано от

• Phaser.Group#hasProperty

Исходный код: core/Group.js (Строка 1104)

iterate(key, value, returnType, callback, callbackContext, args) → {any}

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

Потомок считается соответствующим, если у него есть свойство с именем key, значение которого равно value
в соответствии со строгим сравнением равенства.

Результат зависит от returnType:

• RETURN_TOTAL:
  Функция обратного вызова, если есть, применяется ко всем соответствующим потомкам. Возвращается количество соответствующих потомков.
• RETURN_NONE:
  Функция обратного вызова, если есть, применяется ко всем соответствующим потомкам. Значение не возвращается.
• RETURN_CHILD:
  Функция обратного вызова, если есть, применяется к первому соответствующему потомку, и возвращается первый соответствующий потомок.
  Если соответствующего потомка нет, возвращается null.

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Свойство потомка для проверки, например, 'exists', 'alive', 'health'
value	any			Потомок соответствует, если child[key] === value истинно.
returnType	integer			Способ итерации потомков и возвращаемого значения.
callback	function	<опционально>	null	Опциональная функция, которая будет вызвана для каждого соответствующего потомка. Соответствующий потомок передаётся в качестве первого аргумента.
callbackContext	object	<опционально>		Контекст, в котором должна быть вызвана функция (обычно 'this').
args	Array.<any>	<опционально>	(нет)	Аргументы, передаваемые в функцию обратного вызова; первый индекс массива (аргумент) будет заменён соответствующим потомком.

Возвращает

any -

Возвращает целое число (для RETURN_TOTAL), первого соответствующего потомка (для RETURN_CHILD) или null.

Наследуется от

• Phaser.Group#iterate

Исходный код: core/Group.js (Строка 1976)

kill() → {Phaser.Particles.Arcade.Emitter}

Вызовите эту функцию, чтобы отключить все частицы и эмиттер.

Возвращает

Phaser.Particles.Arcade.Emitter -

Экземпляр этого эмиттера.

Исходный код: particles/arcade/Emitter.js (Строка 407)

makeParticles(keys, frames, quantity, collide, collideWorldBounds) → {Phaser.Particles.Arcade.Emitter}

Эта функция генерирует новый набор частиц для использования этим эмиттером.
Частицы хранятся во внутренней очереди, ожидая выпуска через Emitter.start.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
keys	array | string			Строка или массив строк, которые будут использоваться в качестве текстуры для спрайтов частиц. Если массив, то выбирается случайный элемент.
frames	array | number	<optional>	0	Номер кадра или массив кадров, которые будет использовать спрайт. Если массив, то выбирается случайный элемент.
quantity	number	<optional>		Количество генерируемых частиц. Если не указано, используется значение Emitter.maxParticles. Если значение больше Emitter.maxParticles, используется Emitter.maxParticles.
collide	boolean	<optional>	false	Если вы хотите, чтобы частицы могли сталкиваться с другими телами аркадной физики, установите это значение в true.
collideWorldBounds	boolean	<optional>	false	Частица может автоматически сталкиваться с границами мира и отталкиваться назад в мир, если это значение установлено в true. В противном случае она покинет мир.

Возвращает

Phaser.Particles.Arcade.Emitter -

Экземпляр этого эмиттера.

Исходный код: particles/arcade/Emitter.js (Строка 335)

moveAll(group, silent) → {Phaser.Group}

Перемещает всех детей из этой группы в заданную группу.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
group	Phaser.Group			Новая группа, в которую будут перемещены дети.
silent	boolean	<optional>	false	Если true, дети не будут отправлять событие onAddedToGroup для новой группы.

Возвращает

Phaser.Group -

Группа, в которую были перемещены все дети.

Наследуется от

• Phaser.Group#moveAll

Исходный код: core/Group.js (Строка 2479)

moveDown(child) → {any}

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

Параметры

Имя	Тип	Описание
child	any	Ребенок, который должен быть перемещен вниз в группе.

Возвращает

any -

Ребенок, который был перемещен.

Наследуется от

• Phaser.Group#moveDown

Исходный код: core/Group.js (Строка 969)

moveUp(child) → {any}

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

Параметры

Имя	Тип	Описание
child	any	Ребенок, который должен быть перемещен вверх в группе.

Возвращает

any -

Ребенок, который был перемещен.

Наследуется от

• Phaser.Group#moveUp

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

multiplyAll(property, amount, checkAlive, checkVisible)

Умножает заданное свойство на значение amount для всех детей в этой группе.

Group.multiplyAll('x', 2) увеличит значение child.x для каждого ребенка в два раза.

Параметры

Имя	Тип	Описание
property	string	Свойство для умножения, например 'body.velocity.x' или 'angle'.
amount	number	Значение, на которое нужно умножить свойство. Если child.x = 10, то multiplyAll('x', 2) сделает child.x = 20.
checkAlive	boolean	Если true, свойство будет изменено только если ребенок жив.
checkVisible	boolean	Если true, свойство будет изменено только если ребенок виден.

Наследуется от

• Phaser.Group#multiplyAll

Исходный код: core/Group.js (Строка 1420)

next() → {any}

Перемещает курсор группы к следующему (более высокому) объекту в группе.

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

Возвращает

any -

Ребенок, на который теперь указывает курсор.

Наследуется от

• Phaser.Group#next

Исходный код: core/Group.js (Строка 833)

<internal> postUpdate()

Ядро postUpdate - вызывается World.

Унаследовано от

• Phaser.Group#postUpdate

Внутренний:

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

Исходный код: core/Group.js (Строка 1656)

<internal> preUpdate()

Ядро preUpdate - вызывается World.

Унаследовано от

• Phaser.Group#preUpdate

Внутренний:

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

Исходный код: core/Group.js (Строка 1611)

previous() → {any}

Перемещает курсор группы к предыдущему (нижнему) дочернему элементу в группе.

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

Возвращает

any -

Элемент, на который теперь указывает курсор.

Унаследовано от

• Phaser.Group#previous

Исходный код: core/Group.js (Строка 862)

remove(child, destroy, silent) → {boolean}

Удаляет указанный дочерний элемент из этой группы.

Это вызывает событие onRemovedFromGroup от дочернего элемента (если оно есть), и необязательно уничтожает дочерний элемент.

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

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
child	any			Дочерний элемент для удаления.
destroy	boolean	<optional>	false	Если true, будет вызвано destroy для удалённого дочернего элемента.
silent	boolean	<optional>	false	Если true, дочерний элемент не будет вызывать событие onRemovedFromGroup.

Возвращает

boolean -

true, если дочерний элемент был удалён из этой группы, в противном случае false.

Унаследовано от

• Phaser.Group#remove

Исходный код: core/Group.js (Строка 2431)

removeAll(destroy, silent, destroyTexture)

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

Дочерние элементы могут быть необязательно уничтожены при удалении.

Также можно необязательно уничтожить BaseTexture, используемую дочерним элементом. Будьте осторожны, если у вас
более одного объекта Game Object, использующих одну и ту же BaseTexture.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
destroy	boolean	<optional>	false	Если true, будет вызвано destroy для каждого удалённого дочернего элемента.
silent	boolean	<optional>	false	Если true, дочерние элементы не будут вызывать свои события onRemovedFromGroup.
destroyTexture	boolean	<optional>	false	Если true, и если аргумент destroy также true, BaseTexture, принадлежащая дочернему элементу, также уничтожается. Обратите внимание, что если другой объект Game Object использует ту же BaseTexture, она станет недействительной.

Унаследовано от

• Phaser.Group#removeAll

Исходный код: core/Group.js (Строка 2508)

removeBetween(startIndex, endIndex, destroy, silent)

Удаляет всех дочерних элементов из этой группы, индекс которых находится между заданными значениями startIndex и endIndex.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
startIndex	integer			Индекс, с которого начинать удаление дочерних элементов.
endIndex	integer	<optional>		Индекс, на котором прекратить удаление дочерних элементов. Должен быть выше, чем startIndex. Если undefined, этот метод удалит всех дочерних элементов между startIndex и концом группы.
destroy	boolean	<optional>	false	Если true, будет вызвано destroy для каждого удалённого дочернего элемента.
silent	boolean	<optional>	false	Если true, дочерние элементы не будут вызывать свои события onRemovedFromGroup.

Унаследовано от

• Phaser.Group#removeBetween

Исходный код: core/Group.js (Строка 2556)

removeChild(child) → {DisplayObject}

Удаляет дочерний элемент из контейнера.

Параметры

Имя	Тип	Описание
child	DisplayObject	Удаляемый DisplayObject

Возвращает

DisplayObject -

Удалённый дочерний элемент.

Унаследовано от

• PIXI.DisplayObjectContainer#removeChild

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 171)

removeChildAt(index) → {DisplayObject}

Удаляет дочерний элемент из контейнера по указанному индексу.

Параметры

Имя	Тип	Описание
index	Number	Индекс дочернего элемента

Возвращает

DisplayObject -

Удалённый дочерний элемент.

Inherited From

• PIXI.DisplayObjectContainer#removeChildAt

Source code: pixi/display/DisplayObjectContainer.js (Line 191)

removeChildren(beginIndex, endIndex)

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

Parameters

Name	Type	Описание
beginIndex	Number	Начальная позиция. Значение по умолчанию — 0.
endIndex	Number	Конечная позиция. Значение по умолчанию — размер контейнера.

Inherited From

• PIXI.DisplayObjectContainer#removeChildren

Source code: pixi/display/DisplayObjectContainer.js (Line 213)

removeFromHash(child) → {boolean}

Удаляет дочерний элемент из хэш-массива этой группы.
Если дочерний элемент не находится в хэше, возвращается false.

Parameters

Name	Type	Описание
child	DisplayObject	Объект отображения, который нужно удалить из хэша группы. Должен быть членом этой группы и находиться в хэше.

Returns

boolean -

True, если элемент был успешно удален из хэша, иначе false.

Inherited From

• Phaser.Group#removeFromHash

Source code: core/Group.js (Line 464)

replace(oldChild, newChild) → {any}

Заменяет дочерний элемент этой группы на новый newChild. newChild не может быть членом этой группы.

Если Group.enableBody задано, то для объекта будет создан физический объект, если таковой ещё не существует.

Если Group.inputEnableChildren задано, то для объекта будет создан обработчик ввода, если таковой ещё не существует.

Parameters

Name	Type	Описание
oldChild	any	Дочерний элемент в группе, который будет заменён.
newChild	any	Дочерний элемент для вставки в эту группу.

Returns

any -

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

Inherited From

• Phaser.Group#replace

Source code: core/Group.js (Line 1065)

resetChild(child, x, y, key, frame) → {DisplayObject}

Принимает дочерний элемент и, если аргументы x и y заданы, вызывает child.reset(x, y) для него.

Если аргументы key и необязательный аргумент frame заданы, вызывает child.loadTexture(key, frame) для него.

Два действия выполняются независимо. Например, если вы хотите только загрузить новую текстуру, передайте значения x и y как null.

Parameters

Name	Type	Argument	Описание
child	DisplayObject		Дочерний элемент, который нужно сбросить и/или загрузить текстуру.
x	number	<optional>	Координата x, до которой нужно сбросить дочерний элемент. Значение относится к точке group.x.
y	number	<optional>	Координата y, до которой нужно сбросить дочерний элемент. Значение относится к точке group.y.
key	string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture	<optional>	Это изображение или текстура, используемая Sprite во время отрисовки. Может быть строкой, которая ссылается на запись Cache Image, или экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.
frame	string | number	<optional>	Если Sprite использует часть спрайта или атласа текстур, вы можете указать точный кадр, используя строку или числовой индекс.

Returns

DisplayObject -

Сброшенный дочерний элемент; обычно Phaser.Sprite.

Inherited From

• Phaser.Group#resetChild

Source code: core/Group.js (Line 2165)

resetCursor(index) → {any}

Устанавливает курсор группы на первый дочерний элемент в группе.

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

Parameters

Name	Type	Argument	Default	Описание
index	integer	<optional>	0	Установить курсор на указанный индекс.

Returns

any -

Элемент, на который теперь указывает курсор.

Inherited From

• Phaser.Group#resetCursor

Source code: core/Group.js (Line 806)

reverse()

Инвертирует порядок всех дочерних элементов в группе.

Это действие применяется только к непосредственным дочерним элементам и не распространяется на подгруппы.

Inherited From

• Phaser.Group#reverse

Source code: core/Group.js (Line 1015)

revive() → {Phaser.Particles.Arcade.Emitter}

Полезно для возвращения игровых объектов к "жизни". Просто устанавливает alive и exists в значение true.

Returns

Phaser.Particles.Arcade.Emitter -

Этот экземпляр эмиттера.

Исходный код: particles/arcade/Emitter.js (Строка 423)

sendToBack(child) → {any}

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

Параметры

Имя	Тип	Описание
child	any	Дочерний элемент, который нужно переместить в низ группы.

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

any -

Дочерний элемент, который был перемещён.

Унаследовано от

• Phaser.Group#sendToBack

Исходный код: core/Group.js (Строка 926)

set(child, key, value, checkAlive, checkVisible, operation, force) → {boolean}

Быстро устанавливает свойство одиночного дочернего элемента этой группы в новое значение.

Параметр operation управляет способом назначения нового значения свойству, от простого замещения до сложения и умножения.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
child	Phaser.Sprite			Дочерний элемент, для которого нужно установить свойство.
key	string			Свойство в виде строки, которое нужно установить. Например: 'body.velocity.x'
value	any			Значение, которое будет установлено.
checkAlive	boolean	<optional>	false	Если установлено, то дочерний элемент будет обновлён только если alive=true.
checkVisible	boolean	<optional>	false	Если установлено, то дочерний элемент будет обновлён только если visible=true.
operation	integer	<optional>	0	Управляет тем, как назначается значение. Значение 0 заменяет значение новым, 1 – добавляет, 2 – вычитает, 3 – умножает, 4 – делит.
force	boolean	<optional>	false	Если force равно true, то свойство будет установлено для дочернего элемента независимо от того, существует ли оно уже или нет. Если false, и свойство не существует, ничего не будет установлено.

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

boolean -

True, если свойство было установлено, false – если нет.

Унаследовано от

• Phaser.Group#set

Исходный код: core/Group.js (Строка 1246)

setAll(key, value, checkAlive, checkVisible, operation, force)

Быстро устанавливает одно и то же свойство для всех дочерних элементов этой группы в новое значение.

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

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string			Свойство в виде строки, которое нужно установить. Например: 'body.velocity.x'
value	any			Значение, которое будет установлено.
checkAlive	boolean	<optional>	false	Если установлено, то обновляются только дочерние элементы с alive=true. Это включает любые группы, являющиеся дочерними элементами.
checkVisible	boolean	<optional>	false	Если установлено, то обновляются только дочерние элементы с visible=true. Это включает любые группы, являющиеся дочерними элементами.
operation	integer	<optional>	0	Управляет тем, как назначается значение. Значение 0 заменяет значение новым, 1 – добавляет, 2 – вычитает, 3 – умножает, 4 – делит.
force	boolean	<optional>	false	Если force равно true, то свойство будет установлено для дочернего элемента независимо от того, существует ли оно уже или нет. Если false, и свойство не существует, ничего не будет установлено.

Унаследовано от

• Phaser.Group#setAll

Исходный код: core/Group.js (Строка 1277)

setAllChildren(key, value, checkAlive, checkVisible, operation, force)

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

Если эта группа содержит другие группы, то то же свойство устанавливается для их дочерних элементов также, итеративно, до тех пор пока не достигнет нижнего уровня.
В отличие от setAll, свойство НЕ устанавливается для самих групп-потомков.

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

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
key	string			Свойство, задаваемое в виде строки. Например: 'body.velocity.x'
value	any			Значение, которое будет установлено.
checkAlive	boolean	<optional>	false	Если установлено, то будут обновляться только дочерние элементы с alive=true. Это включает любые группы, являющиеся дочерними.
checkVisible	boolean	<optional>	false	Если установлено, то будут обновляться только дочерние элементы с visible=true. Это включает любые группы, являющиеся дочерними.
operation	integer	<optional>	0	Определяет способ присвоения значения. Значение 0 заменяет значение новым. Значение 1 добавляет его, 2 вычитает его, 3 умножает его, а 4 делит его.
force	boolean	<optional>	false	Если force равно true, то свойство будет установлено для дочернего элемента независимо от того, существует ли оно уже или нет. Если false, и свойство не существует, то ничего не будет установлено.

Унаследовано от

• Phaser.Group#setAllChildren

Исходный код: core/Group.js (Строка 1312)

setAlpha(min, max, rate, ease, yoyo) → {Phaser.Particles.Arcade.Emitter}

Более компактный способ установки ограничений альфа-канала частиц.
Параметр rate, если установлен со значением выше нуля, позволяет задать скорость, с которой частицы изменяют альфа-канал от min до max.
Если rate равен нулю, что является значением по умолчанию, частица не будет изменять альфа-канал — вместо этого она выберет случайный альфа-канал между min и max при создании.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
min	number	<optional>	1	Минимальное значение для этого диапазона.
max	number	<optional>	1	Максимальное значение для этого диапазона.
rate	number	<optional>	0	Скорость (в мс), с которой частицы будут изменять альфа-канал от min до max, или установите нуль, чтобы выбрать случайный альфа-канал между двумя значениями.
ease	function	<optional>	Phaser.Easing.Linear.None	Если вы установили rate > 0, это формула сглаживания, применяемая между значениями min и max.
yoyo	boolean	<optional>	false	Если вы установили rate > 0, вы можете задать, будет ли сглаживание возвращаться к исходным значениям (т.е. колебаться).

Возвращает

Phaser.Particles.Arcade.Emitter -

Этот экземпляр излучателя.

Исходный код: particles/arcade/Emitter.js (Строка 769)

setChildIndex(child, index)

Изменяет положение существующего дочернего элемента в контейнере отображения.

Параметры

Имя	Тип	Описание
child	DisplayObject	Экземпляр дочернего элемента DisplayObject, для которого нужно изменить номер индекса.
index	Number	Результирующий номер индекса для дочернего элемента отображения.

Унаследовано от

• PIXI.DisplayObjectContainer#setChildIndex

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 132)

setProperty(child, key, value, operation, force) → {boolean}

Устанавливает свойство для данного значения на дочерний элемент. Параметр operation определяет, как устанавливается значение.

Операции:

• 0: устанавливает существующее значение на заданное значение; если force равно true, новое свойство будет создано при необходимости
• 1: добавляет заданное значение к уже существующему значению.
• 2: вычитает заданное значение из уже существующего значения.
• 3: умножает уже существующее значение на заданное значение.
• 4: делит уже существующее значение на заданное значение.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
child	any			Дочерний элемент, для которого нужно установить значение свойства.
key	array			Массив строк, составляющих свойство, которое будет установлено.
value	any			Значение, которое будет установлено.
operation	integer	<optional>	0	Определяет способ присвоения значения. Значение 0 заменяет значение новым. Значение 1 добавляет его, 2 вычитает его, 3 умножает его, а 4 делит его.
force	boolean	<optional>	false	Если force равно true, то свойство будет установлено для дочернего элемента независимо от того, существует ли оно уже или нет. Если false, и свойство не существует, то ничего не будет установлено.

Возвращает

boolean -

True, если свойство было установлено, false — если нет.

Унаследовано от

• Phaser.Group#setProperty

Исходный код: core/Group.js (Строка 1139)

setRotation(min, max) → {Phaser.Particles.Arcade.Emitter}

Более компактный способ установки ограничений угловой скорости частиц.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
min	number	<optional>	0	Минимальное значение для этого диапазона.
max	number	<optional>	0	Максимальное значение для этого диапазона.

Возвращает

Phaser.Particles.Arcade.Emitter -

Этот экземпляр Emitter.

Исходный код: particles/arcade/Emitter.js (Строка 749)

setScale(minX, maxX, minY, maxY, rate, ease, yoyo) → {Phaser.Particles.Arcade.Emitter}

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
minX	number	<optional>	1	Минимальное значение Particle.scale.x.
maxX	number	<optional>	1	Максимальное значение Particle.scale.x.
minY	number	<optional>	1	Минимальное значение Particle.scale.y.
maxY	number	<optional>	1	Максимальное значение Particle.scale.y.
rate	number	<optional>	0	Скорость (в мс), с которой частицы будут изменять масштаб от min до max, или установить ноль, чтобы выбрать случайный размер между двумя.
ease	function	<optional>	Phaser.Easing.Linear.None	Если вы установили rate > 0, это формула плавного изменения, применяемая между значениями min и max.
yoyo	boolean	<optional>	false	Если вы установили rate > 0, можно установить, будет ли плавное изменение повторяться (т.е. вернется к исходным значениям).

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

Phaser.Particles.Arcade.Emitter -

Этот экземпляр Emitter.

Исходный код: particles/arcade/Emitter.js (Строка 811)

setSize(width, height) → {Phaser.Particles.Arcade.Emitter}

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

Параметры

Имя	Тип	Описание
width	number	Желаемая ширина эмиттера (частицы генерируются случайным образом в этих размерах).
height	number	Желаемая высота эмиттера.

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

Phaser.Particles.Arcade.Emitter -

Этот экземпляр Emitter.

Исходный код: particles/arcade/Emitter.js (Строка 694)

setXSpeed(min, max) → {Phaser.Particles.Arcade.Emitter}

Более компактный способ установки диапазона скорости по оси X эмиттера.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
min	number	<optional>	0	Минимальное значение для этого диапазона.
max	number	<optional>	0	Максимальное значение для этого диапазона.

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

Phaser.Particles.Arcade.Emitter -

Этот экземпляр Emitter.

Исходный код: particles/arcade/Emitter.js (Строка 711)

setYSpeed(min, max) → {Phaser.Particles.Arcade.Emitter}

Более компактный способ установки диапазона скорости по оси Y эмиттера.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
min	number	<optional>	0	Минимальное значение для этого диапазона.
max	number	<optional>	0	Максимальное значение для этого диапазона.

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

Phaser.Particles.Arcade.Emitter -

Этот экземпляр Emitter.

Исходный код: particles/arcade/Emitter.js (Строка 730)

sort(key, order)

Сортировка дочерних элементов группы по определенному ключу и порядку.

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

Например, чтобы отсортировать Sprites по глубине для игры в стиле Zelda, вы можете вызвать это в нижней части вашего цикла обновления.

Внутри используется стандартный JavaScript метод sort, поэтому все, что к нему относится, также относится и сюда, включая сортировку по алфавиту, смешение строк и чисел, и сортировку Unicode. Смотрите MDN для получения дополнительной информации.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	string	<optional>	'z'	Имя свойства для сортировки. По умолчанию используется значение z-глубины объектов.
order	integer	<optional>	Phaser.Group.SORT_ASCENDING	Порядок по возрастанию (SORT_ASCENDING) или убыванию (SORT_DESCENDING).

Унаследовано от

• Phaser.Group#sort

Исходный код: core/Group.js (Строка 1855)

start(explode, lifespan, frequency, quantity, forceQuantity) → {Phaser.Particles.Arcade.Emitter}

Вызовите эту функцию, чтобы начать излучение частиц.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
explode	boolean	<optional>	true	Указывают ли частицы на одновременный взрыв (true) или с заданной частотой (false).
lifespan	number	<optional>	0	Сколько времени живёт каждая частица после излучения в мс. 0 = навсегда.
frequency	number	<optional>	250	Игнорируется, если Explode установлен в true. Частота — это частота излучения 1 частицы. Значение задаётся в мс.
quantity	number	<optional>	0	Сколько частиц запустить. 0 = "все частицы", которые будут продолжать излучаться, пока не будет достигнуто Emitter.maxParticles.
forceQuantity	number	<optional>	false	Если true и создание потока частиц, количество излучаемых частиц будет принудительно установлено в заданное в этом вызове значение. Это значение никогда не может превышать Emitter.maxParticles.

Возвращает

Phaser.Particles.Arcade.Emitter -

Экземпляр этого Emitter.

Исходный код: particles/arcade/Emitter.js (Строка 503)

subAll(property, amount, checkAlive, checkVisible)

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

Group.subAll('x', 10) будет вычитать 10 из значения child.x для каждого дочернего элемента.

Параметры

Имя	Тип	Описание
property	string	Свойство для декремента, например 'body.velocity.x' или 'angle'.
amount	number	Количество для вычитания из свойства. Если child.x = 50, то subAll('x', 40) сделает child.x = 10.
checkAlive	boolean	Если true, свойство будет изменено только если дочерний элемент жив.
checkVisible	boolean	Если true, свойство будет изменено только если дочерний элемент видимый.

Унаследовано от

• Phaser.Group#subAll

Исходный код: core/Group.js (Строка 1403)

swap(child1, child2)

Меняет местами позиции двух дочерних элементов в этой группе.

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

Параметры

Имя	Тип	Описание
child1	any	Первый дочерний элемент для обмена.
child2	any	Второй дочерний элемент для обмена.

Унаследовано от

• Phaser.Group#swap

Исходный код: core/Group.js (Строка 891)

swapChildren(child, child2)

Меняет местами позиции 2 объектов отображения внутри этого контейнера.

Параметры

Имя	Тип	Описание
child	DisplayObject	-
child2	DisplayObject	-

Унаследовано от

• PIXI.DisplayObjectContainer#swapChildren

Исходный код: pixi/display/DisplayObjectContainer.js (Строка 85)

update()

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

Исходный код: particles/arcade/Emitter.js (Строка 266)

<internal> updateZ()

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

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

Унаследовано от

• Phaser.Group#updateZ

Внутреннее:

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

Исходный код: core/Group.js (Строка 663)

xy(index, x, y)

Позиционирует дочерний элемент, найденный по заданному индексу в этой группе, в заданные координаты x и y.

Параметры

Имя	Тип	Описание
index	integer	Индекс дочернего элемента в группе для установки положения.
x	number	Новая позиция x дочернего элемента.
y	number	Новая позиция y дочернего элемента.

Унаследовано от

• Phaser.Group#xy

Исходный код: core/Group.js (Строка 993)