Класс: Phaser.Text

Конструктор

new Text(game, x, y, text, style)

Параметры

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

Расширяет

• Phaser.Sprite

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

align : string

Управляет горизонтальным выравниванием многострочного текста.
Может принимать значения: 'left', 'center' или 'right'.
Не влияет на одиночные строки текста. Для этого см. setTextBounds.

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

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)

autoRound : boolean

Следует ли автоматически округлять значения linePositionX и Y перед отрисовкой текста?
Это может быть полезно, если вы хотите устранить эффект субпиксельной алиасинга из текста.

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

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)

boundsAlignH : string

Горизонтальное выравнивание текста внутри textBounds. Может быть: 'left', 'center' или 'right'.

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

boundsAlignV : string

Вертикальное выравнивание текста внутри textBounds. Может быть: 'top', 'middle' или 'bottom'.

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

cameraOffset : Phaser.Point

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

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

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

• Phaser.Component.FixedToCamera#cameraOffset

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

canvas :HTMLCanvasElement

Элемент холста, на котором отрисовывается текст.

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

centerX : number

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

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

• Phaser.Component.Bounds#centerX

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

centerY : number

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

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

• Phaser.Component.Bounds#centerY

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

checkWorldBounds : boolean

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

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

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

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

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

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

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

• Phaser.Component.InWorld#checkWorldBounds

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

[readonly] children : Array.<DisplayObject>

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

Тип

• Array.<DisplayObject>

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

• PIXI.DisplayObjectContainer#children

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

colors :array

Массив значений цветов, заданных с помощью addColor.

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

<internal> components : Object

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

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

• Phaser.Component.Core#components

Внутреннее:

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

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

context :HTMLCanvasElement

Контекст элемента холста, на котором отрисовывается текст.

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

cropRect : Phaser.Rectangle

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

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

• Phaser.Component.Crop#cropRect

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

cssFont : string

Изменить используемый шрифт.

Это эквивалент свойства font, указанного для setStyle, за исключением
того, что, в отличие от использования setStyle, это не изменит текущие параметры заполнения/цвета шрифта.

Строку CSS шрифта также можно изменить индивидуально с помощью свойств font, fontSize, fontWeight, fontStyle и fontVariant.

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

damage

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

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

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

• Phaser.Component.Health#damage

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

data : Object

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

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

• Phaser.Component.Core#data

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

• {}

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

debug : boolean

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

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

• Phaser.Component.Core#debug

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

[readonly] deltaX : number

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

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

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

• Phaser.Component.Delta#deltaX

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

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

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

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

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

• Phaser.Component.Delta#deltaY

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

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

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

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

• Phaser.Component.Delta#deltaZ

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

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

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

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

• Phaser.Component.Destroy#destroyPhase

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

events : Phaser.Events

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

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

• Phaser.Component.Core#events

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

См.

• Phaser.Events

exists : boolean

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

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

• PIXI.Sprite#exists

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

• true

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

fill : Объект

Стиль заливки для холста, который будет использоваться для текста, например, 'red', '#00FF00'.

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

fixedToCamera : boolean

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

Значения корректируются на стадии отрисовки, переопределяя фактическое мировое положение Game Object.

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

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

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

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

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

• Phaser.Component.FixedToCamera#fixedToCamera

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

font : строка

Измените семейство шрифтов, в котором будет отображаться текст, например, 'Arial'.

Несколько семейств шрифтов CSS и общих обратных ссылок могут быть указаны, если соблюдаются правила
правил семейства шрифтов CSS.

Для изменения всей строки шрифта используйте cssFont вместо этого: например. text.cssFont = 'bold 20pt Arial'.

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

fontSize : число | строка

Размер шрифта.

Если размер шрифта задан в пикселях (например, 32 или '32px'), то возвращается число (например, 32) , представляющее
размер шрифта в пикселях; в противном случае возвращается значение с единицей CSS как строка (например, '12pt').

Тип

• число | строка

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

fontStyle : строка

Стиль шрифта: 'normal', 'italic', 'oblique'

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

fontStyles :массив

Массив значений стилей шрифта, как задано в addFontStyle.

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

fontVariant : строка

Вариант шрифта: 'normal', 'small-caps'

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

fontWeight : строка

Вес шрифта: 'normal', 'bold' или действительный вес шрифта CSS.

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

fontWeights :массив

Массив значений весов шрифта, заданных в addFontWeight.

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

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

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

