Class: Phaser.FlexLayer

Конструктор

new FlexLayer(manager, position, bounds, scale)

ПРЕДУПРЕЖДЕНИЕ: Это экспериментальный класс. API существенно изменится в ближайших версиях и не завершён.
Пожалуйста, старайтесь избегать использования в игровых проектах с длительным циклом разработки.
Поэтому документация также неполна.

Реактивный слой сетки.

Параметры

Имя	Тип	Описание
`manager`	Phaser.FlexGrid	FlexGrid, которому принадлежит этот FlexLayer.
`position`	Phaser.Point	Ссылка на объект Point, используемый для позиционирования.
`bounds`	Phaser.Rectangle	Ссылка на Rectangle, используемый для границ слоя.
`scale`	Phaser.Point	Ссылка на объект Point, используемый для масштабирования слоя.

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

Расширяет

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)

[readonly] 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)

[readonly] cursorIndex : integer

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

Inherited From

Phaser.Group#cursorIndex

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

enableBody : boolean

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

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

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

Inherited From

Phaser.Group#enableBody

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

enableBodyDebug : boolean

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

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

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

Phaser.Group#enableBodyDebug

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

exists : boolean

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

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

Phaser.Group#exists

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

true

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

fixedToCamera : boolean

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

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

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

Phaser.Group#fixedToCamera

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

<internal> game : Phaser.Game

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

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

Phaser.Group#game

Внутреннее:

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

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

grid : Phaser.FlexGrid

Ссылка на FlexGrid, которому принадлежит этот слой.

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

hash :array

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

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

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

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

Phaser.Group#hash

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

height : number

Высота контейнера displayObject, изменение этого значения фактически изменит масштаб для достижения заданного значения.

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

PIXI.DisplayObjectContainer#height

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

ignoreChildInput : boolean

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

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

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

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

PIXI.DisplayObjectContainer#ignoreChildInput

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

ignoreDestroy : boolean

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

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

Phaser.Group#ignoreDestroy

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

inputEnableChildren : boolean

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

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

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

Phaser.Group#inputEnableChildren

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

left : number

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

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

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

Phaser.Group#left

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

[readonly] length : integer

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

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

Phaser.Group#length

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

manager

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

Имя	Тип	Описание
`scale`	Phaser.ScaleManager	Ссылка на ScaleManager.

name : string

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

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

Phaser.Group#name

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

onChildInputDown : Phaser.Signal

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

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

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

Phaser.Group#onChildInputDown

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

onChildInputOut : Phaser.Signal

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

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

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

Phaser.Group#onChildInputOut

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

onChildInputOver : Phaser.Signal

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

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

Phaser.Group#onChildInputOver

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

onChildInputUp : Phaser.Signal

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

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

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

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)

persist : boolean

Должна ли FlexLayer сохраняться при переключении состояний?

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

physicsBodyType : integer

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

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

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

Phaser.Group#physicsBodyType

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

physicsSortDirection : integer

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

[readonly] physicsType : number

Константа типа физического тела этого объекта.

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

Phaser.Group#physicsType

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

position : Phaser.Point

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

right : number

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

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

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

Phaser.Group#right

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

rotation : number

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

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

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

Phaser.Group#rotation

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

scale : Phaser.Point

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

top : number

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

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

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

Phaser.Group#top

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

topLeft : Phaser.Point

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

topMiddle : Phaser.Point

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

topRight : Phaser.Point

Source code: core/FlexLayer.js (Line 71)

[readonly] total : integer

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

Inherited From

Phaser.Group#total

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

<internal> type : integer

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

Inherited From

Phaser.Group#type

Внутреннее:

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

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

visible : boolean

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

Inherited From

Phaser.Group#visible

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

width : number

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

Inherited From

PIXI.DisplayObjectContainer#width

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

x : number

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

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

Inherited From

Phaser.Group#x

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

y : number

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

Inherited From

Phaser.Group#y

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

[readonly] z : integer

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

Inherited From

Phaser.Group#z

Source code: core/Group.js (Line 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 — это низ группы.

Возвращает

DisplayObject -

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

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

Phaser.Group#add

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

addAll(property, amount, checkAlive, checkVisible)

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

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

Parameters

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

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

Phaser.Group#addAll

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

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

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

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

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

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

Parameters

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

Возвращает

DisplayObject -

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

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

Phaser.Group#addAt

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

addChild(child) → {DisplayObject}

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

Parameters

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

Возвращает

DisplayObject -

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

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

PIXI.DisplayObjectContainer#addChild

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

addChildAt(child, index) → {DisplayObject}

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

Parameters

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

Возвращает

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.

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

Phaser.Group#addMultiple

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

addToHash(child) → {boolean}

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

Параметры

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

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

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}

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

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

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

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

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

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

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

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

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

Параметры

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

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

Phaser.Group -

Эта группа.

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

Phaser.Group#alignIn

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

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

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

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

<internal> ascendingSortHandler(a, b)

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

Параметры

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

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

Phaser.Group#ascendingSortHandler

Внутренний:

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

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

bringToTop(child) → {any}

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

Параметры

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

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

any -

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

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

