Класс: Phaser.Image

Конструктор

new Image(game, x, y, key, frame)

Параметры

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

Расширяет

• PIXI.Sprite
• Phaser.Component.Core
• Phaser.Component.Angle
• Phaser.Component.Animation
• Phaser.Component.AutoCull
• Phaser.Component.Bounds
• Phaser.Component.BringToTop
• Phaser.Component.Crop
• Phaser.Component.Destroy
• Phaser.Component.FixedToCamera
• Phaser.Component.InputEnabled
• Phaser.Component.LifeSpan
• Phaser.Component.LoadTexture
• Phaser.Component.Overlap
• Phaser.Component.Reset
• Phaser.Component.ScaleMinMax
• Phaser.Component.Smoothed

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

alive : boolean

Полезный флаг для управления тем, жив объект Game Object или нет.

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

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

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

• Phaser.Component.LifeSpan#alive

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

• true

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

anchor :Point

Якорь устанавливает исходную точку текстуры.
По умолчанию это 0,0, что означает, что исходная точка текстуры находится в левом верхнем углу.
Установка якоря в 0,5;0,5 означает, что исходная точка текстуры находится посередине.
Установка якоря в 1;1 означает, что исходная точка текстуры будет в правом нижнем углу.

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

• PIXI.Sprite#anchor

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

angle : number

Свойство угла — это поворот объекта Game Object в градусах от его первоначального ориентации.

Значения от 0 до 180 представляют поворот по часовой стрелке; значения от 0 до -180 представляют поворот против часовой стрелки.

Значения вне этого диапазона добавляются или вычитаются из 360, чтобы получить значение в пределах диапазона.
Например, оператор player.angle = 450 эквивалентен player.angle = 90.

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

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

• Phaser.Component.Angle#angle

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

animations : Phaser.AnimationManager

Если объект Game Object включен для анимации (например, Phaser.Sprite), это ссылка на экземпляр его AnimationManager.
Через него вы можете создавать, воспроизводить, приостанавливать и останавливать анимации.

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

• Phaser.Component.Core#animations

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

См.

• Phaser.AnimationManager

autoCull : boolean

Объект Game Object с autoCull равным true будет проверять свои границы по отношению к камере World каждый кадр.
Если он не пересекает границы камеры в какой-либо момент, его свойство renderable устанавливается в false.
Это сохраняет объект Game Object живым и по-прежнему обрабатывает обновления, но принудительно пропускает этап отрисовки.

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

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

• Phaser.Component.AutoCull#autoCull

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

blendMode : number

Режим смешивания, который должен быть применен к спрайту. Установите значение PIXI.blendModes.NORMAL, чтобы убрать режим смешивания.

Предупреждение: вы не можете иметь режим смешивания и фильтр, активные на одном и том же спрайте. В противном случае спрайт станет невидимым.

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

• PIXI.Sprite#blendMode

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

• PIXI.blendModes.NORMAL;

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

bottom : number

Сумма свойств y и height.
Это то же самое, что и y + height - offsetY.

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

• Phaser.Component.Bounds#bottom

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

cameraOffset : Phaser.Point

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

Значения относятся к верхнему левому углу области обзора камеры и дополнительно к любому родительскому элементу объекта Game Object в списке отображения.

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

• Phaser.Component.FixedToCamera#cameraOffset

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

centerX : number

Координата центра по оси x объекта Game Object.
Это то же самое, что и (x - offsetX) + (width / 2).

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

• Phaser.Component.Bounds#centerX

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

centerY : number

Координата центра по оси y объекта Game Object.
Это то же самое, что и (y - offsetY) + (height / 2).

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

• Phaser.Component.Bounds#centerY

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

[readonly] children : Array.<DisplayObject>

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

Тип

• Array.<DisplayObject>

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

• PIXI.DisplayObjectContainer#children

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

<internal> components : Object

Компоненты, установленные в этом объекте Game Object.

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

• Phaser.Component.Core#components

