Класс: Phaser.BitmapText

Конструктор

new BitmapText(game, x, y, font, text, size, align)

Параметры

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

Расширяет

• PIXI.DisplayObjectContainer
• Phaser.Component.Core
• Phaser.Component.Angle
• Phaser.Component.AutoCull
• Phaser.Component.Bounds
• Phaser.Component.Destroy
• Phaser.Component.FixedToCamera
• Phaser.Component.InputEnabled
• Phaser.Component.InWorld
• Phaser.Component.LifeSpan
• Phaser.Component.PhysicsBody
• Phaser.Component.Reset

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

align : string

Выравнивание многострочного текста ('left', 'center' или 'right'), не влияет на однострочный текст.

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

alive : boolean

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

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

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

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

• Phaser.Component.LifeSpan#alive

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

• true

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

anchor : Phaser.Point

Значение якорной точки этого BitmapText.

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

angle : number

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

Значения от 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 включен для анимации (например, Phaser.Sprite), это ссылка на его экземпляр AnimationManager.
С помощью него вы можете создавать, воспроизводить, приостанавливать и останавливать анимации.

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

• Phaser.Component.Core#animations

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

См.

• Phaser.AnimationManager

autoCull : boolean

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

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

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

• Phaser.Component.AutoCull#autoCull

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

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

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

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

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

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

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

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

Тип

• 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, если fixedToCamera равно true.

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

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

• Phaser.Component.FixedToCamera#cameraOffset

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

centerX : number

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

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

• Phaser.Component.Bounds#centerX

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

centerY : number

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

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

• Phaser.Component.Bounds#centerY

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

checkWorldBounds : boolean

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

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

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

Он также может убить объект игры, если outOfBoundsKill равен true.

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

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

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

• Phaser.Component.InWorld#checkWorldBounds

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

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

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

Тип

• Array.<DisplayObject>

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

• PIXI.DisplayObjectContainer#children

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

<внутреннее> components : Object

Компоненты, установленные в этом объекте игры.

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

• Phaser.Component.Core#components

Внутреннее:

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

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

data : Object

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

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

• Phaser.Component.Core#data

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

• {}

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

debug : boolean

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

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

• Phaser.Component.Core#debug

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

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

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

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

• Phaser.Component.Destroy#destroyPhase

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

dirty : boolean

Состояние "загрязнённости" этого объекта.

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

events : Phaser.Events

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

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

• Phaser.Component.Core#events

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

См.

• Phaser.Events

exists : boolean

Управляет тем, обрабатывается ли этот объект игры основным циклом игры.
Если у этого объекта игры есть физическое тело, он также управляет обновлением или нет его физического тела.
Когда exists установлено в false, оно удалит его физическое тело из физического мира, если оно есть.
Это также переключает свойство visible в false.

Установка exists в true добавит его физическое тело обратно в физический мир, если оно есть.
Это также установит свойство visible в true.

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

• Phaser.Component.Core#exists

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

fixedToCamera : boolean

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

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

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

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

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

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

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

• Phaser.Component.FixedToCamera#fixedToCamera

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

font : string

Шрифт, в котором будет отображен текст, например, 'Arial'. Должен быть загружен в браузер перед использованием.

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

fontSize : number

Размер шрифта в пикселях.

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

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

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

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

• Phaser.Component.Core#fresh

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

game : Phaser.Game

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

Inherited From

• Phaser.Component.Core#game

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

height : number

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

Inherited From

• PIXI.DisplayObjectContainer#height

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

ignoreChildInput : boolean

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

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

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

Inherited From

• PIXI.DisplayObjectContainer#ignoreChildInput

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

[readonly] inCamera : boolean

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

Inherited From

• Phaser.Component.AutoCull#inCamera

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

input : Phaser.InputHandler | null

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

По умолчанию отключен. Если вы хотите, чтобы этот объект обрабатывал события input, включите его с помощью: 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 не обрабатывает события input. Установив inputEnabled в true, создается Phaser.InputHandler
для этого объекта Game, и он начнет обрабатывать события клика/тача и т.д.

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

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

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

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

Inherited From

• Phaser.Component.InputEnabled#inputEnabled

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

[readonly] inWorld : boolean

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

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 во время отрисовки.
Если это строка, это строка для извлечения текстуры из кэша изображений Phaser.
Также может быть экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.
Если объект Game создан без ключа, ему автоматически назначается ключ __default, который представляет собой 32x32 прозрачный PNG, хранящийся в кэше.
Если объекту Game задан ключ, которого нет в кэше изображений, ему повторно назначается ключ __missing, который представляет собой 32x32 PNG зелёного прямоугольника с прочерченной линией.

Type

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

Inherited From

• Phaser.Component.Core#key

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

left : number

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

Inherited From

• Phaser.Component.Bounds#left

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

lifespan : number

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

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

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

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

Inherited From

• Phaser.Component.LifeSpan#lifespan

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

maxWidth : number

Максимальная ширина отображения BitmapText в пикселях.

