Класс: Phaser.Group

Конструктор

new Group(game, parent, name, addToStage, enableBody, physicsBodyType)

Параметры

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

Расширяет

• PIXI.DisplayObjectContainer

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

[static] RETURN_ALL : integer

Значение returnType, как указано в iterate, например.

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

[static] RETURN_CHILD : integer

Значение returnType, как указано в iterate, например.

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

[static] RETURN_NONE : integer

Значение returnType, как указано в iterate, например.

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

[static] RETURN_TOTAL : integer

Значение returnType, как указано в iterate, например.

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

[static] SORT_ASCENDING : integer

Значение порядка сортировки, как указано в sort, например.

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

[static] SORT_DESCENDING : integer

Значение порядка сортировки, как указано в sort, например.

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

alive : boolean

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

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

• true

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

alpha : number

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

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

angle : number

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

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

Это не влияет на свойства rotation/angle дочерних элементов, но обновит их worldTransform
и ориентацию и положение на экране.

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

bottom : number

Координата bottom этой группы.

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

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

cameraOffset : Phaser.Point

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

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

centerX : number

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

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

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

centerY : number

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

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

Исходный код: 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.Sprite

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

cursor : DisplayObject

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

Курсор — это способ итерирования по дочерним элементам в группе с помощью next и previous.

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

[readonly] cursorIndex : integer

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

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

enableBody : boolean

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

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

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

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

enableBodyDebug : boolean

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

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

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

exists : boolean

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

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

• true

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

fixedToCamera : boolean

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

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

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

<internal> game : Phaser.Game

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

Внутреннее:

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

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

hash :array

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

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

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

Исходный код: 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.

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

inputEnableChildren : boolean

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

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

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

left : number

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

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

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

[readonly] length : integer

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

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

name : string

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

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

onChildInputDown : Phaser.Signal

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

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

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

onChildInputOut : Phaser.Signal

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

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

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

onChildInputOver : Phaser.Signal

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

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

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

onChildInputUp : Phaser.Signal

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

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

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

onDestroy : Phaser.Signal

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

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

pendingDestroy : boolean

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

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

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

physicsBodyType : целое число

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

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

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

physicsSortDirection : целое число

Если в этой группе содержатся 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. Это поведение по умолчанию.

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

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

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

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

right : число

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

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

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

rotation : число

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

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

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

top : число

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

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

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

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

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

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

<внутреннее> type : целое число

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

Внутреннее:

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

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

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

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

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

width : число

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

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

• PIXI.DisplayObjectContainer#width

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

x : число

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

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

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

y : число

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

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

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

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

Значение 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 -

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

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

addAll(property, amount, checkAlive, checkVisible)

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

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, свойство будет изменено только если дочерний элемент видим.

Исходный код: 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 -

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

Исходный код: 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}

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

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

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

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

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

Parameters

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

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

Array.<DisplayObject> | Phaser.Group -

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

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

addToHash(child) → {boolean}

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

Параметры

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

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

boolean -

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

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

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

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

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

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

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

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

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

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

Вы можете установить либо значение width, либо height равным -1. Это укажет методу
продолжить выравнивание дочерних элементов, пока они не закончатся. Например, если у этого объекта Group
было 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	Необязательный индекс, с которого следует начать выравнивание. По умолчанию ноль (первый дочерний элемент в объекте Group), но может быть установлен на любое допустимое значение индекса дочернего элемента.

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

boolean -

True, если дочерние элементы объекта Group были выровнены, иначе false.

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

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

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

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

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

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

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.

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

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

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 -

Эта группа.

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

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

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

Родитель должен быть объектом игры или объектом Phaser.Rectangle. Это может включать свойства, такие как World.bounds или Camera.view, для выравнивания групп внутри границ мира и камеры. Или он может включать другие Sprites, Images, Text-объекты, 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 -

Эта группа.

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

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

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

Параметры

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

Внутренний:

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

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

bringToTop(child) → {any}

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

Параметры

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

Возвращает

any -

Перемещённый дочерний элемент.

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

callAll(method, context, args)

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

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

Параметры

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

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

callAllExists(callback, existsValue, parameter)

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

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

Параметры

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

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

<internal> callbackFromArray(child, callback, length)

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

Параметры

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

Внутреннее:

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

Исходный код: 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.

Исходный код: 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, если нет.

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

contains(child) → {Boolean}

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

Параметры

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

Возвращает

Boolean -

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

• PIXI.DisplayObjectContainer#contains

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

countDead() → {integer}

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

Возвращает

integer -

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

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

countLiving() → {integer}

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

Возвращает

integer -

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

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

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

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

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

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

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

Если 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 не был изменён.

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

createMultiple(quantity, key, frame, exists) → {array}

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

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

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

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

Например:

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

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

массив -

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

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

customSort(sortHandler, context)

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

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

Параметры

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

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

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

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

Параметры

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

Внутренний:

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

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

destroy(destroyChildren, soft)

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

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

Параметры

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

Исходный код: 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, свойство будет изменено только если дочерний элемент видим.

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

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

Исходный код: 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)	Дополнительные аргументы для передачи в функцию обратного вызова после элемента дочернего элемента.

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

forEachAlive(callback, callbackContext, args)

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

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