Чтобы изменить кадр, установите frame на индекс нового кадра в таблице спрайтов, которую вы хотите использовать для этого объекта Game Object, например: 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 : число

Высота Текста. Установка этого значения изменит масштаб, чтобы получить нужное значение.

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

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

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

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

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

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

• PIXI.DisplayObjectContainer#ignoreChildInput

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

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

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

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

• Phaser.Component.AutoCull#inCamera

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

input : Phaser.InputHandler | null

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

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

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

Тип

• Phaser.InputHandler | null

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

• Phaser.Component.InputEnabled#input

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

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

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

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

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

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

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

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

• Phaser.Component.InputEnabled#inputEnabled

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

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

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

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

• Phaser.Component.InWorld#inWorld

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

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

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

Тип

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

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

• Phaser.Component.Core#key

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

left : число

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

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

• Phaser.Component.Bounds#left

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

lifespan : число

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

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

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

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

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

• Phaser.Component.LifeSpan#lifespan

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

lineSpacing : число

Дополнительный отступ (в пикселях) между каждой строкой текста, если многострочный.

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

maxHealth : число

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

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

• Phaser.Component.Health#maxHealth

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

• 100

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

name : строка

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

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

• Phaser.Component.Core#name

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

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

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

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

• Phaser.Component.Bounds#offsetX

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

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

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

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

• Phaser.Component.InWorld#outOfCameraBoundsKill

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

padding : Phaser.Point

Укажите значение отступа, которое добавляется к ширине и высоте строки при расчете размера текста.
Позволяет добавить дополнительные отступы, если Phaser не может точно определить истинные размеры шрифта.

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

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

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

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

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

• Phaser.Component.Core#pendingDestroy

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

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

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

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

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

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

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

• Phaser.Component.Core#previousPosition

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

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

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

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

• Phaser.Component.Core#previousRotation

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

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

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

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

• Phaser.Component.Core#renderOrderID

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

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

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

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

right : число

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

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

• Phaser.Component.Bounds#right

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

scaleMax : Phaser.Point

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

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

Установите в null для удаления ограничения.

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

• Phaser.Component.ScaleMinMax#scaleMax

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

scaleMin : Phaser.Point

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

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

Установите в null для удаления ограничения.

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

• Phaser.Component.ScaleMinMax#scaleMin

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

setHealth

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

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

• Phaser.Component.Health#setHealth

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

shader : PIXI.AbstractFilter

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

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

• PIXI.Sprite#shader

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

• null

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

shadowBlur : число

Значение shadowBlur. Смягчает тень, применяя к ней размытие Гаусса. Число от 0 (без размытия) до примерно 10 (в зависимости от сцены).

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

shadowColor : строка

Цвет тени, заданный в формате CSS rgba. Установите значение альфа-компонента в 0, чтобы отключить тень.

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

shadowFill : логическое значение

Устанавливает, применяется ли тень к заполнению текста.

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

shadowOffsetX : число

Значение shadowOffsetX в пикселях. Это смещение тени по горизонтали.

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

shadowOffsetY : число

Значение shadowOffsetY в пикселях. Это смещение тени по вертикали.

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

shadowStroke : логическое значение

Устанавливает, применяется ли тень к контуру текста.

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

smoothed : логическое значение

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

Действует только если объект Game Object использует текстуру на основе изображения.

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

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

• Phaser.Component.Smoothed#smoothed

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

stroke : строка

Стиль заливки холста, который будет использоваться для контура текста, например 'синий', '#FCFF00'.

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

strokeColors : массив

Массив значений цвета контура, указанных в addStrokeColor.

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

strokeThickness : число

Число, представляющее толщину контура. По умолчанию 0 (без контура).

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

tabs : целое число или массив

Размер (в пикселях) табуляций, для случаев, когда текст содержит символы табуляции. 0 отключает.
Может быть целым числом или массивом с различными размерами табуляций, по одной табуляции на элемент.
Например, если вы установите tabs в 100, то при столкновении с Text с символом табуляции, он переместится на 100 пикселей вперёд.
Если вы установите tabs в [100,200], то он установит первую табуляцию на 100px, а вторую на 200px.

Тип

• целое число | массив

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

text : строка

Текст, который должен отображаться этим объектом Text.
Используйте \n для вставки возврата каретки и разделения текста.
Текст будет отображаться с любым текущим стилем.

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

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

Свойство textBounds позволяет указать прямоугольную область, на основе которой производится выравнивание текста.
См. Text.setTextBounds для получения дополнительной информации.

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