Если BitmapText.text длиннее, чем maxWidth, строки будут автоматически переноситься
на следующую строку на основе последнего пробела, найденного в строке.

Если пробел не найден, переноса строк не произойдёт, и значение maxWidth не будет учтено.

Отключить maxWidth можно, задав значение 0. Максимальная ширина этого BitmapText в пикселях.

Source code: gameobjects/BitmapText.js (Line 648)

name : string

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

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

• Phaser.Component.Core#name

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

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

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

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

• Phaser.Component.Bounds#offsetX

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

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

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

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

• Phaser.Component.Bounds#offsetY

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

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

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

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

• Phaser.Component.InWorld#outOfBoundsKill

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

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

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

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

• Phaser.Component.InWorld#outOfCameraBoundsKill

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

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

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

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

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

• Phaser.Component.Core#pendingDestroy

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

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

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

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

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

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

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

• Phaser.Component.Core#previousPosition

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

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

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

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

• Phaser.Component.Core#previousRotation

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

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

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

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

• Phaser.Component.Core#renderOrderID

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

right : число

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

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

• Phaser.Component.Bounds#right

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

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

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

Сглаживание применяется к BaseTexture этого шрифта, к которому все буквы текста ссылаются.

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

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

text : строка

Текст, который должен отображаться этим объектом BitmapText.

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

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

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

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

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

Ширина в пикселях всей области текста с учетом многострочного текста.

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

tint : число

Оттенок, применяемый к BitmapText. Это шестнадцатеричное значение. Установите в белый, чтобы отключить (0xFFFFFF)

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

top : число

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

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

• Phaser.Component.Bounds#top

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

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

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

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

width : число

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

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

• PIXI.DisplayObjectContainer#width

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

world : Phaser.Point

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

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

• Phaser.Component.Core#world

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

x : число

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

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

• Phaser.Component.PhysicsBody#x

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

y : число

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

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

• Phaser.Component.PhysicsBody#y

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

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

Глубина 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 внутри другого объекта Game или прямоугольника, известного как
'контейнер', по одному из 9 возможных положений.

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

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

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

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, независимо от их значения позиции.

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

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 или прямоугольник, к которому выровнять этот объект Game. Может также включать свойства, такие как 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. Используйте отрицательное значение для уменьшения границ, положительное для увеличения.
offsetY	integer	<optional>	0	Вертикальная корректировка границ контейнера, применяемая к выровненной позиции объекта Game. Используйте отрицательное значение для уменьшения границ, положительное для увеличения.

Returns

Object -

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

Inherited From

• Phaser.Component.Bounds#alignIn

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

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

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

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

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

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

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. Например:

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)

cleanText(text, replace) → {string}

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

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
text	строка			Текст для анализа.
replace	строка	<необязательно>	''	Строка замены для отсутствующих символов.

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

строка -

Очищенная текстовая строка.

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

contains(child) → {Boolean}

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

Параметры

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

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

Boolean -

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

• PIXI.DisplayObjectContainer#contains

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

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(targetCoordinateSpace) → {Rectangle}

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

Параметры

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

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

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

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

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

• PIXI.DisplayObjectContainer#getBounds

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

getChildAt(index) → {DisplayObject}

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

Параметры

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

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

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#getChildAt

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

getChildIndex(child) → {Number}

Возвращает позицию индекса дочернего объекта DisplayObject

Параметры

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

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

Число -

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

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

• PIXI.DisplayObjectContainer#getChildIndex

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

getLocalBounds() → {Rectangle}

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

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

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

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

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

• PIXI.DisplayObjectContainer#getLocalBounds

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

kill() → {PIXI.DisplayObject}

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

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

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

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

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

PIXI.DisplayObject -

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

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

• Phaser.Component.LifeSpan#kill

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

postUpdate()

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

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

preUpdate() → {boolean}

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

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

boolean -

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

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

purgeGlyphs() → {integer}

Если BitmapText меняется с большого числа символов на очень малое, это приведет к сохранению большого количества
Sprites в массиве BitmapText._glyphs. Хотя они не прикреплены к списку отображения, они
все еще занимают место в памяти, ожидая повторного использования в будущем.

Если вы знаете, что BitmapText больше не будет увеличиваться, вы можете очистить лишние символы из пула,
вызвав этот метод.

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

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

integer -

Количество символов, удаленных из пула.

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

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)

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 есть физическое тело, оно сбросит физику.

Параметры

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

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

PIXI.DisplayObject -

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

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

• Phaser.Component.Reset#reset

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

revive(health) → {PIXI.DisplayObject}

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

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

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

Параметры

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

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

PIXI.DisplayObject -

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

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

• Phaser.Component.LifeSpan#revive

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

setChildIndex(child, index)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#setChildIndex

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

setText(text)

Текст, который будет отображаться этим объектом BitmapText.

Использование BitmapText.text = string быстрее, но это сохранено для обратной совместимости.

Параметры

Имя	Тип	Описание
text	строка	Текст, который будет отображаться этим объектом BitmapText.

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

swapChildren(child, child2)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#swapChildren

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

update()

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

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

• Phaser.Component.Core#update

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