Класс: Phaser.TilemapLayer

Конструктор

new TilemapLayer(game, tilemap, index, width, height)

Параметры

Исходный код: tilemap/TilemapLayer.js (строка 23)

Расширяет

• Phaser.Sprite

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

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

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

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

По умолчанию объекты Game Object не добавляются в какую-либо физическую систему, и их свойство 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

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

• Phaser.Component.PhysicsBody#body

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

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)

<internal> canvas :HTMLCanvasElement

Полотно, на котором отображается этот слой TilemapLayer.

Внутреннее:

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

Исходный код: tilemap/TilemapLayer.js (Строка 59)

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

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

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

[readonly] children : Array.<DisplayObject>

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

Тип

• Array.<DisplayObject>

Inherited From

• PIXI.DisplayObjectContainer#children

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

<internal> components : Object

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

Inherited From

• Phaser.Component.Core#components

Внутренний:

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

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

cropRect : Phaser.Rectangle

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

Inherited From

• Phaser.Component.Crop#cropRect

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

damage

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

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

Inherited From

• Phaser.Component.Health#damage

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

data : Object

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

Inherited From

• Phaser.Component.Core#data

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

• {}

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

debug : boolean

Включить дополнительный "отладку отрисовки" проход для отображения информации о столкновениях.

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

debugSettings

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

Свойства:

Имя	Тип	Аргумент	Описание
missingImageFill	string	<nullable>	Плитка отображается как прямоугольник с указанным заполнением, если не найдено допустимое наборы плиток/изображение. Значение null предотвращает дополнительную отрисовку плиток без допустимого изображения набора плиток. Это вступает в силу даже при отключённой отладке отрисовки для слоя.
debuggedTileOverfill	string	<nullable>	Если у плитки Tile#debug имеет значение true, то после отрисовки изображения плитки, прямоугольник с указанным заполнением рисуется над ней. Это вступает в силу даже при отключённой отладке отрисовки для слоя.
forceFullRedraw	boolean		При отрисовке в режиме отладки (debug имеет значение true) и при включенном этом параметре, выполняется полная перерисовка, и оптимизация отрисовки отключается.
debugAlpha	number		При отрисовке в режиме отладки (debug имеет значение true), набор плиток изначально отрисовывается с этим уровнем прозрачности. Это может сделать края плитки более чёткими.
facingEdgeStroke	string	<nullable>	При отрисовке в режиме отладки (debug имеет значение true), этот цвет/контур используется для рисования "линий границ". Значение null отключает окрашивание границ.
collidingTileOverfill	string	<nullable>	При отрисовке в режиме отладки (debug имеет значение true), это заполнение используется для плиток, которые участвуют в столкновениях. Значение null отключает применение дополнительного заполнения.

Исходный код: tilemap/TilemapLayer.js (Строка 133)

[readonly] deltaX : number

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

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

Inherited From

• Phaser.Component.Delta#deltaX

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

[readonly] deltaY : number

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

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

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

• Phaser.Component.Delta#deltaY

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

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

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

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

• Phaser.Component.Delta#deltaZ

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

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

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

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

• Phaser.Component.Destroy#destroyPhase

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

<внутреннее> dirty : логическое

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

Внутреннее:

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

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

events : Phaser.Events

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

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

• Phaser.Component.Core#events

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

См.

• Phaser.Events

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

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

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

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

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

Объект игры считается 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 : число

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

Inherited From

• PIXI.Sprite#height

Source code: pixi/display/Sprite.js (Line 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)

<internal, readonly> index : number

Индекс слоя в Tilemap.

Внутреннее:

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

Source code: tilemap/TilemapLayer.js (Line 44)

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, обработчик Input перестанет обрабатывать события ввода.

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

Inherited From

• Phaser.Component.InputEnabled#inputEnabled

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

[readonly] inWorld : boolean

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

Inherited From

• Phaser.Component.InWorld#inWorld

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

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)

<internal, readonly> layer : Object

Объект слоя внутри Tilemap, который представляет этот слой.

