Класс: Phaser.Physics.P2.BodyDebug

Конструктор

new BodyDebug(game, body, settings)

Параметры

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

Расширяет

• Phaser.Group

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

alive : boolean

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

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

• Phaser.Group#alive

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

• true

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

alpha : number

Значение alpha контейнера группы.

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

• Phaser.Group#alpha

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

angle : number

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

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

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

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

• Phaser.Group#angle

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

body : Phaser.Physics.P2.Body

Физический объект P2 Body для отображения отладочных данных.

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

bottom : number

Координата нижней части этой группы.

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

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

• Phaser.Group#bottom

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

cameraOffset : Phaser.Point

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

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

• Phaser.Group#cameraOffset

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

canvas : Phaser.Graphics

Поверхность холста для рендеринга отладочной информации.

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

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.

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

• Phaser.Group#cursorIndex

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

enableBody : boolean

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

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

Тип тела по умолчанию контролируется с помощью physicsBodyType.

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

• Phaser.Group#enableBody

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

enableBodyDebug : boolean

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

Это работает только для объектов P2.

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

• Phaser.Group#enableBodyDebug

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

exists : boolean

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

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

• Phaser.Group#exists

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

• true

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

fixedToCamera : boolean

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

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

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

• Phaser.Group#fixedToCamera

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

<internal> game : Phaser.Game

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

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

• Phaser.Group#game

Внутреннее:

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

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

hash :array

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

В хеш могут быть добавлены только дочерние элементы этой группы.

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

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

• Phaser.Group#hash

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

height : number

Высота displayObjectContainer, установка этого значения фактически изменит масштаб для достижения заданного значения

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

• PIXI.DisplayObjectContainer#height

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

ignoreChildInput : boolean

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

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

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

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

• PIXI.DisplayObjectContainer#ignoreChildInput

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

ignoreDestroy : boolean

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

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

• Phaser.Group#ignoreDestroy

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

inputEnableChildren : boolean

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

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

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

• Phaser.Group#inputEnableChildren

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

left : number

Координата слева этой группы.

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

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

• Phaser.Group#left

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

[readonly] length : integer

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

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

• Phaser.Group#length

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

name : string

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

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

• Phaser.Group#name

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

onChildInputDown : Phaser.Signal

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

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

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

• Phaser.Group#onChildInputDown

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

onChildInputOut : Phaser.Signal

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

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

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

• Phaser.Group#onChildInputOut

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

onChildInputOver : Phaser.Signal

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

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

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

• 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)

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

Если эта группа содержит спрайты с физикой 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

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

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

• Phaser.Group#physicsType

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

ppu : number

Пиксели на единицу длины.

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

right : number

Правая координата этой группы.

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

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

• Phaser.Group#right

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

rotation : number

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

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

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

• Phaser.Group#rotation

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

top : number

Верхняя координата этой группы.

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

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

• Phaser.Group#top

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

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

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

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

• Phaser.Group#total

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

<внутреннее> type : integer

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

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

• Phaser.Group#type

Внутреннее:

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

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

visible : boolean

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

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

• Phaser.Group#visible

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

width : number

Ширина displayObjectContainer. Изменение этого значения фактически изменяет масштаб для достижения заданного значения

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

• PIXI.DisplayObjectContainer#width

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

x : number

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

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

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

• Phaser.Group#x

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

y : number

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

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

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

• Phaser.Group#y

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

[только для чтения] z : целое число

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

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

• Phaser.Group#z

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

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

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

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

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

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

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

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

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

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

Parameters

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

Returns

DisplayObject -

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

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

• Phaser.Group#add

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

addAll(property, amount, checkAlive, checkVisible)

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

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

Parameters

Имя	Тип	Описание
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 установлено, то обработчик ввода будет создан для объекта, если он еще не существует.

Parameters

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

Returns

DisplayObject -

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

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

• Phaser.Group#addAt

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

addChild(child) → {DisplayObject}

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

Parameters

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

Returns

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#addChild

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

addChildAt(child, index) → {DisplayObject}

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

Parameters

Имя	Тип	Описание
child	DisplayObject	Дочерний элемент для добавления
index	Number	Индекс для размещения дочернего элемента

Returns

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#addChildAt

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

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

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

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

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

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

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

Parameters