Внутреннее:

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

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

cropRect : Phaser.Rectangle

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

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

• Phaser.Component.Crop#cropRect

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

data : Object

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

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

• Phaser.Component.Core#data

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

• {}

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

debug : boolean

Флаг отладки, предназначенный для использования с Game.enableStep.

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

• Phaser.Component.Core#debug

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

[только для чтения] destroyPhase : boolean

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

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

• Phaser.Component.Destroy#destroyPhase

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

events : Phaser.Events

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

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

• Phaser.Component.Core#events

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

См.

• Phaser.Events

exists : boolean

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

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

• PIXI.Sprite#exists

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

• true

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

fixedToCamera : boolean

Объект игры, «привязанный» к камере, использует свои координаты x/y в качестве смещений от левого верхнего угла камеры во время отрисовки.

Значения корректируются на стадии отрисовки, перезаписывая фактическое мировое положение объекта игры.

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

Смещения хранятся в свойстве cameraOffset.

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

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

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

• Phaser.Component.FixedToCamera#fixedToCamera

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

frame : integer

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

Чтобы изменить кадр, установите frame в индекс нового кадра в спрайт-листе, который вы хотите использовать для этого объекта игры,
например: player.frame = 4.

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

Если вы используете атлас текстур, используйте свойство frameName вместо этого.

Если вы хотите полностью заменить используемую текстуру, см. loadTexture.

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

• Phaser.Component.LoadTexture#frame

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

frameName : string

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

Чтобы изменить кадр, установите frameName в имя нового кадра в атласе текстур, который вы хотите использовать для этого объекта игры,
например: player.frameName = "idle".

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

Если вы используете спрайт-лист, используйте свойство frame вместо этого.

Если вы хотите полностью заменить используемую текстуру, см. loadTexture.

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

• Phaser.Component.LoadTexture#frameName

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

[только для чтения] fresh : boolean

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

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

• Phaser.Component.Core#fresh

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

game : Phaser.Game

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

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

• Phaser.Component.Core#game

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

height : number

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

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

• PIXI.Sprite#height

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

ignoreChildInput : boolean

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

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

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

Inherited From

• PIXI.DisplayObjectContainer#ignoreChildInput

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

[readonly] inCamera : boolean

Проверяет, пересекаются ли границы объекта Game Objects с границами Game Camera.
Возвращает true если пересекаются, иначе false если полностью за пределами границ камеры.

Inherited From

• Phaser.Component.AutoCull#inCamera

Source code: gameobjects/components/AutoCull.js (Line 37)

input : Phaser.InputHandler | null

Обработчик ввода для этого объекта Game Object.

По умолчанию отключен. Если вы хотите, чтобы этот объект Game Object обрабатывал события ввода, включите его с помощью: inputEnabled = true.

После этого свойство будет ссылаться на обработчик Phaser InputHandler.

Type

• Phaser.InputHandler | null

Inherited From

• Phaser.Component.InputEnabled#input

Source code: gameobjects/components/InputEnabled.js (Line 24)

inputEnabled : boolean

По умолчанию объект Game Object не обрабатывает события ввода. Установив inputEnabled в значение true, создается Phaser.InputHandler для этого объекта Game Object, и он начнет обрабатывать события клика/нажатия и другие.

Затем вы можете получить доступ к обработчику ввода с помощью this.input.

Обратите внимание, что события, связанные с вводом, отправляются из this.events, т.е.: events.onInputDown.

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

Если вы хотите временное отключение обработки ввода для объекта Game Object, лучше установить input.enabled = false, так как это не будет сбрасывать внутренние свойства обработчика ввода.
Затем вы можете переключать это по мере необходимости.

Inherited From

• Phaser.Component.InputEnabled#inputEnabled

Source code: gameobjects/components/InputEnabled.js (Line 42)

key : string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture

Ключ изображения или текстуры, используемой этим объектом Game Object при отрисовке.
Если это строка, это строка, используемая для извлечения текстуры из кэша изображений Phaser.
Это также может быть экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
Если объект Game Object создан без ключа, ему автоматически назначается ключ __default, который представляет собой 32x32 прозрачный PNG, хранящийся в кэше.
Если объекту Game Object присваивается ключ, которого нет в кэше изображений, ему повторно назначается ключ __missing, который представляет собой 32x32 PNG зеленого прямоугольника с линией через него.

Type

• string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture

Inherited From

• Phaser.Component.Core#key

Source code: gameobjects/components/Core.js (Line 203)

left : number

Координата слева объекта Game Object.
Это то же самое, что и x - offsetX.

Inherited From

• Phaser.Component.Bounds#left

Source code: gameobjects/components/Bounds.js (Line 102)

lifespan : number

Свойство lifespan позволяет задать объекту Game Object срок жизни в миллисекундах.

После «рождения» объекта Game Object вы можете установить это свойство в положительное значение.

Оно автоматически уменьшается на эквивалент game.time.physicsElapsed миллисекунд в каждой кадре.
Когда значение достигает нуля, вызывается метод kill.

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

Inherited From

• Phaser.Component.LifeSpan#lifespan

Source code: gameobjects/components/LifeSpan.js (Line 65)

name : string

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

Inherited From

• Phaser.Component.Core#name

Source code: gameobjects/components/Core.js (Line 150)

[readonly] offsetX : number

Смещение объекта Game Object по горизонтали от его координаты x.
Это то же самое, что и width * anchor.x.
Будет больше 0 только если anchor.x не равно нулю.

Inherited From

• Phaser.Component.Bounds#offsetX

Source code: gameobjects/components/Bounds.js (Line 24)

[readonly] offsetY : number

Смещение объекта Game Object по вертикали от его координаты y.
Это то же самое, что и height * anchor.y.
Будет больше 0 только если anchor.y не равно нулю.

Inherited From

• Phaser.Component.Bounds#offsetY

Source code: gameobjects/components/Bounds.js (Line 42)

pendingDestroy : boolean

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

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

Inherited From

• Phaser.Component.Core#pendingDestroy

Source code: gameobjects/components/Core.js (Line 259)

[readonly] previousPosition : Phaser.Point

Позиция объекта Game Object в предыдущем кадре.

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

• Phaser.Component.Core#previousPosition

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

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

Поворот объекта Game Object в предыдущем кадре. Значение в радианах.

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

• Phaser.Component.Core#previousRotation

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

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

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

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

• Phaser.Component.Core#renderOrderID

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

right : число

Правая координата объекта Game Object.
Это то же самое, что и x + width - offsetX.

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

• Phaser.Component.Bounds#right

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

scaleMax : Phaser.Point

Максимальное масштабирование, до которого объект Game Object будет масштабироваться.

Это позволяет предотвратить масштабирование родительского элемента этого объекта Game Object выше заданного значения.

Установите в null , чтобы убрать ограничение.

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

• Phaser.Component.ScaleMinMax#scaleMax

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

scaleMin : Phaser.Point

Минимальный масштаб, до которого объект Game Object будет масштабироваться.

Это позволяет предотвратить масштабирование родительского элемента этого объекта Game Object ниже заданного значения.

Установите в null , чтобы убрать ограничение.

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

• Phaser.Component.ScaleMinMax#scaleMin

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

shader : PIXI.AbstractFilter

Шейдер, который будет использоваться для отрисовки этого Sprite.
Установите в null, чтобы удалить текущий шейдер.

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

• PIXI.Sprite#shader

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

• null

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

smoothed : логическое

Включить или выключить сглаживание текстуры для этого объекта Game Object.

Это работает только в том случае, если объект Game Object использует текстуру на основе изображения.

Сглаживание включено по умолчанию.

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

• Phaser.Component.Smoothed#smoothed

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

texture : PIXI.Texture

Текстура, используемая спрайтом

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

