Класс: Phaser.Sprite

Конструктор

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

Параметры

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

Расширяет

• 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.Delta
• Phaser.Component.Destroy
• Phaser.Component.FixedToCamera
• Phaser.Component.Health
• Phaser.Component.InCamera
• Phaser.Component.InputEnabled
• Phaser.Component.InWorld
• Phaser.Component.LifeSpan
• Phaser.Component.LoadTexture
• Phaser.Component.Overlap
• Phaser.Component.PhysicsBody
• Phaser.Component.Reset
• Phaser.Component.ScaleMinMax
• Phaser.Component.Smoothed

Свойства публичного доступа

alive : boolean

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

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

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

Inherited From

• Phaser.Component.LifeSpan#alive

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

• true

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

anchor :Point

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

Inherited From

• PIXI.Sprite#anchor

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

angle : number

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

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

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

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

Inherited From

• Phaser.Component.Angle#angle

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

animations : Phaser.AnimationManager

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

Inherited From

• Phaser.Component.Core#animations

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

См.

• Phaser.AnimationManager

autoCull : boolean

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

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

Inherited From

• Phaser.Component.AutoCull#autoCull

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

blendMode : number

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

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

Inherited From

• PIXI.Sprite#blendMode

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

• PIXI.blendModes.NORMAL;

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

body : Phaser.Physics.Arcade.Body | Phaser.Physics.P2.Body | Phaser.Physics.Ninja.Body | null

Физическое тело Game Object. После того, как Game Object включён для физики, вы можете получить доступ ко всем связанным
свойствам и методам через него.

По умолчанию Game Objects не добавляют себя к никакой физической системе, и их свойство body будет null.

Чтобы включить этот Game Object для физики, необходимо вызвать game.physics.enable(object, system), где object — это объект,
а system — используемая физическая система. Если не указано, используется Phaser.Physics.Arcade.

Вы также можете вызвать game.physics.arcade.enable(object), или добавить этот Game Object в группу, включённую в физику.

Важно: Включение Game Object для физики P2 или Ninja автоматически установит его свойство anchor в 0,5,
чтобы физическое тело было центрировано на Game Object.

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

Тип

• Phaser.Physics.Arcade.Body | Phaser.Physics.P2.Body | Phaser.Physics.Ninja.Body | null

Inherited From

• Phaser.Component.PhysicsBody#body

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

bottom : number

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

Inherited From

• Phaser.Component.Bounds#bottom

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

cameraOffset : Phaser.Point

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

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

Inherited From

• Phaser.Component.FixedToCamera#cameraOffset

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

centerX : number

Центральная координата x Game Object.
Это то же самое, что и (x - offsetX) + (width / 2).

Inherited From

• Phaser.Component.Bounds#centerX

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

centerY : number

Центральная координата y Game Object.
Это то же самое, что и (y - offsetY) + (height / 2).

Inherited From

• Phaser.Component.Bounds#centerY

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

checkWorldBounds : boolean

Если этот параметр установлен в true , объект Game Object проверяет, находится ли он в границах мира каждый кадр.

Когда он больше не пересекается с границами мира, он отправляет событие onOutOfBounds.

Если он ранее находился за пределами границ, но теперь снова пересекает границы мира, он отправляет событие onEnterBounds.

Он также по желанию уничтожает объект Game Object, если outOfBoundsKill равен true.

При включении checkWorldBounds объект Game Object принудительно рассчитывает свои полные границы каждый кадр.

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

Inherited From

• Phaser.Component.InWorld#checkWorldBounds

Source code: gameobjects/components/InWorld.js (Line 98)

[readonly] children : Array.<DisplayObject>

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

Type

• Array.<DisplayObject>

Inherited From

• PIXI.DisplayObjectContainer#children

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

<internal> components : Object

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

Inherited From

• Phaser.Component.Core#components

Внутреннее:

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

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

cropRect : Phaser.Rectangle

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

Inherited From

• Phaser.Component.Crop#cropRect

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

damage

Наносит урон объекту Game Object. Это уменьшает заданное количество здоровья из свойства health.

Если здоровье уменьшено ниже или равно нулю, вызывается метод kill.

Inherited From

• Phaser.Component.Health#damage

Source code: gameobjects/components/Health.js (Line 46)

data : Object

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

Inherited From

• Phaser.Component.Core#data

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

• {}

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