Внутреннее:

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

Source code: tilemap/TilemapLayer.js (Line 52)

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.time.physicsElapsed миллисекунд в каждой кадр.
Когда значение достигает нуля, вызывается метод kill.

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

Inherited From

• Phaser.Component.LifeSpan#lifespan

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

<internal, readonly> map : Phaser.Tilemap

Tilemap, к которому привязан этот слой.

Внутреннее:

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

Source code: tilemap/TilemapLayer.js (Line 36)

maxHealth : number

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

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

• Phaser.Component.Health#maxHealth

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

• 100

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

name : string

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

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

• Phaser.Component.Core#name

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

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

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

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

• Phaser.Component.Bounds#offsetX

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

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

Сдвиг по оси Y объекта игры относительно его координаты 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
вызывается как только объект игры покидает границы камеры.

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

• Phaser.Component.InWorld#outOfCameraBoundsKill

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

pendingDestroy : boolean

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

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

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

• Phaser.Component.Core#pendingDestroy

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

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

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

Исходный код: tilemap/TilemapLayer.js (Строка 83)

[только для чтения] previousPosition : Phaser.Point

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

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

• Phaser.Component.Core#previousPosition

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

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

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

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

• Phaser.Component.Core#previousRotation

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

rayStepRate : integer

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

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

• 4

Исходный код: tilemap/TilemapLayer.js (Строка 174)

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

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

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

• Phaser.Component.Core#renderOrderID

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

renderSettings

Настройки, которые управляют стандартной (не диагностической) отрисовкой.

Свойства:

Имя	Тип	Аргумент	Значение по умолчанию	Описание
enableScrollDelta	boolean	<optional>	true	Отрисовка с использованием delta прокрутки отрисовывает тайлы/края только при их появлении в поле зрения. Это может значительно улучшить производительность прокрутки отрисовки, особенно когда много маленьких тайлов. Его следует отключать только в редких случаях.
copyCanvas	DOMCanvasElement	<optional> <nullable>	(auto)	[Внутреннее] Если установлено, заставить использовать отдельный (общий) копируемый холст. Использование canvas bitblt/copy, когда области источника и назначения перекрываются, приводит к неожиданному поведению в некоторых браузерах, особенно в Safari.

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

• {"enableScrollDelta":false,"overdrawRatio":0.2,"copyCanvas":null}

Исходный код: tilemap/TilemapLayer.js (Строка 98)

right : number

Правая координата объекта игры.
Это то же самое, что 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)

scrollFactorX : number

Скорость горизонтального прокручивания этого слоя относительно камеры (например, scrollFactorX 0,5 прокручивает в два раза медленнее, чем «обычные» слои, привязанные к камере).

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

• 1

Исходный код: tilemap/TilemapLayer.js (Строка 152)

scrollFactorY : number

Скорость вертикального прокручивания этого слоя относительно камеры (например, scrollFactorY 0,5 прокручивает в два раза медленнее, чем «обычные» слои, привязанные к камере).

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

• 1

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

setHealth

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

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

• Phaser.Component.Health#setHealth

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

shader : PIXI.AbstractFilter

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

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

• PIXI.Sprite#shader

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

• null

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

smoothed : boolean

Включить или выключить сглаживание текстуры для этого объекта 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 : number

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

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

• PIXI.Sprite#tint

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

• 0xFFFFFF

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

tintedTexture :Canvas

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

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

• PIXI.Sprite#tintedTexture

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

• null

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

top : number

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

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

• Phaser.Component.Bounds#top

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

transformCallback : Function

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

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

• Phaser.Component.ScaleMinMax#transformCallback

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

transformCallbackContext : Object

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

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

• Phaser.Component.ScaleMinMax#transformCallbackContext

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

<internal, readonly> type : number

Постоянный тип этого объекта.

Внутреннее:

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

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

• Phaser.TILEMAPLAYER

Исходный код: tilemap/TilemapLayer.js (Строка 77)

width : number

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

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

• PIXI.Sprite#width

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

