Spec-Zone.ru › Phaser

Класс: Phaser.World

Конструктор

new World(game)

"Этот мир – всего лишь холст для нашего воображения." - Генри Дэвид Торо

У игры всего один мир. Мир – это абстрактное место, в котором живут все объекты игры. Он не ограничен размерами сцены и может быть любого размера. Вы смотрите в мир через камеры. Все объекты игры существуют внутри мира в координатах мира. По умолчанию мир создается с размерами, соответствующими вашей сцене.

Параметры
Имя Тип Описание
game Phaser.Game

Ссылка на текущую инстанцию игры.
Исходный код: core/World.js (Строка 19)

Расширяет

  • Phaser.Group

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

[readonly] _definedSize : boolean

Истинно, если у World задан определённый размер (например, из Tilemap или непосредственно в коде), или ложно, если он просто соответствует размерам игры.

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

_height

Свойства:
Имя Тип Описание
height number

Заданная высота World. Иногда границы должны быть больше этого значения (если вы изменяете размер игры), но это сохраняет исходные запрошенные размеры.
Исходный код: core/World.js (Строка 51)

_width

Свойства:
Имя Тип Описание
width number

Заданная ширина World. Иногда границы должны быть больше этого значения (если вы изменяете размер игры), но это сохраняет исходные запрошенные размеры.
Исходный код: core/World.js (Строка 46)

alive : boolean

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

Унаследовано от
  • Phaser.Group#alive
Значение по умолчанию
  • true
Исходный код: core/Group.js (Строка 93)

alpha : number

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

Унаследовано от
  • Phaser.Group#alpha
Исходный код: core/Group.js (Строка 3003)

angle : number

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

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

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

Унаследовано от
  • Phaser.Group#angle
Исходный код: core/Group.js (Строка 2682)

bottom : number

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

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

Унаследовано от
  • Phaser.Group#bottom
Исходный код: core/Group.js (Строка 2845)

bounds : Phaser.Rectangle

World не имеет фиксированного размера, но имеет границы, за пределами которых объекты больше не считаются «в мире», и вы должны использовать это для очистки списка отображения и удаления мёртвых объектов.
По умолчанию границы устанавливаются от 0,0 до Game.width, Game.height. То есть он будет соответствовать размеру, заданному в конструкторе игры, где 0,0 представляет верхний левый угол экрана.
Однако 0,0 фактически является центром мира, и если вы поворачиваете или масштабируете мир, всё это произойдёт от 0,0.
Итак, если вы хотите создать игру, в которой сам мир будет поворачиваться, вам следует настроить границы так, чтобы 0,0 была центральной точкой, т.е. установите их в -1000, -1000, 2000, 2000 для мира размером 2000x2000, центрированного вокруг 0,0. Граница этого мира, из которой объекты не могут выходить.

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

camera : Phaser.Camera

Экземпляр камеры.

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

cameraOffset : Phaser.Point

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

Унаследовано от
  • Phaser.Group#cameraOffset
Исходный код: core/Group.js (Строка 272)

[readonly] centerX : number

Получает позицию X, соответствующую центральной точке мира.

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

[readonly] centerY : number

Получает позицию Y, соответствующую центральной точке мира.

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

[readonly] children : Array.<DisplayObject>

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

Тип
  • Array.<DisplayObject>
Унаследовано от
  • PIXI.DisplayObjectContainer#children
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 17)

classType : Object

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

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

Унаследовано от
  • Phaser.Group#classType
Значение по умолчанию
  • Phaser.Sprite
Исходный код: core/Group.js (Строка 130)

cursor : DisplayObject

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

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

Унаследовано от
  • Phaser.Group#cursor
Исходный код: core/Group.js (Строка 138)

[readonly] cursorIndex : integer

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

Унаследовано от
  • Phaser.Group#cursorIndex
Исходный код: core/Group.js (Строка 255)

enableBody : boolean

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

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

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

Унаследовано от
  • Phaser.Group#enableBody
Исходный код: core/Group.js (Строка 208)