Имя	Тип	Аргумент	По умолчанию	Описание
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
имеют это.

Размеры сетки определяются первыми четырьмя аргументами. Аргументы 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 для выравнивания групп внутри
мировых и камерных границ. Или это могут быть другие спрайты, изображения, текстовые объекты, BitmapText,
TileSprites или кнопки.

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

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

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)

bringToTop(child) → {any}

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

Параметры

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

Возвращает

any -

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

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

• Phaser.Group#bringToTop

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

callAll(method, context, args)

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

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

Параметры

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

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

• Phaser.Group#callAll

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

callAllExists(callback, existsValue, parameter)

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

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

Параметры

Имя	Тип	Аргумент	Описание
callback	string		Имя функции, которую нужно вызвать у дочерних элементов.
existsValue	boolean		Будут вызываться только дочерние элементы с exists=existsValue.
parameter	any	<repeatable>	Дополнительные параметры, которые будут переданы в обратный вызов.

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

• Phaser.Group#callAllExists

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

<internal> callbackFromArray(child, callback, length)

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

Параметры

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

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

• Phaser.Group#callbackFromArray

Внутренний:

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

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

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

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

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
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.

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

• Phaser.Group#checkAll

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

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

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

Параметры

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

Возвращает

boolean -

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

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

• Phaser.Group#checkProperty

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

contains(child) → {Boolean}

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

Параметры

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

Возвращает

Boolean -

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

• PIXI.DisplayObjectContainer#contains

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

countDead() → {integer}

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

Возвращает

целое число -

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

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

• 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	Состояние exists по умолчанию для 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 ключа (ball и carrot), что означает, что всего будет создано 50 спрайтов, 25 каждого. Вы также можете задать frame как массив:

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

В примере есть один ключ (bricks), который представляет собой спрайт-лист. Массив кадров сообщает этому методу использовать кадры 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	Если изображение Sprite содержит несколько кадров, вы можете указать, какой использовать здесь. Или массив кадров. См. описание для получения подробностей о том, как применяется количество, когда используются массивы.
exists	логическое значение	<необязательно>	false	Состояние exists по умолчанию для Sprite.

Возвращает

массив -

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

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

• 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)

<internal> descendingSortHandler(a, b)

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

Параметры

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

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

• Phaser.Group#descendingSortHandler

Внутреннее:

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

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

destroy(destroyChildren, soft)

Уничтожает эту группу.

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
destroyChildren	boolean	<optional>	true	Если true, то destroy будет вызвано для каждого удалённого потомка.
soft	boolean	<optional>	false	«Мягкое уничтожение» (установлено в true) не удаляет эту группу из родителя или не обнуляет ссылку на игру. Установлено в false — удаляет и обнуляет.

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

• Phaser.Group#destroy

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

divideAll(property, amount, checkAlive, checkVisible)

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

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

Параметры

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

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

• Phaser.Group#divideAll

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

draw()

Отображает фигуры P2 на объекте Graphics.

Исходный код: physics/p2/BodyDebug.js (Строка 85)

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)

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	функция			Функция, которая будет вызвана для каждого соответствующего дочернего элемента. Ребёнок будет передан в качестве первого аргумента.
callbackContext	объект			Контекст, в котором функция должна быть вызвана (обычно 'this').
args	любой	<необязательно> <повторяется>	(нет)	Дополнительные аргументы для передачи функции обратного вызова после элемента дочернего элемента.

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

• 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) → {any}

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

Вы можете необязательно указать критерии сопоставления, используя аргументы 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 | integer}

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

Параметры

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

Возвращает

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

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

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

• Phaser.Group#getAt

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

getBottom() → {any}

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

Нижний дочерний элемент - это дочерний элемент, отображаемый (отрисовываемый) ниже всех остальных дочерних элементов.

Возвращает

любой -

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

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

• Phaser.Group#getBottom

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

getBounds(targetCoordinateSpace) → {Rectangle}

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

Параметры

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

Возвращает

Rectangle -

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

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

• PIXI.DisplayObjectContainer#getBounds

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

getByName(name) → {any}

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

Параметры

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

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

any -

Первый потомок с соответствующим именем или null, если таковых не найдено.

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

• Phaser.Group#getByName

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

getChildAt(index) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#getChildAt

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