debug : boolean

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

Inherited From

• Phaser.Component.Core#debug

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

[readonly] deltaX : number

Возвращает значение delta x. Разница между текущим значением world.x и значением в предыдущем кадре.

Значение будет положительным, если объект Game Object перемещен вправо, и отрицательным, если влево.

Inherited From

• Phaser.Component.Delta#deltaX

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

[readonly] deltaY : number

Возвращает значение delta y. Разница между текущим значением world.y и значением в предыдущем кадре.

Значение будет положительным, если объект Game Object перемещен вниз, и отрицательным, если вверх.

Inherited From

• Phaser.Component.Delta#deltaY

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

[readonly] deltaZ : number

Возвращает значение delta z. Разница между текущим значением поворота и значением в предыдущем кадре. Значение разницы.

Inherited From

• Phaser.Component.Delta#deltaZ

Source code: gameobjects/components/Delta.js (Line 58)

[readonly] destroyPhase : boolean

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

Inherited From

• Phaser.Component.Destroy#destroyPhase

Source code: gameobjects/components/Destroy.js (Line 22)

events : Phaser.Events

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

Inherited From

• Phaser.Component.Core#events

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

См.

• Phaser.Events

exists : boolean

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

Inherited From

• PIXI.Sprite#exists

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

• true

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

fixedToCamera : boolean

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

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

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

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

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

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

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

• Phaser.Component.FixedToCamera#fixedToCamera

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

frame : целое число

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

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

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

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

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

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

• Phaser.Component.LoadTexture#frame

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

frameName : строка

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

Чтобы изменить кадр, установите 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)

heal

Вылечить объект игры. Это добавляет заданное количество здоровья к свойству health.

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

• Phaser.Component.Health#heal

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

health : число

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

Его можно использовать в сочетании с методом damage или изменять напрямую.

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

• Phaser.Component.Health#health

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

• 1

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

height : число

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

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

• PIXI.Sprite#height

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

ignoreChildInput : boolean

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

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

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

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

• PIXI.DisplayObjectContainer#ignoreChildInput

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

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

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

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

• Phaser.Component.AutoCull#inCamera

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

input : Phaser.InputHandler | null

Обработчик Input для этого объекта игры.

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

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

Тип

• Phaser.InputHandler | null

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

• Phaser.Component.InputEnabled#input

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

inputEnabled : boolean

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

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

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

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

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

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

• Phaser.Component.InputEnabled#inputEnabled

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

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

Проверяет, находятся ли границы объекта Game Objects внутри или пересекаются с границами игрового мира.

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

• Phaser.Component.InWorld#inWorld

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

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

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

Тип

• строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture

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

• Phaser.Component.Core#key

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

left : число

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

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

• Phaser.Component.Bounds#left

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

lifespan : число

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

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

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

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

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

• Phaser.Component.LifeSpan#lifespan

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

maxHealth : число

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

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

• Phaser.Component.Health#maxHealth

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

• 100

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

name : строка

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

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

• Phaser.Component.Core#name

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

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

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

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

• Phaser.Component.Bounds#offsetX

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

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

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

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

• Phaser.Component.Bounds#offsetY

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

outOfBoundsKill : boolean

Если это и свойство checkWorldBounds оба установлены в true, то метод kill вызывается сразу после того, как inWorld возвращает false.

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

• Phaser.Component.InWorld#outOfBoundsKill

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

outOfCameraBoundsKill : boolean

Если это и свойство autoCull оба установлены в true, то метод kill
вызывается сразу после того, как объект Game Object покидает границы камеры.

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

• Phaser.Component.InWorld#outOfCameraBoundsKill

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

pendingDestroy : boolean

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

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

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

• Phaser.Component.Core#pendingDestroy

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

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

Тип физического тела по умолчанию для этого объекта.

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

[только для чтения] 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 : число

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

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

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

setHealth

Устанавливает свойство health объекта Game Object в заданное значение.
Никогда не превысит значение maxHealth.

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

• Phaser.Component.Health#setHealth

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

shader : PIXI.AbstractFilter

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

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

• 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 : число

Тип константы этого объекта.

Source code: gameobjects/Sprite.js (Line 55)

width : number

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

Inherited From

• PIXI.Sprite#width

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

world : Phaser.Point

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

Inherited From

• Phaser.Component.Core#world

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

x : number