enableBodyDebug : boolean

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

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

Унаследовано от
  • Phaser.Group#enableBodyDebug
Исходный код: core/Group.js (Строка 217)

exists : boolean

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

Унаследовано от
  • Phaser.Group#exists
Значение по умолчанию
  • true
Исходный код: core/Group.js (Строка 100)

fixedToCamera : boolean

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

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

Унаследовано от
  • Phaser.Group#fixedToCamera
Исходный код: core/Group.js (Строка 265)

<internal> game : Phaser.Game

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

Унаследовано от
  • Phaser.Group#game
Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: core/Group.js (Строка 38)

hash :array

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

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

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

Унаследовано от
  • Phaser.Group#hash
Исходный код: core/Group.js (Строка 285)

height : number

Получает или задает текущую высоту игрового мира. Минимальный размер мира не может быть меньше размеров игры (холста).

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

ignoreChildInput : boolean

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

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

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

Унаследовано от
  • PIXI.DisplayObjectContainer#ignoreChildInput
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 26)

ignoreDestroy : boolean

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

Унаследовано от
  • Phaser.Group#ignoreDestroy
Исходный код: core/Group.js (Строка 107)

inputEnableChildren : boolean

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

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

Унаследовано от
  • Phaser.Group#inputEnableChildren
Исходный код: core/Group.js (Строка 149)

left : number

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

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

Унаследовано от
  • Phaser.Group#left
Исходный код: core/Group.js (Строка 2761)

[readonly] length : integer

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

Унаследовано от
  • Phaser.Group#length
Исходный код: core/Group.js (Строка 2665)

name : string

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

Унаследовано от
  • Phaser.Group#name
Исходный код: core/Group.js (Строка 49)

onChildInputDown : Phaser.Signal

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

Этот сигнал отправляется с двумя аргументами: ссылкой на 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.

Этот сигнал отправляет 2 аргумента: ссылку на элемент 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)

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)

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

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

Унаследовано от
  • Phaser.Group#physicsType
Исходный код: core/Group.js (Строка 86)

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

Возвращает случайное целое число, которое меньше или равно текущей ширине игрового мира.

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

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

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

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

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)

<internal> type : integer

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

Унаследовано от
  • Phaser.Group#type
Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменён или удалён в будущем.
Исходный код: core/Group.js (Строка 80)

visible : boolean

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

Унаследовано от
  • Phaser.Group#visible
Исходный код: core/Group.js (Строка 2996)

width : number

Возвращает или задаёт текущую ширину игрового мира. Размер мира никогда не может быть меньше размеров игры (холста).

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

x : number

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

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

Унаследовано от
  • Phaser.Group#x
Исходный код: core/Group.js (Строка 2969)

y : number

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

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

Унаследовано от
  • Phaser.Group#y
Исходный код: core/Group.js (Строка 2978)

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

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

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

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

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

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
children Array.<DisplayObject> | Phaser.Group

Массив объектов отображения или Phaser.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

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

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

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

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

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

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

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

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

Параметры
Имя Тип Аргумент По умолчанию Описание
parent Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite

Объект игры или прямоугольник, относительно которого нужно выровнять эту группу. Также может включать свойства, такие как World.bounds или Camera.view.
position целое число <необязательно>

Постоянная позиционирования. Одно из значений Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_TOP, Phaser.LEFT_CENTER, Phaser.LEFT_BOTTOM, Phaser.RIGHT_TOP, Phaser.RIGHT_CENTER, Phaser.RIGHT_BOTTOM, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER или Phaser.BOTTOM_RIGHT.
offsetX целое число <необязательно>
 0

Горизонтальная корректировка границ контейнера, применяемая к выровненной позиции объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения.
offsetY целое число <необязательно>
 0

Вертикальная корректировка границ контейнера, применяемая к выровненной позиции объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения.
Возвращает
Phaser.Group -

Эта группа.

Унаследовано от
  • Phaser.Group#alignTo
Исходный код: core/Group.js (Строка 2915)