getChildIndex(child) → {Number}

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

Параметры

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

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

Number -

Индекс найденного потомка

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

• PIXI.DisplayObjectContainer#getChildIndex

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

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

Находит самого близкого потомка к заданному объекту с возможностью фильтрации потомков.

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

«Близость» определяется расстоянием между свойствами объектов x и y и свойствами потомков 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#getClosestTo

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

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

Получить первого живого потомка (child.alive === true).

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

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

Работает, вызывая 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 при отрисовке. Может быть строкой, ссылающейся на запись в кэше изображения, или экземпляром 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>		Это изображение или текстура, используемые спрайтом во время отрисовки. Это может быть строка, являющаяся ссылкой на запись Cache Image, или экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
frame	string | number	<optional>		Если этот спрайт использует часть спрайт-листа или атласа текстур, вы можете указать точный кадр, используя строку или числовой индекс.

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

DisplayObject -

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

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

• 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>		Это изображение или текстура, используемые спрайтом во время отрисовки. Это может быть строка, являющаяся ссылкой на запись Cache Image, или экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
frame	string | number	<optional>		Если этот спрайт использует часть спрайт-листа или атласа текстур, вы можете указать точный кадр, используя строку или числовой индекс.

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

DisplayObject -

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

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

• Phaser.Group#getFirstExists

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

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

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

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

'Наиболее удаленный' определяется расстоянием от свойств объектов x и y по сравнению со свойствами 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) → {целое}

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

Параметры

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

Возвращает

целое -

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

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

• Phaser.Group#getIndex

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

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

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

Возвращает

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

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

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

• PIXI.DisplayObjectContainer#getLocalBounds

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

getRandom(startIndex, length) → {любой}

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

Параметры

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

Возвращает

любой -

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

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

• Phaser.Group#getRandom

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

getRandomExists(startIndex, endIndex) → {любой}

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

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

Параметры

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

Возвращает

любой -

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

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

• Phaser.Group#getRandomExists

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

getTop() → {любой}

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

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

Возвращает

любой -

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

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

• Phaser.Group#getTop

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

hasProperty(child, key) → {boolean}

Проверяет, имеет ли дочерний элемент данное свойство.

Будет сканировать до 4 уровней вглубь только.

Параметры

Имя	Тип	Описание
child	любой	Дочерний элемент, для которого нужно проверить существование свойства.
key	Array.<string>	Массив строк, образующих свойство.

Возвращает

boolean -

True, если дочерний элемент имеет свойство, иначе false.

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

• Phaser.Group#hasProperty

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

iterate(key, value, returnType, callback, callbackContext, args) → {любой}

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

Дочерний элемент считается совпадающим, когда у него есть свойство, названное 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	<optional>	null	Необязательная функция, которая будет вызываться для каждого соответствующего дочернего элемента. Соответствующий дочерний элемент передаётся в качестве первого аргумента.
callbackContext	object	<optional>		Контекст, в котором должна быть вызвана функция (обычно 'this').
args	Array.<any>	<optional>	(none)	Аргументы, передаваемые в обратный вызов; первый индекс массива (аргумент) будет заменён на соответствующий дочерний элемент.

Возвращает

any -

Возвращает либо целое число (для RETURN_TOTAL), первый соответствующий дочерний элемент (для RETURN_CHILD) или null.

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

• Phaser.Group#iterate

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

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

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

Параметры

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

Возвращает

Phaser.Group -

Group, в который были перемещены все дочерние элементы.

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

• Phaser.Group#moveAll

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

moveDown(child) → {any}

Перемещает заданный дочерний элемент вниз на одну позицию в этом Group, если он ещё не находится внизу.

Параметры

Имя	Тип	Описание
child	any	Дочерний элемент для перемещения вниз в группе.

Возвращает

any -

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

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

• Phaser.Group#moveDown

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

moveUp(child) → {any}

Перемещает заданный дочерний элемент вверх на одну позицию в этом Group, если он ещё не находится вверху.

Параметры

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

Возвращает

any -

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

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

• Phaser.Group#moveUp

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

multiplyAll(property, amount, checkAlive, checkVisible)

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

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()

Основной постобновление - вызываемый World.

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

• Phaser.Group#postUpdate

Внутреннее:

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

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

