Класс: Phaser.SpriteBatch

Конструктор

new SpriteBatch(game, parent, name, addToStage)

Класс SpriteBatch — это очень быстрая версия DisplayObjectContainer, созданная исключительно для скорости. Используйте его, когда вам нужно много спрайтов или частиц.
Стоит отметить, что по умолчанию SpriteBatch используется во всём рендерере, поэтому вам нужно использовать SpriteBatch только если у вас более
1000 спрайтов, которые используют одну и ту же текстуру (или атлас текстур). Он также полезен при работе в режиме Canvas, если у вас много не вращаемых или не масштабируемых
спрайтов, так как он пропускает все вызовы Canvas setTransform, что помогает производительности, особенно на мобильных устройствах.

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
`game`	Phaser.Game			Ссылка на текущую запущенную игру.
`parent`	Phaser.Group \| Phaser.Sprite \| null			Родительская группа, DisplayObject или DisplayObjectContainer, к которой будет добавлена эта группа. Если `undefined` или `null`, будет использоваться game.world.
`name`	string	<optional>	group	Имя этой группы. Не используется во внутренней работе, но полезно для отладки.
`addToStage`	boolean	<optional>	false	Если установлено в true, эта группа будет добавлена непосредственно в Game.Stage вместо Game.World.

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

Расширяет

Phaser.Group

Открытые свойства

alive : boolean

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

Inherited From

Phaser.Group#alive

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

true

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

alpha : number

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

Inherited From

Phaser.Group#alpha

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

angle : number

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

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

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

Inherited From

Phaser.Group#angle

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

bottom : number

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

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

Inherited From

Phaser.Group#bottom

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

cameraOffset : Phaser.Point

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

Inherited From

Phaser.Group#cameraOffset

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

centerX : number

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

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

Inherited From

Phaser.Group#centerX

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

centerY : number

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

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

Inherited From

Phaser.Group#centerY

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

[только для чтения] children : Array.<DisplayObject>

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

Тип

Array.<DisplayObject>

Inherited From

PIXI.DisplayObjectContainer#children

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

classType : Object

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

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

Inherited From

Phaser.Group#classType

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

Phaser.Sprite

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

cursor : DisplayObject

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

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

Inherited From

Phaser.Group#cursor

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

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

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

Inherited From

Phaser.Group#cursorIndex

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

enableBody : boolean

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

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

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

Inherited From

Phaser.Group#enableBody

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

enableBodyDebug : boolean

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

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

Inherited From

Phaser.Group#enableBodyDebug

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

exists : boolean

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

Inherited From

Phaser.Group#exists

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

true

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

fixedToCamera : boolean

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

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

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

Phaser.Group#fixedToCamera

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

<internal> game : Phaser.Game

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

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

Phaser.Group#game

Внутреннее:

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

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

hash :массив

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

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

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

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

Phaser.Group#hash

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

height : число

Высота 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 : число

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

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

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

Phaser.Group#left

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

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

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

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

Phaser.Group#length

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

name : строка

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

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

Phaser.Group#name

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

onChildInputDown : Phaser.Signal

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

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

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

Phaser.Group#onChildInputDown

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

onChildInputOut : Phaser.Signal

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

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

Phaser.Group#onChildInputOut

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

onChildInputOver : Phaser.Signal

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

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

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, помечается для вызова метода destroy на следующем логическом обновлении.
Вы можете установить его напрямую, чтобы пометить группу для уничтожения на следующем обновлении.

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

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

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)

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 : number

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

Внутреннее:

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

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

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 контейнера группы.

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

Phaser.Group#y

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

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

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

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

Phaser.Group#z

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

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

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

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

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

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

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

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

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

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

Параметры

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

Возвращает

DisplayObject -

Потомок, который был добавлен в группу.

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

Phaser.Group#add

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

addAll(property, amount, checkAlive, checkVisible)

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

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

Параметры

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

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

Phaser.Group#addAll

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

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

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

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

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

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

Параметры

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

Возвращает

DisplayObject -

Потомок, который был добавлен в группу.

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

Phaser.Group#addAt

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

addChild(child) → {DisplayObject}

Добавляет потомка в контейнер.

Параметры

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

Возвращает

DisplayObject -

Потомок, который был добавлен.

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

PIXI.DisplayObjectContainer#addChild

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

addChildAt(child, index) → {DisplayObject}

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

Параметры

Имя	Тип	Описание
`child`	DisplayObject	Потомок для добавления
`index`	Number	Индекс, в который нужно поместить потомка

Возвращает

DisplayObject -

Потомок, который был добавлен.

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

PIXI.DisplayObjectContainer#addChildAt

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

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

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

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

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

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

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

Параметры

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

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

Array.<DisplayObject> | Phaser.Group -

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

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

Phaser.Group#addMultiple

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

addToHash(child) → {boolean}

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

Параметры

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

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

boolean -

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

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

Phaser.Group#addToHash

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

boolean -

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

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

Phaser.Group#align

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

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

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

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

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

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

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, для выравнивания групп в пределах мира
и границ камеры. Или это могут быть другие объекты Sprite, Image, Text, BitmapText,
TileSprite или Button.

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

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

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

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

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

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

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

Параметры

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

Возвращает

Phaser.Group -

Эта группа.

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

Phaser.Group#alignTo

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

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

Параметры

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

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

Параметры