<internal> ascendingSortHandler(a, b)

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

Параметры
Имя Тип Описание
a объект

Первый сортируемый объект.
b объект

Второй сортируемый объект.
Унаследовано от
  • Phaser.Group#ascendingSortHandler
Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: core/Group.js (Строка 1919)

<internal> boot()

Инициализирует игровую область.

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: core/World.js (Строка 60)

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)

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

Параметры
Имя Тип Описание
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() → {целое}

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

Возвращает
целое -

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

Унаследовано от
  • 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 при отрисовке. Может быть строкой, которая ссылается на запись в кэше изображения, или экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.
frame строка | число <необязательно>

Если Sprite использует часть спрайт-листа или текстурной карты, вы можете указать точный фрейм, используя строку или числовой индекс.
exists логическое <необязательно>
 true

Состояние существования Sprite по умолчанию.
index целое <необязательно>

Индекс в группе, куда вставить элемент. Где 0 - низ группы.
Возвращает
DisplayObject -

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

Унаследовано от
  • Phaser.Group#create
Исходный код: core/Group.js (Строка 544)

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

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

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

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

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

Например:

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

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

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

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

Если вы укажете массивы для key и frame, то общее количество созданных спрайтов будет равно произведению размеров обоих массивов. Например:

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

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

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

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

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

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

Количество создаваемых спрайтов.
key строка | массив

Ключ кэша изображения, которое будут использовать спрайты. Или массив ключей. Смотрите описание для деталей о том, как количество применяется при использовании массивов.
frame целое | строка | массив <необязательно>
 0

Если изображение спрайта содержит несколько кадров, вы можете указать, какой из них использовать здесь. Или массив кадров. Смотрите описание для деталей о том, как количество применяется при использовании массивов.
exists логическое <необязательно>
 false

Состояние существования спрайта по умолчанию.
Возвращает
массив -

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

Унаследовано от
  • Phaser.Group#createMultiple
Исходный код: core/Group.js (Строка 581)

customSort(sortHandler, context)

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

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

Parameters
Name Type Argument Описание
sortHandler function

Пользовательская функция сортировки.
context object <optional>

Контекст, в котором вызывается sortHandler.
Inherited From
  • Phaser.Group#customSort
Source code: core/Group.js (Line 1895)

<internal> descendingSortHandler(a, b)

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

Parameters
Name Type Описание
a object

Первый сортируемый объект.
b object

Второй сортируемый объект.
Inherited From
  • Phaser.Group#descendingSortHandler
Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Source code: core/Group.js (Line 1951)

destroy(destroyChildren, soft)

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

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

Parameters
Name Type Argument Значение по умолчанию Описание
destroyChildren boolean <optional>
 true

Если true, destroy будет вызвано для каждого удаленного дочернего элемента.
soft boolean <optional>
 false

«Мягкое уничтожение» (установлено в true) не удаляет эту группу из родителя или не обнуляет ссылку на игру. Если установлено в false, выполняется удаление.
Inherited From
  • Phaser.Group#destroy
Source code: core/Group.js (Line 2611)

divideAll(property, amount, checkAlive, checkVisible)

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

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

Parameters
Name Type Описание
property string

Свойство для деления, например, 'body.velocity.x' или 'angle'.
amount number

Значение для деления свойства. Если child.x = 100, то divideAll('x', 2) изменит child.x на 50.
checkAlive boolean

Если true, свойство будет изменено только если дочерний элемент жив.
checkVisible boolean

Если true, свойство будет изменено только если дочерний элемент видим.
Inherited From
  • Phaser.Group#divideAll
Source code: core/Group.js (Line 1437)

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

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

Например:

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

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

Parameters
Name Type Argument Значение по умолчанию Описание
predicate function

Функция, с которой будет сравниваться каждый дочерний элемент. Каждый дочерний элемент группы будет передан ей в качестве первого параметра, индекс - в качестве второго, а весь массив дочерних элементов - в качестве третьего.
checkExists boolean <optional>
 false