world : Phaser.Point

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

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

• Phaser.Component.Core#world

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

x : number

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

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

• Phaser.Component.PhysicsBody#x

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

y : number

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

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

• Phaser.Component.PhysicsBody#y

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

[readonly] z : number

Глубина z этого объекта Game Object в пределах его родительской группы.
Два объекта в группе не могут иметь одинаковое значение z.
Это значение автоматически корректируется при изменении иерархии группы.
Если вы хотите переупорядочить расположение объекта Game Object, см. методы, такие как 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	Number	Индекс, в который нужно поместить дочерний элемент

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, изображения, объекты Text, BitmapText, TileSprites или кнопки.

Обратите внимание, что выравнивание 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

Name	Type	Argument	Default	Описание
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	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

Object -

Этот объект 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, изображения, объекты Text, BitmapText, TileSprites или кнопки.

Обратите внимание, что выравнивание 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)

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

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

Уничтожает этот слой карты тайлов.

Исходный код: tilemap/TilemapLayer.js (Строка 351)

<internal> ensureSharedCopyCanvas()

Создает (при необходимости) и возвращает общую копию холста, которая используется всеми слоями карты тайлов.

Код, использующий холст, отвечает за обеспечение соответствующих размеров и сохранение/восстановление состояния.

Внутреннее:

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

Исходный код: tilemap/TilemapLayer.js (Строка 253)

getBounds(matrix) → {Rectangle}

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

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

Параметры

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

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

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

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

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

• PIXI.Sprite#getBounds

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

getChildAt(index) → {DisplayObject}

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

Parameters

Name	Type	Description
index	Число	Индекс, по которому нужно получить дочерний элемент

Returns

DisplayObject -

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

Inherited From

• PIXI.DisplayObjectContainer#getChildAt

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

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

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

Parameters

Name	Type	Description
child	DisplayObject	Элемент DisplayObject, который нужно идентифицировать

Returns

Число -

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

Inherited From

• PIXI.DisplayObjectContainer#getChildIndex

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

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

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

Returns

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

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

Inherited From

• PIXI.Sprite#getLocalBounds

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

getRayCastTiles(line, stepRate, collides, interestingFace) → {Массив.<Phaser.Tile>}

Получает все плитки, пересекающиеся с заданной линией.

Parameters

Name	Type	Argument	Default	Description
line	Phaser.Line			Линия, используемая для определения плиток, которые нужно вернуть.
stepRate	целое число	<optional>	(rayStepRate)	Сколько шагов по лучу будем проверять? По умолчанию rayStepRate.
collides	логическое значение	<optional>	false	Если true, только возвращаются плитки, которые сталкиваются на одной или нескольких гранях.
interestingFace	логическое значение	<optional>	false	Если true, только возвращаются плитки, имеющие интересные грани.

Returns

Массив.<Phaser.Tile> -

Массив объектов Phaser.Tiles.

Source code: tilemap/TilemapLayer.js (Line 551)

getTiles(x, y, width, height, collides, interestingFace) → {массив.<Phaser.Tile>}

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

Parameters

Name	Type	Argument	Default	Description
x	число			Позиция X верхнего левого угла (в пикселях).
y	число			Позиция Y верхнего левого угла (в пикселях).
width	число			Ширина области для получения (в пикселях).
height	число			Высота области для получения (в пикселях).
collides	логическое значение	<optional>	false	Если true, только возвращаются плитки, которые сталкиваются на одной или нескольких гранях.
interestingFace	логическое значение	<optional>	false	Если true, только возвращаются плитки, имеющие интересные грани.

Returns

массив.<Phaser.Tile> -

Массив объектов Tiles.

Source code: tilemap/TilemapLayer.js (Line 598)

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

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

Parameters

Name	Type	Description
x	число	Позиция X точки в целевой плитке (в пикселях).

Returns

целое число -

Координаты X плитки на карте.

Source code: tilemap/TilemapLayer.js (Line 502)

getTileXY(x, y, point) → {Phaser.Point | объект}