Phaser.Group#bringToTop

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

callAll(method, context, args)

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

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

Параметры

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

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

Phaser.Group#callAll

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

callAllExists(callback, existsValue, parameter)

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

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

Параметры

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

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

Phaser.Group#callAllExists

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

<internal> callbackFromArray(child, callback, length)

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

Параметры

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

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

Phaser.Group#callbackFromArray

Внутреннее:

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

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

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

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

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

Параметры

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

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

Phaser.Group#checkAll

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

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

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

Параметры

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

Возвращает

boolean -

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

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

Phaser.Group#checkProperty

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

contains(child) → {Boolean}

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

Параметры

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

Возвращает

Boolean -

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

PIXI.DisplayObjectContainer#contains

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

countDead() → {integer}

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

Возвращает

целое число -

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

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

Phaser.Group#countDead

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

countLiving() → {целое число}

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

Возвращает

целое число -

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

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

Phaser.Group#countLiving

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

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

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

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

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

Или, если указан необязательный параметр index, элемент добавляется в указанную позицию с учётом значения 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	Значение состояния 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 Sprite для каждого ключа (и кадра) в массивах.

Например:

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	Значение состояния exists по умолчанию для Sprite.

Возвращает

массив -

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

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

Phaser.Group#createMultiple

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

customSort(sortHandler, context)

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

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

Параметры

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

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

Phaser.Group#customSort

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

debug()

Отладка.

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

<internal> descendingSortHandler(a, b)

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

Параметры

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

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

Phaser.Group#descendingSortHandler

Внутреннее:

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

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

destroy(destroyChildren, soft)

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

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

Параметры

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

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

Phaser.Group#destroy

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

divideAll(property, amount, checkAlive, checkVisible)

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

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

Параметры

Имя	Тип	Описание
`property`	строка	Свойство для деления, например, 'body.velocity.x' или 'angle'.
`amount`	число	Значение для деления свойства. Если 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`	функция			Функция, с которой будет сравниваться каждый потомок. Каждый потомок группы будет передан ей в качестве первого параметра, индекс — во втором, а весь массив потомков — в третьем.
`checkExists`	boolean	<optional>	false	Если true, выбираются только существующие; в противном случае можно выбрать всех потомков, и они будут переданы предикату.

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

Phaser.ArraySet -

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

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

Phaser.Group#filter

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

forEach(callback, callbackContext, checkExists, args)

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

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

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

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

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

Параметры

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

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

Phaser.Group#forEach

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

forEachAlive(callback, callbackContext, args)

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

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

Параметры

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

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

Phaser.Group#forEachAlive

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

forEachDead(callback, callbackContext, args)

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

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

Параметры

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

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

Phaser.Group#forEachDead

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

forEachExists(callback, callbackContext, args)

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

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

Параметры

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

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

Phaser.Group#forEachExists

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

getAll(property, value, startIndex, endIndex) → {any}

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

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

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

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

Параметры

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

Возвращает

любой -

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

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

Phaser.Group#getAll

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

getAt(index) → {DisplayObject | integer}

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

Параметры

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

Возвращает

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

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

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

Phaser.Group#getAt

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

getBottom() → {any}

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

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

Возвращает

любой -

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

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

Phaser.Group#getBottom

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

getBounds(targetCoordinateSpace) → {Rectangle}

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

Параметры

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

Возвращает

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

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

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

PIXI.DisplayObjectContainer#getBounds

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

getByName(name) → {any}

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

Параметры

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

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

any -

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

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

Phaser.Group#getByName

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

getChildAt(index) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

Элемент по заданному индексу, если он есть.

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

PIXI.DisplayObjectContainer#getChildAt

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

getChildIndex(child) → {Number}

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

Параметры

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

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

Number -

Индекс искомого элемента.

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

PIXI.DisplayObjectContainer#getChildIndex

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

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

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

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

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

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

Параметры

Имя	Тип	Аргумент	Описание
`object`	any		Объект, используемый для определения расстояния. Это может быть Sprite, Group, Image или любой объект с публичными свойствами x и y.
`callback`	function	<опционально>	Функция, с помощью которой оценивается каждый элемент. Каждый элемент группы передаётся ей в качестве первого параметра, а расстояние — как второй. Она должна вернуть `true` , если элемент соответствует условиям.
`callbackContext`	object	<опционально>	Контекст, в котором должна быть вызвана функция (обычно «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	<опционально>	false	Если `true` и живые элементы не найдены, создаётся новый.
`x`	number	<опционально>		Координата x для сброса элемента. Значение относительно точки group.x.
`y`	number	<опционально>		Координата y для сброса элемента. Значение относительно точки group.y.
`key`	string \| Phaser.RenderTexture \| Phaser.BitmapData \| Phaser.Video \| PIXI.Texture	<опционально>		Изображение или текстура, используемая Sprite для рендеринга. Может быть строкой, являющейся ссылкой на запись Cache Image, или экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.
`frame`	string \| number	<опционально>		Если Sprite использует часть спрайт-листа или текстурного атласа, вы можете указать точный кадр, указав строку или числовой индекс.

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

DisplayObject -

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

Inherited From

Phaser.Group#getFirstAlive

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

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

Получить первый дочерний элемент, который мёртв (child.alive === false).

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

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

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

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

Parameters

Name	Type	Argument	Default	Description
`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>		Если этот спрайт использует часть спрайт-листа или атласа текстур, вы можете указать точный кадр для использования, указав строковый или числовой индекс.