Если true, будут выбраны только существующие элементы; в противном случае все дочерние элементы могут быть выбраны и будут переданы предикату.
Returns
Phaser.ArraySet -

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

Inherited From
  • Phaser.Group#filter
Source code: core/Group.js (Line 1677)

forEach(callback, callbackContext, checkExists, args)

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

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

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

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

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

Parameters
Name Type Argument Значение по умолчанию Описание
callback function

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

Контекст, в котором должна быть вызвана функция (обычно «this»).
checkExists boolean <optional>
 false

Если установлено, будут переданы только дочерние элементы, для которых exists истинно; в противном случае все дочерние элементы будут переданы.
args any <optional>
<repeatable>
 (none)

Дополнительные аргументы для передачи функции обратного вызова после элемента дочернего элемента.
Inherited From
  • Phaser.Group#forEach
Source code: core/Group.js (Line 1717)

forEachAlive(callback, callbackContext, args)

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

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

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

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

Параметры
Имя Тип Описание
index целое число

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

Дочерний элемент, найденный по заданному индексу, или -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 <необязательно>

Возвращает прямоугольник, определяющий область отображения объекта относительно системы координат объекта targetCoordinateSpace.
Возвращает
Rectangle -

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

Унаследованное от
  • PIXI.DisplayObjectContainer#getBounds
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 280)

getByName(name) → {any}

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

Параметры
Имя Тип Описание
name string

Имя для поиска.
Возвращаемое значение
any -

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

Унаследованное от
  • Phaser.Group#getByName
Исходный код: core/Group.js (Строка 1042)

getChildAt(index) → {DisplayObject}

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

Параметры
Имя Тип Описание
index Number

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

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

Унаследованное от
  • PIXI.DisplayObjectContainer#getChildAt
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 153)

getChildIndex(child) → {Number}

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

Параметры
Имя Тип Описание
child DisplayObject

Элемент DisplayObject.
Возвращаемое значение
Number -

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

Унаследованное от
  • PIXI.DisplayObjectContainer#getChildIndex
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 112)

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

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

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

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

Опциональный аргумент позволяет применять пользовательский фильтр к проверке расстояния.
Если элемент ближе, чем предыдущий, он передаётся функции фильтрации в качестве первого аргумента,
а расстояние — как второй. Функция должна вернуть 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>

Это изображение или текстура, используемая Sprite во время рендеринга. Это может быть строка, которая ссылается на запись Cache Image, или экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
frame string | number <optional>

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

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

Унаследованно от
  • Phaser.Group#getFirstDead
Исходный код: core/Group.js (Строка 2135)

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

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

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

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

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
exists boolean <optional>
 true

Если true, найти первый существующий дочерний элемент; в противном случае найти первый несуществующий дочерний элемент.
createIfNull boolean <optional>
 false

Если true и не найдены активные дочерние элементы, то создаётся новый.
x number <optional>

Координата x для сброса дочернего элемента. Значение относится к точке group.x.
y number <optional>

Координата y для сброса дочернего элемента. Значение относится к точке group.y.
key string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture <optional>

Это изображение или текстура, используемая Sprite во время рендеринга. Это может быть строка, которая ссылается на запись Cache Image, или экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
frame string | number <optional>

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

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

Унаследованно от
  • Phaser.Group#getFirstExists
Исходный код: core/Group.js (Строка 2071)

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

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

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

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

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

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

Объект, используемый для определения расстояния. Это может быть Sprite, Group, Image или любой объект со свойствами x и y.
callback function <optional>

Функция, с которой каждый дочерний элемент будет оцениваться. Каждый дочерний элемент группы будет передан в него в качестве первого параметра, а расстояние — как второй. Он должен вернуть true если дочерний элемент соответствует критериям.
callbackContext object <optional>

Контекст, в котором должна быть вызвана функция (обычно «this»).
Возвращает
any -

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

Унаследовано от
  • Phaser.Group#getFurthestFrom
Исходный код: core/Group.js (Строка 2282)

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

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