Преобразует координаты пикселей в координаты плитки.

Parameters

Name	Type	Description
x	число	Позиция X точки в целевой плитке (в пикселях).
y	число	Позиция Y точки в целевой плитке (в пикселях).
point	Phaser.Point | объект	Объект Point/объект для обновления.

Returns

Phaser.Point | объект -

Объект Point/объект с установленными свойствами x и y.

Source code: tilemap/TilemapLayer.js (Line 532)

getTileY(y) → {integer}

Преобразовать значение пикселей в координаты тайла.

Parameters

Имя	Тип	Описание
y	number	Положение Y точки в целевом тайле (в пикселях).

Возвращает

integer -

Картографическое расположение Y тайла.

Исходный код: tilemap/TilemapLayer.js (Строка 517)

kill() → {PIXI.DisplayObject}

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

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

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

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.LifeSpan#kill

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

loadTexture(key, frame, stopAnimation)

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

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

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

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

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

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

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

Parameters

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

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

• Phaser.Component.LoadTexture#loadTexture

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

moveDown() → {PIXI.DisplayObject}

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

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.BringToTop#moveDown

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

moveUp() → {PIXI.DisplayObject}

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

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.BringToTop#moveUp

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

overlap(displayObject) → {boolean}

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

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

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

Parameters

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

Возвращает

boolean -

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

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

• Phaser.Component.Overlap#overlap

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

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

Воспроизводит анимацию.

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

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

Parameters

Имя	Тип	Аргумент	Значение по умолчанию	Описание
name	string			Имя анимации, которая должна быть воспроизведена, например, "огонь", "ходьба", "прыжок". Должна быть предварительно создана с помощью '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. Обрабатывает обновления кэша.

Внутреннее:

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

Исходный код: tilemap/TilemapLayer.js (Строка 284)

preUpdate()

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

Исходный код: tilemap/TilemapLayer.js (Строка 273)

removeChild(child) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#removeChild

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

removeChildAt(index) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#removeChildAt

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

removeChildren(beginIndex, endIndex)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#removeChildren

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

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

Отображает тайлы на холсте слоя и отправляет на отображение.

Внутреннее:

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

Исходный код: tilemap/TilemapLayer.js (Строка 1045)

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

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

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

Если у объекта Game Object есть компонент LifeSpan, он также установит alive в true и health в указанное значение.

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

Параметры

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

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

PIXI.DisplayObject -

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

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

• Phaser.Component.Reset#reset

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

resetFrame()

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

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

• Phaser.Component.LoadTexture#resetFrame

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

resetTilesetCache()

Кеширует запросы к наборам плиток.

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

Исходный код: tilemap/TilemapLayer.js (Строка 693)

resize(width, height)

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

Этот вызов ресурсоёмкий, поэтому не связывайте его с событием изменения размера окна! Вместо этого вызывайте его в тщательно
выбранные моменты.

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

Параметры

Имя	Тип	Описание
width	number	Новая ширина TilemapLayer
height	number	Новая высота TilemapLayer

Исходный код: tilemap/TilemapLayer.js (Строка 364)

resizeFrame(parent, width, height)

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

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

Параметры

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

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

• Phaser.Component.LoadTexture#resizeFrame

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

resizeWorld()

Устанавливает размер мира, соответствующий размеру этого слоя.

Исходный код: tilemap/TilemapLayer.js (Строка 402)

revive(health) → {PIXI.DisplayObject}

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

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

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

Параметры

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

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

PIXI.DisplayObject -

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

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

• Phaser.Component.LifeSpan#revive

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

sendToBack() → {PIXI.DisplayObject}

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

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

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

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)

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

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

Параметры

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

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

• Phaser.Component.LoadTexture#setFrame

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

setScale(xScale, yScale)

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

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
xScale	number	<optional>	1	Коэффициент масштабирования по оси X
yScale	number	<optional>		Коэффициент масштабирования по оси Y

Исходный код: tilemap/TilemapLayer.js (Строка 712)

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

Параметры

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