texture : PIXI.Texture

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

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

• PIXI.Sprite#texture

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

tint : число

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

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

• PIXI.Sprite#tint

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

• 0xFFFFFF

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

tintedTexture : Canvas

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

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

• PIXI.Sprite#tintedTexture

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

• null

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

top : число

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

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

• Phaser.Component.Bounds#top

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

transformCallback : Функция

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

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

• Phaser.Component.ScaleMinMax#transformCallback

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

transformCallbackContext : Объект

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

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

• Phaser.Component.ScaleMinMax#transformCallbackContext

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

type : число

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

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

useAdvancedWrap : boolean

Использует ли этот объект Text Basic или Advanced обрезку по словам?

Расширенная обрезка по словам разделяет длинные слова, если они являются первыми в строке, и повторяет процесс по необходимости.
Пробелы сжимаются (например, последовательные пробелы заменяются одним).
Строки обрезаются от пробелов перед обработкой.

Выбрасывает ошибку, если wordWrapWidth меньше одного символа.

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

width : число

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

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

wordWrap : boolean

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

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

wordWrapWidth : число

Ширина, по которой текст будет обрезаться.

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

world : Phaser.Point

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

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

• Phaser.Component.Core#z

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

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

addChild(child) → {DisplayObject}

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

Параметры

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

Возвращает

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#addChild

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

addChildAt(child, index) → {DisplayObject}

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

Параметры

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

Возвращает

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#addChildAt

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

addColor(color, position) → {Phaser.Text}

Устанавливает определенные цвета для отдельных символов в тексте.

Работает, принимая значение цвета, которое является типичной строкой HTML, такой как #ff0000 или rgb(255,0,0) и позицию.
Значение позиции — это индекс символа в строке текста, с которого нужно начать применять этот цвет.
После установки цвет остается в использовании до тех пор, пока не встретится другой цвет или конец строки.
Например, если текст был Photon Storm и вы сделали Text.addColor('#ffff00', 6), он бы закрасил слово Storm желтым цветом.

Если вы хотите изменить цвет обводки, используйте addStrokeColor.

Параметры

Имя	Тип	Описание
color	string	Стиль заливки canvas, который будет использоваться для текста, например red, #00FF00, rgba().
position	number	Индекс символа в строке, с которого нужно начать применять это значение цвета.

Возвращает

Phaser.Text -

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

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

addFontStyle(style, position) → {Phaser.Text}

Устанавливает определенные стили шрифта для отдельных символов в тексте.

Работает, принимая значение стиля шрифта, которое является типичной строкой, такой как normal, italic или oblique.
Значение позиции — это индекс символа в строке текста, с которого нужно начать применять этот стиль шрифта.
После установки стиль шрифта остается в использовании до тех пор, пока не встретится другой стиль шрифта или конец строки.
Например, если текст был Photon Storm и вы сделали Text.addFontStyle('italic', 6), он бы стилизовал слово Storm курсивом.

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

Параметры

Имя	Тип	Описание
style	string	Стиль шрифта canvas, который будет использоваться для стиля текста, например normal, italic, oblique.
position	number	Индекс символа в строке, с которого нужно начать применять это значение стиля шрифта.

Возвращает

Phaser.Text -

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

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

addFontWeight(style, position) → {Phaser.Text}

Устанавливает определенные начертания шрифта для отдельных символов в тексте.

Работает, принимая значение начертания шрифта, которое является типичной строкой, такой как normal, bold, bolder, и т.д.
Значение позиции — это индекс символа в строке текста, с которого нужно начать применять это начертание шрифта.
После установки начертание шрифта остается в использовании до тех пор, пока не встретится другое начертание шрифта или конец строки.
Например, если текст был Photon Storm и вы сделали Text.addFontWeight('bold', 6), он бы стилизовал слово Storm жирным шрифтом.

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

Параметры

Имя	Тип	Описание
style	string	Начертание шрифта canvas, которое будет использоваться для начертания текста, например normal, bold, bolder, lighter, и т.д.
position	number	Индекс символа в строке, с которого нужно начать применять это значение начертания шрифта.

Возвращает

Phaser.Text -

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

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

addStrokeColor(color, position) → {Phaser.Text}

Устанавливает определенные цвета обводки для отдельных символов в тексте.