Параметры

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

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

forEachDead(callback, callbackContext, args)

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

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

Параметры

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

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

forEachExists(callback, callbackContext, args)

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

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

Параметры

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

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

getAll(свойство, значение, начальныйИндекс, конечныйИндекс) → {любой тип}

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

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

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

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

Параметры

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

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

любой тип -

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

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

getAt(индекс) → {DisplayObject | целое число}

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

Параметры

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

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

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

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

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

getBottom() → {любой тип}

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

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

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

любой тип -

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

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

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

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

Параметры

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

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

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

Прямоугольная область, ограничивающая фигуру.

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

• PIXI.DisplayObjectContainer#getBounds

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

getByName(имя) → {любой тип}

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

Параметры

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

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

любой тип -

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

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

getChildAt(индекс) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#getChildAt

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

getChildIndex(дочерний элемент) → {Число}

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

Параметры

Имя	Тип	Описание
child	DisplayObject	Экземпляр DisplayObject для идентификации.

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

Число -

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

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

• 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, если потомок не найден.

Исходный код: 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.

Исходный код: 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.

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

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

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

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

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

DisplayObject -

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

Исходный код: 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, если потомок не был найден.

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

getIndex(child) → {integer}

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

Параметры

Имя	Тип	Описание
child	any	Потомок, для которого нужно получить индекс.

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

integer -

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

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

getLocalBounds() → {Rectangle}

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

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

Rectangle -

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

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

• PIXI.DisplayObjectContainer#getLocalBounds

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

getRandom(startIndex, length) → {any}

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

Параметры

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

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

any -

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

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

getRandomExists(startIndex, endIndex) → {any}

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

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

Параметры

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

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

любое -

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

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

getTop() → {любое}

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

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

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

любое -

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

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

hasProperty(child, key) → {boolean}

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

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

Параметры

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

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

boolean -

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

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

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

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

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

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

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

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	строка			Свойство дочернего элемента для проверки, например, 'exists', 'alive', 'health'
value	любое			Дочерний элемент соответствует, если child[key] === value равно true.
returnType	целое число			Как итерировать дочерние элементы и что возвращать.
callback	функция	<необязательно>	null	Необязательная функция, которая будет вызываться для каждого совпадающего дочернего элемента. Совпадающий дочерний элемент передаётся в качестве первого аргумента.
callbackContext	объект	<необязательно>		Контекст, в котором должна вызываться функция (обычно «this»).
args	Массив.<любое>	<необязательно>	(нет)	Аргументы, передаваемые в функцию обратного вызова; первый индекс массива (аргумент) будет заменён совпадающим дочерним элементом.

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

любое -

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

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

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

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

Параметры

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

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

Phaser.Group -

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

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

moveDown(child) → {любое}

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

Параметры

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

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

любое -

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

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

moveUp(child) → {любое}

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

Параметры

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

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

любое -

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

Исходный код: 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, свойство будет изменено только если объект-потомок виден.

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

next() → {any}

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

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

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

any -

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

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

<internal> postUpdate()

Основной postUpdate - вызывается методом World.

Внутреннее использование:

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

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

<internal> preUpdate()

Основной preUpdate - вызывается методом World.

Внутреннее использование:

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

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

previous() → {any}

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

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

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

any -

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

Исходный код: 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.

Исходный код: 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, она будет недействительной.

Исходный код: 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.

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

removeChild(child) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

Удалённый потомок.

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

• PIXI.DisplayObjectContainer#removeChild

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

removeChildAt(index) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#removeChildAt

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

removeChildren(beginIndex, endIndex)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#removeChildren

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

removeFromHash(child) → {boolean}

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

Параметры

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

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

boolean -

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

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

replace(oldChild, newChild) → {any}

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

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

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

Параметры

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

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

any -

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

Исходный код: 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.

Параметры

... (остальные параметры) ...

Имя	Тип	Аргумент	Описание

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

DisplayObject -

Дочерний элемент, который был сброшен: обычно Phaser.Sprite.

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

resetCursor(index) → {any}

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

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

Параметры

...

Имя	Тип	Аргумент	По умолчанию	Описание

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

...

...

reverse()

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

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

...

sendToBack(child) → {any}

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

Параметры

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

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

any -

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

Исходный код: 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 — если нет.

Исходный код: 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 и свойство не существует, ничего не будет установлено.

Исходный код: 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 и свойство не существует, ничего не будет установлено.

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

setChildIndex(child, index)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#setChildIndex

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

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

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

Операции:

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

Параметры

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

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

булево -

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

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

sort(key, order)

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

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

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

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

Параметры

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

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

subAll(property, amount, checkAlive, checkVisible)

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

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

Параметры

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

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

swap(child1, child2)

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

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

Параметры

Имя	Тип	Описание
child1	любой	Первый дочерний элемент для обмена.
child2	любой	Второй дочерний элемент для обмена.

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

swapChildren(child, child2)

Меняет местами положение двух Display Objects в этом контейнере.

Параметры

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

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

• PIXI.DisplayObjectContainer#swapChildren

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

<internal> update()

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

Внутреннее:

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

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

<internal> updateZ()

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

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

Внутренний:

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

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

xy(index, x, y)

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

Параметры

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

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