• PIXI.Sprite#texture

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

tint : число

Оттенок, применяемый к спрайту. Это шестнадцатеричное значение. Значение 0xFFFFFF удалит любой эффект тона.

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

• PIXI.Sprite#tint

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

• 0xFFFFFF

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

tintedTexture : Canvas

Canvas, содержащий затонированную версию Sprite (в режиме Canvas, WebGL это не заполняет)

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

• PIXI.Sprite#tintedTexture

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

• null

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

top : число

Координата y объекта Game Object.
Это то же самое, что и y - offsetY.

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

• Phaser.Component.Bounds#top

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

transformCallback : функция

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

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

• Phaser.Component.ScaleMinMax#transformCallback

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

transformCallbackContext : объект

Контекст, в котором вызывается transformCallback.

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

• Phaser.Component.ScaleMinMax#transformCallbackContext

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

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

Тип const этого объекта.

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

width : число

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

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

• PIXI.Sprite#width

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

world : Phaser.Point

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

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

• Phaser.Component.Core#world

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

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

Глубина z этого объекта игры в его родительской группе.
Два объекта в группе не могут иметь одинаковое значение z.
Это значение автоматически корректируется при изменении иерархии группы.
Если вы хотите изменить порядок отображения объекта игры, см. такие методы, как Group.moveUp или Group.bringToTop.

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

• Phaser.Component.Core#z

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

Общедоступные методы

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	Число	Индекс для размещения дочернего элемента

Returns

DisplayObject -

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

Inherited From

• PIXI.DisplayObjectContainer#addChildAt

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

alignIn(container, position, offsetX, offsetY) → {Object}

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

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

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

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

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.

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

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

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

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

Parameters

Имя	Тип	Аргумент	Значение по умолчанию	Описание
container	Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite			Объект Game или Rectangle, к которому нужно выровнять этот объект Game Object. Может включать свойства, такие как World.bounds или Camera.view.
position	целое число	<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.
offsetX	целое число	<optional>	0	Горизонтальная корректировка границ контейнера, применённая к выровненному положению объекта Game Object. Использование отрицательного значения уменьшит границы, положительного — увеличит.
offsetY	целое число	<optional>	0	Вертикальная корректировка границ контейнера, применённая к выровненному положению объекта Game Object. Использование отрицательного значения уменьшит границы, положительного — увеличит.

Returns

Объект -

Этот объект Game Object.

Inherited From

• Phaser.Component.Bounds#alignIn

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

alignTo(parent, position, offsetX, offsetY) → {Object}

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

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

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

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

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.

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

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

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

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

Parameters

Имя	Тип	Аргумент	По умолчанию	Описание
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.Component.Bounds#alignTo

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

bringToTop() → {PIXI.DisplayObject}

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

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

Возвращает

PIXI.DisplayObject -

Этот экземпляр.

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

• Phaser.Component.BringToTop#bringToTop

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

contains(child) → {Boolean}

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

Параметры

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

Возвращает

Boolean -

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

• PIXI.DisplayObjectContainer#contains

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

crop(rect, copy)

Обрезка позволяет обрезать текстуру, используемую для отображения этого объекта игры.
Установка прямоугольника обрезки изменяет фрейм основной текстуры. Свойства ширины и высоты объекта игры будут соответствующим образом скорректированы.

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

Объект прямоугольника, предоставляемый этому методу, может быть Phaser.Rectangle или любым другим объектом,
при условии, что у него есть открытые свойства x, y, width, height, right и bottom.

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

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
rect	Phaser.Rectangle			Прямоугольник, используемый при обрезке. Передача null или отсутствие параметров очищает ранее установленный прямоугольник обрезки.
copy	boolean	<необязательно>	false	Если false, cropRect будет храниться как ссылка на заданный прямоугольник. Если true, значения прямоугольника будут скопированы в локальный объект Phaser Rectangle, хранящийся в cropRect.

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