Работает, принимая значение цвета, которое является типичной строкой HTML, такой как #ff0000 или rgb(255,0,0) и позицию.
Значение позиции — это индекс символа в строке текста, с которого нужно начать применять этот цвет.
После установки цвет остается в использовании до тех пор, пока не встретится другой цвет или конец строки.
Например, если текст был Photon Storm и вы сделали Text.addColor('#ffff00', 6), он бы закрасил слово Storm желтым цветом.

Это не оказывает никакого влияния, если обводка отключена или имеет толщину 0.

Если вы хотите изменить цвет заливки текста, используйте addColor.

Параметры

Имя	Тип	Описание
color	string	Стиль заливки canvas, который будет использоваться для обводки текста, например red, #00FF00, rgba().
position	number	Индекс символа в строке, с которого нужно начать применять это значение цвета.

Возвращает

Phaser.Text -

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

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

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

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

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

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

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

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 и offsetY позволяют применять дополнительный отступ к окончательному
выровненному положению объекта игры. Например:

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

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
container	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_CENTER, Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER или Phaser.BOTTOM_RIGHT.
offsetX	целое число	<опционально>	0	Горизонтальная корректировка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для сужения границ, положительное — для увеличения.
offsetY	целое число	<опционально>	0	Вертикальная корректировка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для сужения границ, положительное — для увеличения.

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

Объект -

Этот объект игры.

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

• Phaser.Component.Bounds#alignIn

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

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

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

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

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

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

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 позволяют применять дополнительный отступ к окончательному
выровненному положению объекта игры. Например:

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

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

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
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)

clearColors() → {Phaser.Text}

Очищает любые цвета заливки или обводки текста, установленные с помощью addColor или addStrokeColor.

Возвращает

Phaser.Text -

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

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

clearFontValues() → {Phaser.Text}

Очищает любые стили или веса шрифта текста, установленные с помощью addFontStyle или addFontWeight.

Возвращает

Phaser.Text -

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

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

contains(child) → {Boolean}

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

Параметры

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

Возвращает

Boolean -

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

• PIXI.DisplayObjectContainer#contains

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

crop(rect, copy)

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

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

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

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

Параметры

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

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

• Phaser.Component.Crop#crop

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

destroy(destroyChildren)

Уничтожить этот объект Text, удалив его из группы, к которой он принадлежит.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
destroyChildren	boolean	<optional>	true	Нужно ли вызвать метод destroy для каждого дочернего элемента этого объекта?

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

getBounds(matrix) → {Phaser.Rectangle}

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

Параметры

Имя	Тип	Описание
matrix	Phaser.Matrix	Матрица преобразования объекта Text.

Возвращает

Phaser.Rectangle -

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

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

getChildAt(index) → {DisplayObject}

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

Параметры

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

Возвращает

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#getChildAt

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

getChildIndex(child) → {Number}

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

Параметры

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

Возвращает

Number -

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

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

• PIXI.DisplayObjectContainer#getChildIndex

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

getLocalBounds() → {Rectangle}

Получает локальные границы Sprite, не учитывающие глобальные координаты. Вычисление учитывает все видимые дочерние элементы.

Возвращает

Rectangle -

Прямоугольная область ограничивающей рамки

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

• PIXI.Sprite#getLocalBounds

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

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)

loadTexture(key, frame, stopAnimation)

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

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

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

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

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

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

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

Параметры

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

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

• Phaser.Component.LoadTexture#loadTexture

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

moveDown() → {PIXI.DisplayObject}

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

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

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

PIXI.DisplayObject -

Текущий экземпляр.

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

• Phaser.Component.BringToTop#moveDown

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

moveUp() → {PIXI.DisplayObject}

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

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

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

PIXI.DisplayObject -

Текущий экземпляр.

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

• Phaser.Component.BringToTop#moveUp

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

overlap(displayObject) → {boolean}

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

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

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

Параметры

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

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

boolean -

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

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

• Phaser.Component.Overlap#overlap

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

parseList(list) → {Phaser.Text}

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

Массив может быть одномерным или многомерным в зависимости от требуемого результата:

[ 'a', 'b', 'c' ] преобразуется в "a\tb\tc".

Тогда как:

[ [ 'a', 'b', 'c' ], [ 'd', 'e', 'f'] ]

преобразуется в: "a\tb\tc\nd\te\tf"

Параметры

Имя	Тип	Описание
list	массив	Массив данных для преобразования в строку.

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

Phaser.Text -

Экземпляр Text.

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

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

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

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

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

Параметры

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

Возвращает

Phaser.Animation -

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

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

• Phaser.Component.Animation#play

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

<internal> postUpdate()

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

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

