Класс: Phaser.Stage

Конструктор

new Stage(game)

Объект Stage управляет объектами отображения корневого уровня, на которых отображается всё остальное.
Он также обрабатывает управление видимостью браузера и паузу из-за потери фокуса.

Параметры

Имя	Тип	Описание
`game`	Phaser.Game	Ссылка на текущую запущенную игру.

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

Расширяет

PIXI.DisplayObjectContainer

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

backgroundColor : number | string

Получает и устанавливает цвет фона сцены. Цвет может быть задан числом: 0xff0000 или шестнадцатеричной строкой: '#ff0000'

Тип

number | string

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

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

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

Тип

Array.<DisplayObject>

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

PIXI.DisplayObjectContainer#children

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

currentRenderOrderID : number

Сбрасывается каждый кадр, хранит счёт общего количества обновлённых объектов.

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

disableVisibilityChange : boolean

По умолчанию, если вкладка браузера теряет фокус, игра приостанавливается.
Вы можете остановить это поведение, установив это свойство в значение true.
Обратите внимание, что браузер всё ещё может приостановить игру, если захочет, например, при переключении на другую вкладку браузера. Это приведёт к остановке обратного вызова RAF,
что фактически приостановит вашу игру, даже если событие паузы в игре не будет вызываться, если вы включите это свойство.

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

exists : boolean

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

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

true

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

game : Phaser.Game

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

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

height : number

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

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

PIXI.DisplayObjectContainer#height

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

ignoreChildInput : boolean

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

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

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

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

PIXI.DisplayObjectContainer#ignoreChildInput

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

name : string

Имя этого объекта.

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

_stage_root

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

smoothed : boolean

Включить или отключить сглаживание текстур для всех объектов на этой сцене. Работает только для текстур bitmap/image. Сглаживание включено по умолчанию. Установите в значение true для сглаживания всех спрайтов, отрисованных на этой сцене, или в значение false для отключения сглаживания (хорошо подходит для пиксельной графики).

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

width : number

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

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

PIXI.DisplayObjectContainer#width

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

Общественные методы

addChild(child) → {DisplayObject}

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

Parameters

Name	Type	Описание
`child`	DisplayObject	DisplayObject, который нужно добавить в контейнер

Returns

DisplayObject -

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

Inherited From

PIXI.DisplayObjectContainer#addChild

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

addChildAt(child, index) → {DisplayObject}

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

Parameters

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

Returns

DisplayObject -

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

Inherited From

PIXI.DisplayObjectContainer#addChildAt

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

checkVisibility()

Запускает обработчик событий видимости страницы или window.onpagehide/onpageshow, если они не поддерживаются браузером.
Также прослушивает события window.onblur и window.onfocus.

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

contains(child) → {Boolean}

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

Parameters

Name	Type	Описание
`child`	DisplayObject	-

Returns

Boolean -

Inherited From

PIXI.DisplayObjectContainer#contains

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

destroy()

Уничтожает сцену и удаляет обработчики событий.

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

getBounds(targetCoordinateSpace) → {Rectangle}

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

Parameters

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

Returns

Rectangle -

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

Inherited From

PIXI.DisplayObjectContainer#getBounds

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

getChildAt(index) → {DisplayObject}

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

Parameters

Name	Type	Описание
`index`	Number	Индекс, по которому нужно получить дочерний элемент

Returns

DisplayObject -

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

Inherited From

PIXI.DisplayObjectContainer#getChildAt

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

getChildIndex(child) → {Number}

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

Parameters

Name	Type	Описание
`child`	DisplayObject	Экземпляр DisplayObject для идентификации

Returns

Number -

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

Inherited From

PIXI.DisplayObjectContainer#getChildIndex

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

getLocalBounds() → {Rectangle}

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

Returns

Rectangle -

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

Inherited From

PIXI.DisplayObjectContainer#getLocalBounds

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

<internal> parseConfig(config)

Парсит объект конфигурации игры.

Parameters

Name	Type	Описание
`config`	object	Объект конфигурации для парсинга.

Внутренний:

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

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

postUpdate()

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

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

preUpdate()

Вызывается автоматически после preUpdate плагинов и перед обновлением состояния (State.update).
Большинство объектов имеют методы preUpdate, и именно там происходит первоначальное перемещение и позиционирование.

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

removeChild(child) → {DisplayObject}

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

Параметры

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

Возвращает

DisplayObject -

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

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

PIXI.DisplayObjectContainer#removeChild

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

removeChildAt(index) → {DisplayObject}

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

Параметры

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

Возвращает

DisplayObject -

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

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

PIXI.DisplayObjectContainer#removeChildAt

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

removeChildren(beginIndex, endIndex)

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

Параметры

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

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

PIXI.DisplayObjectContainer#removeChildren

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

setBackgroundColor(color)

Устанавливает цвет фона для сцены.

Цвет может быть задан в виде шестнадцатеричной строки ('#RRGGBB'), строки CSS ('rgb(r,g,b)') или числового значения (0xRRGGBB).

Альфа-канал не поддерживается и будет проигнорирован.

Если игра настроена на прозрачность, вызовы setBackgroundColor игнорируются.

Параметры

Имя	Тип	Описание
`color`	число \| строка	Цвет фона.

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

setChildIndex(child, index)

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

Параметры

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

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

PIXI.DisplayObjectContainer#setChildIndex

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

swapChildren(child, child2)

Меняет позиции 2 объектов Display внутри этого контейнера.

Параметры

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

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

PIXI.DisplayObjectContainer#swapChildren

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

update()

Вызывается автоматически после обновления состояния (State.update), но перед обновлением частиц или плагинов.

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

updateTransform()

Обновляет преобразования для всех объектов в списке отображения.
Переопределяет значение по умолчанию Pixi, так как нам не нужен interactionManager, но необходима проверка свойства game.

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

visibilityChange(event)

Этот метод вызывается при изменении видимости документа.

Параметры

Имя	Тип	Описание
`event`	Событие	Его тип будет использован для определения того, нужно ли приостановить игру или нет.

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