• Phaser.Component.Crop#crop

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

destroy(destroyChildren, destroyTexture)

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

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

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

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
destroyChildren	boolean	<необязательно>	true	Должен ли вызываться метод destroy для каждого дочернего объекта этого объекта?
destroyTexture	boolean	<необязательно>	false	Уничтожить BaseTexture, используемую данным объектом игры? Обратите внимание, что если другой объект игры использует ту же BaseTexture, она будет сделана недействительной.

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

• Phaser.Component.Destroy#destroy

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

getBounds(matrix) → {Rectangle}

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

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

Параметры

Имя	Тип	Описание
matrix	Матрица	матрица преобразования спрайта

Возвращает

Rectangle -

прямоугольник обрамления

Inherited From

• PIXI.Sprite#getBounds

Source code: pixi/display/Sprite.js (Line 199)

getChildAt(index) → {DisplayObject}

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

Parameters

Name	Type	Описание
index	Number	Индекс дочернего элемента

Returns

DisplayObject -

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

Inherited From

• PIXI.DisplayObjectContainer#getChildAt

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

getChildIndex(child) → {Number}

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

Parameters

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

Returns

Number -

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

Inherited From

• PIXI.DisplayObjectContainer#getChildIndex

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

getLocalBounds() → {Rectangle}

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

Returns

Rectangle -

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

Inherited From

• PIXI.Sprite#getLocalBounds

Source code: pixi/display/Sprite.js (Line 315)

kill() → {PIXI.DisplayObject}

Уничтожает объект Game Object. У уничтоженного объекта Game Object свойства alive, exists и visible установлены в false.

При этом будет отправлено событие onKilled. Вы можете прослушивать событие events.onKilled.

Уничтожение объекта Game Object — это способ быстрого его рециклирования в пуле объектов,
но не приводит к уничтожению объекта или освобождению памяти.

Если объект Game Object больше не нужен, следует вызвать метод destroy.

Returns

PIXI.DisplayObject -

Этот экземпляр.

Inherited From

• Phaser.Component.LifeSpan#kill

Source code: gameobjects/components/LifeSpan.js (Line 113)

loadTexture(key, frame, stopAnimation)

Изменяет базовую текстуру, используемую объектом Game Object. Старая текстура удаляется, а новая ссылается или извлекается из кэша.

Если ваш объект Game Object использует фрейм из атласа текстур, и вам нужно просто изменить фрейм, используйте свойства frame или frameName.

Используйте loadTexture только для полной замены базовой текстуры.

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

Вы можете использовать новую константу Phaser.PENDING_ATLAS в качестве ключа текстуры для любого спрайта.
Это задаёт ключ frame (фрейм устанавливается в ноль).

Это позволяет создавать спрайты с использованием load.image во время разработки, а затем изменять их на использование атласа текстур позже в разработке, просто найдя в коде 'PENDING_ATLAS'
и заменив его ключом данных атласа.

Примечание: RenderTexture нельзя использовать в качестве текстуры для TileSprite.

Parameters

Name	Type	Аргумент	По умолчанию	Описание
key	string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture			Изображение или текстура, используемая спрайтом во время отрисовки. Может быть строкой, являющейся ссылкой на запись в кэше изображения, или экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.
frame	string | number	<optional>		Если спрайт использует часть спрайт-листа или атласа текстур, можно указать конкретный фрейм, используя строку или числовой индекс.
stopAnimation	boolean	<optional>	true	Если на спрайте уже воспроизводится анимация, можно выбрать остановить её или позволить ей продолжить воспроизведение.

Inherited From

• Phaser.Component.LoadTexture#loadTexture

Source code: gameobjects/components/LoadTexture.js (Line 51)

moveDown() → {PIXI.DisplayObject}

Перемещает объект Game Object вниз на одну позицию в списке отображения родителя.
Если объект Game Object уже находится внизу списка отображения, этот вызов не имеет эффекта.