Имя	Тип	Описание
`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, если свойство было равно value, иначе 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`	целое число			Количество создаваемых Sprites.
`key`	строка \| массив			Ключ кэша изображения, которое будут использовать Sprites. Или массив ключей. См. описание для деталей о том, как количество применяется, когда используются массивы.
`frame`	целое число \| строка \| массив	<необязательно>	0	Если изображение Sprite содержит несколько кадров, здесь можно указать, какой из них использовать. Или массив кадров. См. описание для деталей о том, как количество применяется, когда используются массивы.
`exists`	логическое значение	<необязательно>	false	Стандартное состояние exists Sprite.

Возвращает

массив -

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

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

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	<необязательно>	true	Если true, `destroy` будет вызываться для каждого удаленного дочернего элемента.
`soft`	boolean	<необязательно>	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)

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	<необязательно>	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	<необязательно>	false	Если установлено, только дочерние элементы, для которых `exists` равно true, будут переданы в обратный вызов; в противном случае все дочерние элементы будут переданы.
`args`	any	<необязательно> <повторяемый>	(нет)	Дополнительные аргументы для передачи функции обратного вызова после элемента дочернего элемента.

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

Phaser.Group#forEach

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

forEachAlive(callback, callbackContext, args)

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

См. forEach для получения подробной информации.

Параметры

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

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

Phaser.Group#forEachAlive

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

forEachDead(callback, callbackContext, args)

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

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

Параметры

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

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

Phaser.Group#forEachDead

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

forEachExists(callback, callbackContext, args)

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

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

Параметры

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

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

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`	string	<optional>		Необязательное свойство для проверки против аргумента value.
`value`	any	<optional>		Если свойство установлено, то Child.property должно строго совпадать с этим значением, чтобы быть включённым в результаты.
`startIndex`	integer	<optional>	0	Индекс первого дочернего элемента для начала поиска.
`endIndex`	integer	<optional>		Последний индекс дочернего элемента для поиска.

Возвращает

any -

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

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

Phaser.Group#getAll

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

getAt(index) → {DisplayObject | integer}

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

Параметры

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

Возвращает

DisplayObject | integer -

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

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

Phaser.Group#getAt

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

getBottom() → {any}

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

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

Возвращает

any -

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

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

Phaser.Group#getBottom

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

getBounds(targetCoordinateSpace) → {Rectangle}

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

Параметры

Имя	Тип	Аргумент	Описание
`targetCoordinateSpace`	PIXIDisplayObject \| PIXIMatrix	<optional>	Возвращает прямоугольник, определяющий область объекта отображения относительно системы координат объекта 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`	Число	Индекс дочернего элемента

Возвращает

DisplayObject -

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

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

PIXI.DisplayObjectContainer#getChildAt

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

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

Возвращает позицию индекса дочернего объекта DisplayObject

Параметры

Имя	Тип	Описание
`child`	DisplayObject	Объект DisplayObject для идентификации

Возвращает

Число -

Позиция индекса дочернего объекта для идентификации

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

PIXI.DisplayObjectContainer#getChildIndex

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

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

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

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

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

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

DisplayObject -

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

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

Phaser.Group#getFirstDead

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

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

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

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

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

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

DisplayObject -

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

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

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

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

Параметры

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

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

целое число -

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

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

Phaser.Group#getIndex

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

getLocalBounds() → {Rectangle}

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

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

Rectangle -

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

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

PIXI.DisplayObjectContainer#getLocalBounds

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

getRandom(startIndex, length) → {any}

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

Параметры

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

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

any -

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

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

Phaser.Group#getRandom

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

getRandomExists(startIndex, endIndex) → {any}

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

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

Параметры

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

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

any -

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

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

Phaser.Group#getRandomExists

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

getTop() → {any}

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

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

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

any -

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

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

Phaser.Group#getTop

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

hasProperty(child, key) → {boolean}

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

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

Параметры

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

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

boolean -

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

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

Phaser.Group#hasProperty

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

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

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

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

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

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

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

Параметры

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

Возвращает

any -

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

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

Phaser.Group#iterate

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

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

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

Параметры

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

Возвращает

Phaser.Group -

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

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

Phaser.Group#moveAll

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

moveDown(child) → {any}

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

Параметры

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

Возвращает

any -

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

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

Phaser.Group#moveDown

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

moveUp(child) → {any}

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

Параметры

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

Возвращает

any -

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

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

Phaser.Group#moveUp

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

multiplyAll(property, amount, checkAlive, checkVisible)

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

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

Параметры

Имя	Тип	Описание
`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, используемую ребёнком. Будьте осторожны, если у вас
более одного объекта Game Object, использующего ту же BaseTexture.

Параметры

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

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

Phaser.Group#removeAll

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

removeBetween(startIndex, endIndex, destroy, silent)

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

Параметры

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

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

Параметры

Имя	Тип	Описание
`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}

Заменяет потомка этой группы на новый указанный элемент. Новый элемент не может быть членом этой группы.

Если 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 при отрисовке. Может быть строкой, которая ссылается на запись Cache Image, или экземпляром 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, свойство НЕ устанавливается для групп-потомков самих по себе.

Параметры

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

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

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

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

Параметры

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

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

boolean -

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

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

Phaser.Group#setProperty

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

sort(key, order)

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

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

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

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

Параметры

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

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

Phaser.Group#sort

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

subAll(property, amount, checkAlive, checkVisible)

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

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

Параметры

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

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

Phaser.Group#subAll

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

swap(child1, child2)

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

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

Параметры

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

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

Phaser.Group#swap

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

swapChildren(child, child2)

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

Параметры

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

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

PIXI.DisplayObjectContainer#swapChildren

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

<internal> update()

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

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

Phaser.Group#update

Внутренний:

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

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

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

© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.SpriteBatch.html