Параметры
Имя Тип Описание
child любое

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

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

Унаследовано от
  • Phaser.Group#getIndex
Исходный код: core/Group.js (Строка 1029)

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

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

Возвращает
Прямоугольник -

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

Унаследовано от
  • PIXI.DisplayObjectContainer#getLocalBounds
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 437)

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

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
startIndex целое <необязательно>
 0

Смещение от переднего края группы (наименьший дочерний элемент).
length целое <необязательно>
 (до верха)

Ограничение на количество значений, которые вы хотите случайным образом выбрать.
Возвращает
любое -

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

Унаследовано от
  • Phaser.Group#getRandom
Исходный код: core/Group.js (Строка 2350)

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

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

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
startIndex целое <необязательно>
 0

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

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

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

Унаследовано от
  • Phaser.Group#getRandomExists
Исходный код: core/Group.js (Строка 2372)

getTop() → {любое}

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

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

Возвращает
любое -

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

Унаследовано от
  • Phaser.Group#getTop
Исходный код: core/Group.js (Строка 2204)

hasProperty(child, key) → {boolean}

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

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

Параметры
Имя Тип Описание
child любое

Дочерний элемент, для которого необходимо проверить наличие свойства.
key Array.<string>

Массив строк, составляющих свойство.
Возвращает
boolean -

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

Унаследовано от
  • Phaser.Group#hasProperty
Исходный код: core/Group.js (Строка 1104)

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

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

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

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

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

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

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

Свойство дочернего элемента для проверки, например, 'exists', 'alive', 'health'
value any

Дочерний элемент соответствует, если child[key] === value имеет значение true.
returnType integer

Способ итерации по дочерним элементам и возвращаемое значение.
callback function <optional>
 null

Необязательная функция, которая будет вызвана для каждого соответствующего дочернего элемента. Соответствующий дочерний элемент передаётся в качестве первого аргумента.
callbackContext object <optional>

Контекст, в котором функция должна быть вызвана (обычно 'this').
args Array.<any> <optional>
 (none)

Аргументы, передаваемые в обратный вызов; индекс первого элемента массива (аргумент) будет заменён на соответствующий дочерний элемент.
Возвращаемое значение
any -

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

Унаследовано от
  • Phaser.Group#iterate
Исходный код: core/Group.js (Строка 1976)

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

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
group Phaser.Group

Новая группа, в которую будут перемещены дочерние элементы.
silent boolean <optional>
 false

Если true, дочерние элементы не будут вызывать событие onAddedToGroup для новой группы.
Возвращаемое значение
Phaser.Group -

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

Унаследовано от
  • Phaser.Group#moveAll
Исходный код: core/Group.js (Строка 2479)

moveDown(child) → {any}

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

Параметры
Имя Тип Описание
child any

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

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

Унаследовано от
  • Phaser.Group#moveDown
Исходный код: core/Group.js (Строка 969)

moveUp(child) → {any}

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

Параметры
Имя Тип Описание
child any

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

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

Унаследовано от
  • Phaser.Group#moveUp
Исходный код: core/Group.js (Строка 945)

multiplyAll(property, amount, checkAlive, checkVisible)

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

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

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

Унаследовано от
  • Phaser.Group#postUpdate
Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Group.js (Строка 1656)

<internal> preUpdate()

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

Унаследовано от
  • Phaser.Group#preUpdate
Внутренний:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/Group.js (Строка 1611)

previous() → {any}

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

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

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

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

Унаследовано от
  • Phaser.Group#previous
Исходный код: core/Group.js (Строка 862)

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

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

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

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

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

Дочерний элемент для удаления.
destroy boolean <optional>
 false

Если true, destroy будет вызван для удалённого дочернего элемента.
silent boolean <optional>
 false

Если true, дочерний элемент не будет вызывать событие onRemovedFromGroup.
Возвращаемое значение
boolean -

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

Унаследовано от
  • Phaser.Group#remove
Исходный код: core/Group.js (Строка 2431)

removeAll(destroy, silent, destroyTexture)

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

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

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

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