Если объект Game Object не добавлен в пользовательскую группу, этот метод переместит его на одну позицию вниз в игровом мире,
потому что Мир — это корневая группа, от которой происходят все объекты Game Object.

Returns

PIXI.DisplayObject -

Этот экземпляр.

Inherited From

• Phaser.Component.BringToTop#moveDown

Source code: gameobjects/components/BringToTop.js (Line 87)

moveUp() → {PIXI.DisplayObject}

Перемещает этот объект Game Object вверх на одну позицию в списке отображения родителя.
Если объект Game Object уже находится вверху списка отображения, этот вызов не имеет эффекта.

Если объект Game Object не добавлен в пользовательскую группу, этот метод переместит его на одну позицию вверх в игровом мире,
потому что Мир — это корневая группа, от которой происходят все объекты Game Object.

Returns

PIXI.DisplayObject -

Этот экземпляр.

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

• Phaser.Component.BringToTop#moveUp

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

overlap(displayObject) → {boolean}

Проверяет, перекрываются ли границы этого объекта Game Object с границами заданного объекта Display Object,
который может быть Sprite, Image, TileSprite или чем-либо, что расширяет их, таким как Button или предоставляет метод getBounds и результат.

Эта проверка игнорирует свойство hitArea при его наличии и выполняет сравнение getBounds обоих объектов, чтобы определить результат.

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

Параметры

Имя	Тип	Описание
displayObject	Phaser.Sprite | Phaser.Image | Phaser.TileSprite | Phaser.Button | PIXI.DisplayObject	Проверяемый объект отображения.

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

boolean -

True, если границы этого объекта Game Object пересекаются с границами заданного объекта отображения в любой точке.

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

• Phaser.Component.Overlap#overlap

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

play(name, frameRate, loop, killOnComplete) → {Phaser.Animation}

Проигрывает анимацию.

Анимация должна быть предварительно создана с помощью animations.add.

Если анимация уже воспроизводится, вызов этого метода не произведёт никаких действий.
Если необходимо перезапустить уже воспроизводимую анимацию, сделайте это непосредственно в объекте Animation или с помощью AnimationManager.stop.

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
name	string			Имя анимации для воспроизведения, например, "fire", "walk", "jump". Должно быть предварительно создано с помощью 'AnimationManager.add'.
frameRate	number	<необязательно>	null	Частота кадров для воспроизведения анимации. Скорость задаётся в кадрах в секунду. Если не указано, используется ранее установленная частота кадров анимации.
loop	boolean	<необязательно>	false	Нужно ли повторять анимацию после воспроизведения. Если не указано, используется ранее установленное значение циклического воспроизведения анимации.
killOnComplete	boolean	<необязательно>	false	Если установлено в значение true, родительский Sprite будет уничтожен по завершении анимации (происходит только если loop=false).

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

Phaser.Animation -

Ссылка на воспроизводимую анимацию.

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

• Phaser.Component.Animation#play

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

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

Внутренний метод, вызываемый циклом World postUpdate.

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

• Phaser.Component.Core#postUpdate

Внутренний:

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

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

preUpdate()

Автоматически вызывается World.preUpdate.

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

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)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#removeChildren

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

reset(x, y, health) → {PIXI.DisplayObject}

Сбрасывает состояние объекта игры.

Это перемещает объект игры в заданные координаты x/y глобального пространства и устанавливает fresh, exists,
visible и renderable в значение true.

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

Если у этого объекта игры есть физическое тело (Physics Body), оно будет сброшено.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
x	число			Координата x (в глобальном пространстве), в которой будет размещён объект игры.
y	число			Координата y (в глобальном пространстве), в которой будет размещён объект игры.
health	число	<необязательно>	1	Здоровье, которое будет присвоено объекту игры, если у него есть компонент Health.

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

PIXI.DisplayObject -

Этот экземпляр.

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

• Phaser.Component.Reset#reset

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

resetFrame()

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

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

• Phaser.Component.LoadTexture#resetFrame

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