<internal> 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, которую использует дочерний элемент. Будьте внимательны, если у вас есть несколько объектов игры, использующих одну и ту же BaseTexture.

Параметры

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

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

• Phaser.Group#removeAll

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

removeBetween(startIndex, endIndex, destroy, silent)

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

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
startIndex	integer			Индекс, с которого начинать удаление дочерних элементов.
endIndex	integer	<optional>		Индекс, до которого останавливать удаление дочерних элементов. Должен быть больше, чем startIndex. Если не определено, этот метод удалит все дочерние элементы между 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 -

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

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

• PIXI.DisplayObjectContainer#removeChildAt

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

removeChildren(beginIndex, endIndex)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#removeChildren

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

removeFromHash(child) → {boolean}

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

Параметры

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

Возвращает

boolean -

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

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

• Phaser.Group#removeFromHash

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

replace(oldChild, newChild) → {any}

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

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

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

Параметры

Имя	Тип	Описание
oldChild	any	Потомок в этом наборе, который будет заменён.
newChild	any	Потомок, который будет добавлен в этот набор.

Возвращает

any -

Возвращает старый элемент oldChild, который был заменён в этом наборе.

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

• Phaser.Group#replace

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

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

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

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

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

Параметры

Имя	Тип	Аргумент	Описание
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 при отрисовке. Может быть строкой, являющейся ссылкой на запись в кэш изображения, или экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.
frame	string | number	<optional>	Если этот Sprite использует часть спрайта или атласа текстур, можно указать точный кадр, используя строку или числовой индекс.

Возвращает

DisplayObject -

Потомок, который был перезагружен: обычно Phaser.Sprite.

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

• Phaser.Group#resetChild

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

resetCursor(index) → {any}

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

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
index	integer	<optional>	0	Установить курсор на указанный индекс.

Возвращает

any -

Потомок, на котором теперь находится курсор.

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

• Phaser.Group#resetCursor

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

reverse()

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

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

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

• Phaser.Group#reverse

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

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)

setChildIndex(child, index)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#setChildIndex

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

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

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

Доступные операции:

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

Parameters

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

Returns

boolean -

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

Inherited From

• Phaser.Group#setProperty

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

sort(key, order)

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

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

Например, для сортировки по глубине спрайтов в игре в стиле Zelda вы можете вызвать group.sort('y', Phaser.Group.SORT_ASCENDING) в нижней части вашего State.update().

Внутренне используется стандартная JavaScript-функция сортировки массива, поэтому всё, что к ней применяется, применимо и здесь, включая сортировку по алфавиту, смешение строк и чисел, а также сортировку Юникода. Подробнее см. на MDN.

Parameters

Name	Type	Argument	Default	Description
key	string	<optional>	'z'	Имя свойства для сортировки. По умолчанию — значение z-глубины объектов.
order	integer	<optional>	Phaser.Group.SORT_ASCENDING	Порядок: возрастающий (SORT_ASCENDING) или убывающий (SORT_DESCENDING).

Inherited From

• Phaser.Group#sort

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

subAll(property, amount, checkAlive, checkVisible)

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

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

Parameters

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

Inherited From

• Phaser.Group#subAll

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

swap(child1, child2)

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

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

Parameters

Name	Type	Description
child1	any	Первый дочерний элемент для обмена.
child2	any	Второй дочерний элемент для обмена.

Inherited From

• Phaser.Group#swap

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

swapChildren(child, child2)

Меняет местами позиции 2 элементов отображения внутри этого контейнера.

Parameters

Name	Type	Description
child	DisplayObject	-
child2	DisplayObject	-

Inherited From

• PIXI.DisplayObjectContainer#swapChildren

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

<internal> update()

Основное обновление — как вызывается World.

Inherited From

• Phaser.Group#update

Внутреннее:

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

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

updateSpriteTransform()

Основное обновление.

Source code: physics/p2/BodyDebug.js (Line 72)

<internal> updateZ()

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

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

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

• Phaser.Group#updateZ

Внутреннее:

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

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

xy(index, x, y)

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

Параметры

Имя	Тип	Описание
index	целое число	Индекс дочернего элемента в группе, для которого нужно установить позицию.
x	число	Новая позиция x дочернего элемента.
y	число	Новая позиция y дочернего элемента.

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

• Phaser.Group#xy

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