Параметры
Имя Тип Описание
child DisplayObject

Объект отображения, который нужно удалить из хэша этого Group. Должен быть членом этого Group и находиться в хэше.
Возвращаемое значение
boolean -

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

Унаследовано от
  • Phaser.Group#removeFromHash
Исходный код: core/Group.js (Строка 464)

replace(oldChild, newChild) → {any}

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

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

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

Параметры
Имя Тип Описание
oldChild any

Потомок в этом group, который будет заменён.
newChild any

Потомок, который должен быть вставлен в этот group.
Возвращаемое значение
any -

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

Унаследовано от
  • 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)

resize(width, height)

Обновляет размер этого мира. Обратите внимание, что это не изменяет координаты мира x/y, а только ширину и высоту.

Параметры
Имя Тип Описание
width number

Новая ширина игрового мира в пикселях.
height number

Новая высота игрового мира в пикселях.
Исходный код: core/World.js (Строка 125)

reverse()

Инвертирует всех потомков в этом group.

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

Унаследовано от
  • Phaser.Group#reverse
Исходный код: core/Group.js (Строка 1015)

sendToBack(child) → {any}

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

Параметры
Имя Тип Описание
child any

Потомок, который нужно отправить в конец этого group.
Возвращаемое значение
any -

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

Inherited From
  • Phaser.Group#sendToBack
Source code: core/Group.js (Line 926)

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

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

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

Parameters
Name Type Argument Default Description
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 и свойство не существует, ничего устанавливаться не будет.
Returns
boolean -

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

Inherited From
  • Phaser.Group#set
Source code: core/Group.js (Line 1246)

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

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

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

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

Parameters
Name Type Argument Default Description
key string

Свойство, в виде строки, которое будет установлено. Например: 'body.velocity.x'
value any

Значение, которое будет установлено.
checkAlive boolean <optional>
 false

Если установлено, то будут обновляться только дочерние элементы с alive=true. Это включает в себя любые группы, являющиеся дочерними.
checkVisible boolean <optional>
 false

Если установлено, то будут обновляться только дочерние элементы с visible=true. Это включает в себя любые группы, являющиеся дочерними.
operation integer <optional>
 0

Управляет тем, как присваивается значение. Значение 0 заменяет значение новым. Значение 1 добавляет его, 2 вычитает его, 3 умножает его, а 4 делит его.
force boolean <optional>
 false

Если force равно true, то свойство будет установлено для дочернего элемента независимо от того, существует оно уже или нет. Если false и свойство не существует, ничего устанавливаться не будет.
Inherited From
  • Phaser.Group#setAll
Source code: core/Group.js (Line 1277)

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

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

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

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

Parameters
Name Type Argument Default Description
key string

Свойство, в виде строки, которое будет установлено. Например: 'body.velocity.x'
value any

Значение, которое будет установлено.
checkAlive boolean <optional>
 false

Если установлено, то будут обновляться только дочерние элементы с alive=true. Это включает в себя любые группы, являющиеся дочерними.
checkVisible boolean <optional>
 false

Если установлено, то будут обновляться только дочерние элементы с visible=true. Это включает в себя любые группы, являющиеся дочерними.
operation integer <optional>
 0

Управляет тем, как присваивается значение. Значение 0 заменяет значение новым. Значение 1 добавляет его, 2 вычитает его, 3 умножает его, а 4 делит его.
force boolean <optional>
 false

Если force равно true, то свойство будет установлено для дочернего элемента независимо от того, существует оно уже или нет. Если false и свойство не существует, ничего устанавливаться не будет.
Inherited From
  • Phaser.Group#setAllChildren
Source code: core/Group.js (Line 1312)

setBounds(x, y, width, height)

Обновляет размер этого мира и устанавливает World.x/y в заданные значения
Границы камеры и границы физики (если установлены) также обновляются в соответствии с новыми границами мира.

Parameters
Имя Тип Описание
x число

Координаты верхнего левого угла мира.
y число