resizeFrame(parent, width, height)

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

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

Параметры

Имя	Тип	Описание
parent	объект	Объект родительской текстуры, вызвавший изменение размера, например, объект Phaser.Video.
width	целое число	Новая ширина текстуры.
height	целое число	Новая высота текстуры.

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

• Phaser.Component.LoadTexture#resizeFrame

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

revive(health) → {PIXI.DisplayObject}

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

Возрождённый объект игры имеет свойства alive, exists и visible, все установленные в значение true.

Он будет отправлять событие onRevived. Подпишитесь на events.onRevived для получения сигнала.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
health	число	<необязательно>	100	Здоровье, которое будет присвоено объекту игры. Устанавливается только если у объекта есть компонент Health.

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

PIXI.DisplayObject -

Этот экземпляр.

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

• Phaser.Component.LifeSpan#revive

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

sendToBack() → {PIXI.DisplayObject}

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

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

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

PIXI.DisplayObject -

Этот экземпляр.

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

• Phaser.Component.BringToTop#sendToBack

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

setChildIndex(child, index)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#setChildIndex

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

setFrame(frame)

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

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

Параметры

Имя	Тип	Описание
frame	Phaser.Frame	Рамка, которая должна использоваться текстурой.

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

• Phaser.Component.LoadTexture#setFrame

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

setScaleMinMax(minX, minY, maxX, maxY)

Устанавливает значения scaleMin и scaleMax. Эти значения используются для ограничения того, насколько сильно данный объект Game Object будет масштабироваться относительно своего родителя.

Например, если у данного объекта Game Object значение minScale равно 1, а у его родителя значение scale равно 0,5, значение 0,5 будет проигнорировано,
и будет использовано значение масштаба 1, так как масштаб родителя меньше минимального масштаба, к которому должен придерживаться данный объект Game Object.

Устанавливая эти значения, вы можете тщательно контролировать, как объекты Game Object обрабатывают адаптивное масштабирование.

Если задан только один параметр, то это значение будет использоваться для обоих scaleMin и scaleMax:
setScaleMinMax(1) = scaleMin.x, scaleMin.y, scaleMax.x и scaleMax.y все = 1

Если заданы два параметра, первый устанавливается как scaleMin.x и y, а второй как scaleMax.x и y:
setScaleMinMax(0.5, 2) = scaleMin.x и y = 0,5 и scaleMax.x и y = 2

Если вы хотите установить scaleMin с разными значениями для x и y, то либо измените Game Object.scaleMin напрямую,
либо передайте null для параметров maxX и maxY.

Вызовите setScaleMinMax(null) для очистки всех ранее заданных значений.

Параметры

Имя	Тип	Описание
minX	число | null	Минимальное горизонтальное значение масштаба, до которого объект Game Object может уменьшаться.
minY	число | null	Минимальное вертикальное значение масштаба, до которого объект Game Object может уменьшаться.
maxX	число | null	Максимальное горизонтальное значение масштаба, до которого объект Game Object может увеличиваться.
maxY	число | null	Максимальное вертикальное значение масштаба, до которого объект Game Object может увеличиваться.

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

• Phaser.Component.ScaleMinMax#setScaleMinMax

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

setTexture(texture, destroy)

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
texture	PIXI.Texture			Текстура PIXI, отображаемая спрайтом
destroy	Булево	<необязательно>	false	Вызвать Texture.destroy для текущей текстуры перед заменой ее новой?

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

• PIXI.Sprite#setTexture

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

swapChildren(child, child2)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#swapChildren

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

update()

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

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

• Phaser.Component.Core#update

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

updateCrop()

Если вы установили прямоугольник обрезки для этого объекта Game Object с помощью crop и с тех пор изменили свойство cropRect
или прямоугольник, на который оно ссылается, тогда вам необходимо обновить кадр обрезки, вызвав этот метод.

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

• Phaser.Component.Crop#updateCrop

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