Положение объекта игры на оси x относительно локальных координат родителя.

Inherited From

• Phaser.Component.PhysicsBody#x

Source code: gameobjects/components/PhysicsBody.js (Line 98)

y : number

Положение объекта игры на оси y относительно локальных координат родителя.

Inherited From

• Phaser.Component.PhysicsBody#y

Source code: gameobjects/components/PhysicsBody.js (Line 124)

[readonly] z : number

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

Inherited From

• Phaser.Component.Core#z

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

Public Methods

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

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

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

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

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

Parameters

Name	Type	Argument	Default	Description
container	Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite			Объект Game Object или Rectangle, к которому выровнять данный объект Game Object. Может также включать свойства, такие как World.bounds или Camera.view.
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.
offsetX	integer	<optional>	0	Горизонтальная корректировка границ контейнера, применяемая к выровненному положению объекта Game Object. Используйте отрицательное значение для уменьшения границ, положительное для увеличения.
offsetY	integer	<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 внутри границ мира и камеры. Или он может содержать другие спрайты, изображения, объекты Text, BitmapText, TileSprites или кнопки.

Обратите внимание, что выравнивание спрайта по другому объекту 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.

Дополнительные аргументы 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

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

getChildAt(index) → {DisplayObject}

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

Параметры

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

Возвращает

DisplayObject -

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

Inherited From

• PIXI.DisplayObjectContainer#getChildAt

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

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

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

Параметры

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

Возвращает

Число -

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

Inherited From

• PIXI.DisplayObjectContainer#getChildIndex

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

getLocalBounds() → {Rectangle}

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

Возвращает

Rectangle -

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

Inherited From

• PIXI.Sprite#getLocalBounds

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

kill() → {PIXI.DisplayObject}

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

Он также отправляет событие onKilled. Вы можете прослушать событие events.onKilled.

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

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

Возвращает

PIXI.DisplayObject -

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

Inherited From

• Phaser.Component.LifeSpan#kill

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

loadTexture(key, frame, stopAnimation)

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

Если ваш объект Game использует фрейм из атласа текстур, и вы хотите просто изменить на другой фрейм, см. вместо этого свойства frame или frameName.

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

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

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

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

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
key	строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture			Это изображение или текстура, используемая объектом Sprite во время отрисовки. Это может быть строка, являющаяся ссылкой на запись изображения в кэше, или экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
frame	строка | число	<необязательно>		Если этот Sprite использует часть спрайт-листа или атласа текстур, вы можете указать точный фрейм, используя строку или числовой индекс.
stopAnimation	логическое	<необязательно>	true	Если на этом Sprite уже воспроизводится анимация, вы можете выбрать остановить ее или продолжить воспроизведение.

Inherited From

• Phaser.Component.LoadTexture#loadTexture

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

moveDown() → {PIXI.DisplayObject}

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

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

Возвращает

PIXI.DisplayObject -

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

Inherited From

• Phaser.Component.BringToTop#moveDown

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

moveUp() → {PIXI.DisplayObject}

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

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

Возвращает

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 для обоих объектов, чтобы определить результат.

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

Параметры

Имя	Тип	Описание
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, когда анимация завершается (происходит только если loop=false), родительский Sprite будет уничтожен.

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

Phaser.Animation -

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

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

• Phaser.Component.Animation#play

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

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

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

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

• Phaser.Component.Core#postUpdate

Внутренний:

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

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

preUpdate() → {boolean}

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

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

boolean -

True, если Sprite был отрисован, иначе false.

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

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 в заданное значение.

Если у этого объекта игры есть физическое тело, он сбросит тело.

Параметры

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

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

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	object	Объект родительской текстуры, вызвавший изменение размера, например, объект Phaser.Video.
width	integer	Новая ширина текстуры.
height	integer	Новая высота текстуры.

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

• Phaser.Component.LoadTexture#resizeFrame

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

revive(health) → {PIXI.DisplayObject}

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

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

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

Параметры

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

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

PIXI.DisplayObject -

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

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

• Phaser.Component.LifeSpan#revive

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

sendToBack() → {PIXI.DisplayObject}

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

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

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

PIXI.DisplayObject -

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

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

• Phaser.Component.BringToTop#sendToBack

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

setChildIndex(child, index)

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

Параметры

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

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

• 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 элементов Display Object внутри этого контейнера.

Параметры

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