• Phaser.Component.Core#postUpdate

Внутренний:

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

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

precalculateWordWrap(text) → {array}

Запускает заданный текст через функцию Text.runWordWrap и возвращает
результаты в виде массива, где каждый элемент массива соответствует
завернутой строке текста.

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

Параметры

Имя	Тип	Описание
text	string	Текст, для которого будет рассчитано форматирование.

Возвращает

array -

Массив строк с фрагментами форматированного текста.

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

<internal> preUpdate()

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

Внутренний:

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

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

removeChild(child) → {DisplayObject}

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

Параметры

Имя	Тип	Описание
child	DisplayObject	DisplayObject для удаления

Возвращает

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#removeChild

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

removeChildAt(index) → {DisplayObject}

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

Параметры

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

Возвращает

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#removeChildAt

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

removeChildren(beginIndex, endIndex)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#removeChildren

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

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

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

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

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

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

Параметры

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.Reset#reset

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

resetFrame()

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

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

• Phaser.Component.LoadTexture#resetFrame

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

resizeFrame(parent, width, height)

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

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

Параметры

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

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

• Phaser.Component.LoadTexture#resizeFrame

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

revive(health) → {PIXI.DisplayObject}

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

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

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

Параметры

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.LifeSpan#revive

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

sendToBack() → {PIXI.DisplayObject}

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

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.BringToTop#sendToBack

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

setChildIndex(child, index)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#setChildIndex

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

setFrame(frame)

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

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

Параметры

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

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

• Phaser.Component.LoadTexture#setFrame

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

setScaleMinMax(minX, minY, maxX, maxY)

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

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

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

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

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

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

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

Параметры

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

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

• Phaser.Component.ScaleMinMax#setScaleMinMax

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

setShadow(x, y, color, blur, shadowStroke, shadowFill) → {Phaser.Text}

Устанавливает эффект тени падения на текст. Вы можете указать горизонтальное и вертикальное смещение тени с помощью параметров x и y.
Цвет определяет оттенок тени (по умолчанию черный) и может быть значением rgba или hex.
Размытие — это интенсивность тени. Значение 0 означает твёрдую тень, значение 10 означает очень мягкую тень.
Чтобы удалить уже установленную тень, вы можете вызвать этот метод без установленных параметров.

Параметры

Имя	Тип	Аргумент	Значение по умолчанию	Описание
x	число	<необязательно>	0	Значение shadowOffsetX в пикселях. Это смещение тени по горизонтали.
y	число	<необязательно>	0	Значение shadowOffsetY в пикселях. Это смещение тени по вертикали.
color	строка	<необязательно>	'rgba(0,0,0,1)'	Цвет тени в формате CSS rgba или шестнадцатеричном формате. Установите альфа-компонент в 0, чтобы отключить тень.
blur	число	<необязательно>	0	Значение shadowBlur. Сделайте тень мягче, применив размытие Гаусса. Число от 0 (без размытия) до приблизительно 10 (в зависимости от сцены).
shadowStroke	логическое	<необязательно>	true	Применить тень падения к обводке текста (если установлено).
shadowFill	логическое	<необязательно>	true	Применить тень падения к заливке текста (если установлено).

Возвращает

Phaser.Text -

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

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