Координаты верхнего левого угла мира.
width число

Новая ширина игрового мира в пикселях.
height число

Новая высота игрового мира в пикселях.
Исходный код: core/World.js (Строка 94)

setChildIndex(child, index)

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

Параметры
Имя Тип Описание
child DisplayObject

Экземпляр дочернего элемента DisplayObject, для которого нужно изменить индекс.
index Число

Результирующий индекс для дочернего элемента отображения.
Унаследовано от
  • PIXI.DisplayObjectContainer#setChildIndex
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 132)

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

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

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

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

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

Массив строк, составляющих свойство, которое будет установлено.
value любой тип

Значение, которое будет установлено.
operation целое число <необязательно>
 0

Управляет способом назначения значения. Значение 0 заменяет значение новым. Значение 1 добавляет его, 2 вычитает, 3 умножает, а 4 делит.
force логическое значение <необязательно>
 false

Если force равно true, свойство будет установлено для дочернего элемента независимо от того, существует оно или нет. Если false и свойство не существует, ничего не будет установлено.
Возвращаемое значение
логическое значение -

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

Унаследовано от
  • Phaser.Group#setProperty
Исходный код: core/Group.js (Строка 1139)

shutdown()

Уничтожение мира.

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

sort(key, order)

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

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

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

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

Параметры
Имя Тип Аргумент По умолчанию Описание
key строка <необязательно>
 'z'

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

Порядок сортировки — возрастающий (SORT_ASCENDING) или убывающий (SORT_DESCENDING).
Унаследовано от
  • Phaser.Group#sort
Исходный код: core/Group.js (Строка 1855)

<internal> stateChange()

Вызывается при каждом изменении состояния или сбросе.

Сбрасывает координаты world.x и world.y обратно к нулю, затем сбрасывает камеру.

Внутреннее:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Исходный код: core/World.js (Строка 76)

subAll(property, amount, checkAlive, checkVisible)

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

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

Параметры
Имя Тип Описание
property строка

Свойство для уменьшения, например 'body.velocity.x' или 'angle'.
amount число

Количество для вычитания из свойства. Если child.x = 50, то subAll('x', 40) сделает child.x = 10.
checkAlive логическое значение

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

Если true, свойство будет изменено только если дочерний элемент видим.
Унаследовано от
  • Phaser.Group#subAll
Исходный код: core/Group.js (Строка 1403)

swap(child1, child2)

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

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

Параметры
Имя Тип Описание
child1 any

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

Второй дочерний элемент для обмена.
Унаследовано от
  • Phaser.Group#swap
Исходный код: core/Group.js (Строка 891)

swapChildren(child, child2)

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

Параметры
Имя Тип Описание
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)

wrap(sprite, padding, useBounds, horizontal, vertical)

Этот метод принимает заданный объект игры и проверяет, выходят ли его координаты x/y за пределы границ мира.
Если да, он переместит объект на противоположную сторону мира, создавая эффект обхода.
Если у sprite есть физическое тело P2, то тело (sprite.body) должно быть передано в качестве первого параметра функции.

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
sprite Phaser.Sprite | Phaser.Image | Phaser.TileSprite | Phaser.Text

Объект, который вы хотите обходить по границам мира.
padding number <optional>
 0

Дополнительный отступ, добавляемый поровну к координатам sprite.x и y перед проверкой, находятся ли они в пределах границ мира. Игнорируется, если useBounds равен true.
useBounds boolean <optional>
 false

Если useBounds равен false, обход проверяет координаты объекта.x/y. Если true, выполняется более точная проверка границ, что дороже.
horizontal boolean <optional>
 true

Если horizontal равен false, обход не будет обходить координаты объекта.x по горизонтали.
vertical boolean <optional>
 true

Если vertical равен false, обход не будет обходить координаты объекта.y по вертикали.
Исходный код: core/World.js (Строка 170)

xy(index, x, y)

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

Параметры
Имя Тип Описание
index integer

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

Новая позиция x дочернего элемента.
y number

Новая позиция 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.World.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API