Returns

DisplayObject -

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

Inherited From

Phaser.Group#getFirstDead

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

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

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

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

Parameters

Name	Type	Argument	Default	Description
`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>		Если этот спрайт использует часть спрайт-листа или атласа текстур, вы можете указать точный кадр для использования, указав строковый или числовой индекс.

Returns

DisplayObject -

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

Inherited From

Phaser.Group#getFirstExists

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

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

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

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

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

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

Parameters

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

Returns

any -

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

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

Phaser.Group#getFurthestFrom

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

getIndex(child) → {целое}

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

Параметры

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

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

целое -

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

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

Phaser.Group#getIndex

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

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

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

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

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

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

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

PIXI.DisplayObjectContainer#getLocalBounds

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

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

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

Параметры

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

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

любой -

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

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

Phaser.Group#getRandom

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

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

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

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

Параметры

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

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

любой -

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

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

Phaser.Group#getRandomExists

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

getTop() → {любой}

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

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

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

любой -

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

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

Phaser.Group#getTop

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

hasProperty(child, key) → {логическое}

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

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

Параметры

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

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

логическое -

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

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

Phaser.Group#hasProperty

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

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

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

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

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

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

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

Параметры

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

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

любой -

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

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

любой -

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

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

Phaser.Group#moveDown

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

moveUp(child) → {any}

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

Параметры

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

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

любой -

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

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

Phaser.Group#moveUp

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

multiplyAll(property, amount, checkAlive, checkVisible)

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

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

Параметры

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

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

Phaser.Group#multiplyAll

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

next() → {any}

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

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

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

любой -

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

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

Phaser.Group#next

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

<внутреннее> postUpdate()

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

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

Phaser.Group#postUpdate

Внутреннее:

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

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

<внутреннее> preUpdate()

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

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

Phaser.Group#preUpdate

Внутреннее:

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

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

previous() → {any}

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

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

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

any -

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

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

Phaser.Group#previous

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

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

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

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

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

Параметры

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

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

boolean -

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

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

Phaser.Group#remove

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

removeAll(destroy, silent, destroyTexture)

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

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

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

Параметры

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

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

Phaser.Group#removeAll

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

removeBetween(startIndex, endIndex, destroy, silent)

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

Параметры

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

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

Phaser.Group#removeBetween

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

removeChild(child) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

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

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

PIXI.DisplayObjectContainer#removeChild

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

removeChildAt(index) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

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

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

PIXI.DisplayObjectContainer#removeChildAt

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

removeChildren(beginIndex, endIndex)

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

resize()

Изменение размера.

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

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.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
`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 метод сортировки массива, поэтому всё, что относится к нему, также относится и сюда, включая сортировку по алфавиту, смешивание строк и чисел, а также сортировку Unicode. Для получения дополнительной информации см. MDN.

Параметры

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

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

Phaser.Group#sort

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

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.FlexLayer.html

Class: Phaser.FlexLayer

Конструктор

new FlexLayer(manager, position, bounds, scale)

Параметры

Расширяет

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

alive : boolean

alpha : number

angle : number

bottom : number

bottomLeft : Phaser.Point

bottomMiddle : Phaser.Point

bottomRight : Phaser.Point

bounds : Phaser.Rectangle

cameraOffset : Phaser.Point

centerX : number

centerY : number

[readonly] children : Array.<DisplayObject>

Тип

classType : Object

cursor : DisplayObject

[readonly] cursorIndex : integer

enableBody : boolean

enableBodyDebug : boolean

exists : boolean

fixedToCamera : boolean

<internal> game : Phaser.Game

grid : Phaser.FlexGrid

hash :array

height : number

ignoreChildInput : boolean

ignoreDestroy : boolean

inputEnableChildren : boolean

left : number

[readonly] length : integer

manager

Свойства:

name : string

onChildInputDown : Phaser.Signal

onChildInputOut : Phaser.Signal

onChildInputOver : Phaser.Signal

onChildInputUp : Phaser.Signal

onDestroy : Phaser.Signal

pendingDestroy : boolean

persist : boolean

physicsBodyType : integer

physicsSortDirection : integer

[readonly] physicsType : number

position : Phaser.Point

right : number

rotation : number

scale : Phaser.Point

top : number

topLeft : Phaser.Point

topMiddle : Phaser.Point

topRight : Phaser.Point

[readonly] total : integer

<internal> type : integer

visible : boolean

width : number

x : number

y : number

[readonly] z : integer

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

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

Parameters

Возвращает

addAll(property, amount, checkAlive, checkVisible)

Parameters

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

Parameters

Возвращает

addChild(child) → {DisplayObject}

Parameters

Возвращает

addChildAt(child, index) → {DisplayObject}

Parameters

Возвращает

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

Parameters