setStyle(style, update) → {Phaser.Text}

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

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
style	объект	<необязательный>		Свойства стиля, которые нужно установить для текста. Свойства Имя Тип Аргумент По умолчанию Описание font строка <необязательный> 'bold 20pt Arial' Стиль и размер шрифта. fontStyle строка <необязательный> (из шрифта) Стиль шрифта (например, 'italic'): переопределяет значение в style.font. fontVariant строка <необязательный> (из шрифта) Вариант шрифта (например, 'small-caps'): переопределяет значение в style.font. fontWeight строка <необязательный> (из шрифта) Начертание шрифта (например, 'bold'): переопределяет значение в style.font. fontSize строка | число <необязательный> (из шрифта) Размер шрифта (например, 32 или '32px'): переопределяет значение в style.font. backgroundColor строка <необязательный> null Стиль заливки холста, который будет использоваться в качестве фона всего объекта Text. Установите значение null, чтобы отключить. fill строка <необязательный> 'черный' Стиль заливки холста, который будет использоваться для текста, например 'красный', '#00FF00'. align строка <необязательный> 'слева' Горизонтальное выравнивание каждой строки в многострочном тексте. Может быть: 'слева', 'по центру' или 'справа'. Не влияет на одиночные строки текста (см. textBounds и boundsAlignH для этого). boundsAlignH строка <необязательный> 'слева' Горизонтальное выравнивание текста внутри textBounds. Может быть: 'слева', 'по центру' или 'справа'. boundsAlignV строка <необязательный> 'верх' Вертикальное выравнивание текста внутри textBounds. Может быть: 'верх', 'по середине' или 'низ'. stroke строка <необязательный> 'черный' Стиль обводки холста, который будет использоваться для обводки текста, например 'синий', '#FCFF00'. strokeThickness число <необязательный> 0 Число, представляющее толщину обводки. По умолчанию 0 (без обводки). wordWrap логическое <необязательный> false Указывает, нужно ли использовать перенос слов. wordWrapWidth число <необязательный> 100 Ширина в пикселях, при которой будет происходить перенос слов. maxLines число <необязательный> 0 Максимальное количество строк, которые будут отображаться для переносимого текста. tabs число | массив <необязательный> 0 Размер (в пикселях) табуляций, если текст содержит символы табуляции. 0 отключает. Может быть массивом с различными размерами табуляции, один на каждую остановку табуляции.
update	логическое	<необязательный>	false	Немедленно обновить объект Text после установки нового стиля? Или подождать следующего кадра.

Возвращает

Phaser.Text -

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

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

setText(текст, немедленно) → {Phaser.Text}

Текст, который должен отображаться этим объектом Text.
Используйте \n для вставки возврата каретки и разделения текста.
Текст будет отображаться с любым текущим стилем.

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

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

Параметры

Имя	Тип	Аргумент	По умолчанию	Описание
text	строка	<необязательный>		Отображаемый текст. Установите пустую строку, чтобы очистить уже присутствующий текст.
immediate	логическое	<необязательный>	false	Немедленно обновить используемую текстуру этого объекта Text (true) или автоматически во время следующего цикла рендеринга (false).

Возвращает

Phaser.Text -

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

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

setTextBounds(x, y, ширина, высота) → {Phaser.Text}

Границы текста — прямоугольная область, размер которой вы контролируете, в которую помещается сам объект Text,
независимо от количества строк в тексте, размера шрифта или любого другого атрибута.

Выравнивание контролируется свойствами boundsAlignH и boundsAlignV в объекте Text.style или может быть
непосредственно установлено с помощью методов Text.boundsAlignH и Text.boundsAlignV. Выравнивание границ
независимо от выравнивания текста.

Например: если размер вашей игры 800x600, и вы устанавливаете границы текста 0,0,800,600, то установив boundsAlignH в
'по центру' и boundsAlignV в 'низ', текст будет отображаться по центру и внизу вашего игрового окна, независимо от
количества строк текста. Даже если вы измените содержимое текста или стиль, он останется в нижнем центре
границ текста.

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

Если Text.wordWrapWidth больше ширины границ текста, он прижимается к ширине границ.

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

Он работает, вычисляя окончательное положение на основе размера Text.canvas, который изменяется по мере обновления текста. Некоторые шрифты
имеют дополнительный отступ вокруг себя, который вы можете уменьшить, отрегулировав свойство Text.padding. Затем он корректирует свойство pivot,
на основе заданных границ и размера холста. Это означает, что если вам нужно установить свойство pivot напрямую в вашей игре, то
либо нельзя использовать setTextBounds, либо необходимо поместить объект Text внутри другого объекта отображения, для которого вы устанавливаете pivot.

Параметры

Имя	Тип	Аргумент	Описание
x	число	<необязательно>	Координата x области Text Bounds.
y	число	<необязательно>	Координата y области Text Bounds.
width	число	<необязательно>	Ширина области Text Bounds.
height	число	<необязательно>	Высота области Text Bounds.

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

Phaser.Text -

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

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

setTexture(texture, destroy)

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

Параметры

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

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

• PIXI.Sprite#setTexture

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

swapChildren(child, child2)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#swapChildren

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

<internal> update()

Переопределите эту функцию для обработки любых специальных требований к обновлению.

Внутреннее:

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

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

updateCrop()

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

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

• Phaser.Component.Crop#updateCrop

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

updateShadow(state)

Устанавливает тень на Text.context на основе настроек стиля или отключает её, если она не включена.
Это вызывается автоматически методом Text.updateText.

Параметры

Имя	Тип	Описание
state	boolean	Если true, тень будет установлена в значения стиля, иначе она будет установлена в ноль.

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