Класс: Phaser.Button

Конструктор

new Button(game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame)

Параметры

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

Расширяет

• Phaser.Image

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

alive : boolean

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

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

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

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

• Phaser.Component.LifeSpan#alive

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

• true

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

anchor :Point

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

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

• PIXI.Sprite#anchor

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

angle : number

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

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

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

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

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

• Phaser.Component.Angle#angle

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

animations : Phaser.AnimationManager

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

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

• Phaser.Component.Core#animations

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

См.

• Phaser.AnimationManager

autoCull : boolean

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

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

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

• Phaser.Component.AutoCull#autoCull

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

blendMode : number

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

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

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

• PIXI.Sprite#blendMode

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

• PIXI.blendModes.NORMAL;

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

bottom : number

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

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

• Phaser.Component.Bounds#bottom

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

cameraOffset : Phaser.Point

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

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

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

• Phaser.Component.FixedToCamera#cameraOffset

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

centerX : number

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

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

• Phaser.Component.Bounds#centerX

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

centerY : number

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

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

• Phaser.Component.Bounds#centerY

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

[readonly] children : Array.<DisplayObject>

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

Тип

• Array.<DisplayObject>

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

• PIXI.DisplayObjectContainer#children

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

<internal> components : Object

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

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

• Phaser.Component.Core#components

Внутреннее:

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

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

cropRect : Phaser.Rectangle

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

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

• Phaser.Component.Crop#cropRect

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

data : Объект

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

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

• Phaser.Component.Core#data

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

• {}

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

debug : boolean

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

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

• Phaser.Component.Core#debug

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

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

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

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

• Phaser.Component.Destroy#destroyPhase

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

events : Phaser.Events

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

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

• Phaser.Component.Core#events

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

См.

• Phaser.Events

exists : boolean

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

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

• PIXI.Sprite#exists

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

• true

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

fixedToCamera : boolean

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

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

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

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

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

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

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

• Phaser.Component.FixedToCamera#fixedToCamera

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

forceOut : boolean | Phaser.PointerMode

Когда кнопка нажата/нажата и затем отпущена, вы можете принудительно перевести ее в состояние «out» вместо «up».

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

Тип

• boolean | Phaser.PointerMode

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

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

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

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

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

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

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

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

• Phaser.Component.LoadTexture#frame

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

frameName : строка

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

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

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

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

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

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

• Phaser.Component.LoadTexture#frameName

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

freezeFrames : boolean

При значении true кадр текстуры не будет автоматически переключаться при событиях up/down/over/out.

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

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

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

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

• Phaser.Component.Core#fresh

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

game : Phaser.Game

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

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

• Phaser.Component.Core#game

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

height : число

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

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

• PIXI.Sprite#height

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

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

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

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

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

Тип

• Phaser.InputHandler | null

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

• Phaser.Component.InputEnabled#input

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

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

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

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

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

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

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

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

• Phaser.Component.InputEnabled#inputEnabled

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

justReleasedPreventsOver : Phaser.PointerMode

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

Это поведение было введено в Phaser 2.3.1; это свойство является мягким возвратом изменения.

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

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

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

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

• Phaser.Component.Bounds#left

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

lifespan : число

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

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

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

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

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

• Phaser.Component.LifeSpan#lifespan

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

name : строка

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

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

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

• Phaser.Component.Bounds#offsetY

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

[только для чтения] onDownSound : Phaser.Sound | Phaser.AudioSprite | null

Звук, который будет воспроизведён при активации состояния Down этой кнопки.

Тип

• Phaser.Sound | Phaser.AudioSprite | null

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

[только для чтения] onDownSoundMarker : string

Маркер звука, используемый совместно с onDownSound.

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

onInputDown : Phaser.Signal

Сигнал (или событие), отправляемый, когда эта кнопка находится в состоянии Down.

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

onInputOut : Phaser.Signal

Сигнал (или событие), отправляемый, когда эта кнопка находится в состоянии Out.

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

onInputOver : Phaser.Signal

Сигнал (или событие), отправляемый, когда эта кнопка находится в состоянии Over.

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

onInputUp : Phaser.Signal

Сигнал (или событие), отправляемый, когда эта кнопка находится в состоянии Up.

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

[только для чтения] onOutSound : Phaser.Sound | Phaser.AudioSprite | null

Звук, который будет воспроизведён при активации состояния Out этой кнопки.

Тип

• Phaser.Sound | Phaser.AudioSprite | null

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

[только для чтения] onOutSoundMarker : string

Маркер звука, используемый совместно с onOutSound.

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

onOverMouseOnly : boolean

Если true, события onOver (например, onOverSound) будут срабатывать только если объект Pointer, вызвавший их, был указателем мыши.
Фрейм всё равно будет изменён, если это необходимо.

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

• true

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

[только для чтения] onOverSound : Phaser.Sound | Phaser.AudioSprite | null

Звук, который будет воспроизведён при активации состояния Over этой кнопки.

Тип

• Phaser.Sound | Phaser.AudioSprite | null

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

[только для чтения] onOverSoundMarker : string

Маркер звука, используемый совместно с onOverSound.

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

[только для чтения] onUpSound : Phaser.Sound | Phaser.AudioSprite | null

Звук, который будет воспроизведён при активации состояния Up этой кнопки.

Тип

• Phaser.Sound | Phaser.AudioSprite | null

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

[только для чтения] onUpSoundMarker : string

Маркер звука, используемый совместно с onUpSound.

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

pendingDestroy : boolean

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

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

• Phaser.Component.Core#pendingDestroy

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

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

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

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

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

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

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

• Phaser.Component.Core#previousPosition

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

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

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

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

• Phaser.Component.Core#previousRotation

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

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

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

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

• Phaser.Component.Core#renderOrderID

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

right : число

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

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

• Phaser.Component.Bounds#right

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

scaleMax : Phaser.Point

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

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

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

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

• Phaser.Component.ScaleMinMax#scaleMax

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

scaleMin : Phaser.Point

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

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

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

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

• Phaser.Component.ScaleMinMax#scaleMin

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

shader : PIXI.AbstractFilter

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

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

• PIXI.Sprite#shader

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

• null

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

smoothed : boolean

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

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

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

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

• Phaser.Component.Smoothed#smoothed

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

texture : PIXI.Texture

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

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

• PIXI.Sprite#texture

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

tint : число

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

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

• PIXI.Sprite#tint

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

• 0xFFFFFF

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

tintedTexture :Canvas

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

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

• PIXI.Sprite#tintedTexture

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

• null

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

top : число

Координата y объекта Game.
Это то же самое, что и 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)

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

Тип объекта Phaser.

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

width : число

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

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

• PIXI.Sprite#width

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

world : Phaser.Point

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

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

• Phaser.Component.Core#world

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

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

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

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

• Phaser.Component.Core#z

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

Публичные методы

addChild(child) → {DisplayObject}

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

Parameters

Name	Type	Описание
child	DisplayObject	Элемент DisplayObject, который нужно добавить в контейнер

Returns

DisplayObject -

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

Inherited From

• PIXI.DisplayObjectContainer#addChild

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

addChildAt(child, index) → {DisplayObject}

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

Parameters

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

Returns

DisplayObject -

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

Inherited From

• PIXI.DisplayObjectContainer#addChildAt

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

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

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

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

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

Parameters

Name	Type	Argument	Default	Description
container	Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite			Объект игры или прямоугольник, относительно которого нужно выровнять этот объект игры. Также может включать свойства такие как World.bounds или Camera.view.
position	целое число	<optional>		Постоянная положения. Одно из значений Phaser.TOP_LEFT (по умолчанию), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER, Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER или Phaser.BOTTOM_RIGHT.
offsetX	целое число	<optional>	0	Горизонтальная корректировка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное для увеличения.
offsetY	целое число	<optional>	0	Вертикальная корректировка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное для увеличения.

Returns

Объект -

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

Inherited From

• Phaser.Component.Bounds#alignIn

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

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

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

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

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

Parameters

Имя	Тип	Аргумент	По умолчанию	Описание
parent	Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite			Объект игры или прямоугольник, к которому нужно выровнять этот объект игры. Также может включать свойства, такие как World.bounds или Camera.view.
position	целое число	<необязательно>		Постоянная позиции. Одна из Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_TOP, Phaser.LEFT_CENTER, Phaser.LEFT_BOTTOM, Phaser.RIGHT_TOP, Phaser.RIGHT_CENTER, Phaser.RIGHT_BOTTOM, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER или Phaser.BOTTOM_RIGHT.
offsetX	целое число	<необязательно>	0	Горизонтальная настройка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное - для увеличения.
offsetY	целое число	<необязательно>	0	Вертикальная настройка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное - для увеличения.

Возвращает

Объект -

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

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

• Phaser.Component.Bounds#alignTo

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

bringToTop() → {PIXI.DisplayObject}

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

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.BringToTop#bringToTop

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

clearFrames()

Очищает все установленные кадры для этой кнопки.

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

contains(child) → {Boolean}

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

Параметры

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

Возвращает

Boolean -

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

• PIXI.DisplayObjectContainer#contains

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

crop(rect, copy)

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

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

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

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

Параметры

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

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

• Phaser.Component.Crop#crop

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

destroy(destroyChildren, destroyTexture)

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

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

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

Параметры

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

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

• Phaser.Component.Destroy#destroy

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

getBounds(matrix) → {Rectangle}

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

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

Параметры

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

Возвращает

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

рамка

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

• PIXI.Sprite#getBounds

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

getChildAt(index) → {DisplayObject}

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

Параметры

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

Возвращает

DisplayObject -

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

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

• PIXI.DisplayObjectContainer#getChildAt

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

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

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

Параметры

Имя	Тип	Описание
child	DisplayObject	Дочерний элемент DisplayObject

Возвращает

Число -

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

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

• PIXI.DisplayObjectContainer#getChildIndex

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

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

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

Возвращает

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

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

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

• PIXI.Sprite#getLocalBounds

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

kill() → {PIXI.DisplayObject}

Уничтожает объект Game. Уничтоженный объект Game имеет свойства alive, exists и visible со значением false.

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

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

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.LifeSpan#kill

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

loadTexture(key, frame, stopAnimation)

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

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

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

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

Вы можете использовать новую константу 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 вниз на одну позицию в списке отображения родителя.
Этот вызов не имеет эффекта, если объект Game уже находится внизу списка отображения.

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.BringToTop#moveDown

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

moveUp() → {PIXI.DisplayObject}

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

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

Возвращает

PIXI.DisplayObject -

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

Inherited From

• Phaser.Component.BringToTop#moveUp

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

<internal> onInputDownHandler(sprite, pointer)

Внутренняя функция, обрабатывающая события ввода.

Parameters

Name	Type	Description
sprite	Phaser.Button	Кнопка, на которой произошло событие.
pointer	Phaser.Pointer	Указатель, который активировал кнопку.

Internal:

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

Source code: gameobjects/Button.js (Line 531)

<internal> onInputOutHandler(sprite, pointer)

Внутренняя функция, обрабатывающая события ввода.

Parameters

Name	Type	Description
sprite	Phaser.Button	Кнопка, на которой произошло событие.
pointer	Phaser.Pointer	Указатель, который активировал кнопку.

Internal:

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

Source code: gameobjects/Button.js (Line 511)

<internal> onInputOverHandler(sprite, pointer)

Внутренняя функция, обрабатывающая события ввода.

Parameters

Name	Type	Description
sprite	Phaser.Button	Кнопка, на которой произошло событие.
pointer	Phaser.Pointer	Указатель, который активировал кнопку.

Internal:

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

Source code: gameobjects/Button.js (Line 478)

<internal> onInputUpHandler(sprite, pointer)

Внутренняя функция, обрабатывающая события ввода.

Parameters

Name	Type	Description
sprite	Phaser.Button	Кнопка, на которой произошло событие.
pointer	Phaser.Pointer	Указатель, который активировал кнопку.

Internal:

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

Source code: gameobjects/Button.js (Line 551)

overlap(displayObject) → {boolean}

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

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

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

Parameters

Name	Type	Description
displayObject	Phaser.Sprite | Phaser.Image | Phaser.TileSprite | Phaser.Button | PIXI.DisplayObject	Объект отображения для проверки.

Returns

boolean -

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

Inherited From

• Phaser.Component.Overlap#overlap

Source code: gameobjects/components/Overlap.js (Line 29)

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

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

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

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

Parameters

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

Returns

Phaser.Animation -

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

Inherited From

• Phaser.Component.Animation#play

Source code: gameobjects/components/Animation.js (Line 31)

<internal> postUpdate()

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

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

• Phaser.Component.Core#postUpdate

Внутреннее:

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

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

preUpdate()

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

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

• Phaser.Image#preUpdate

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

removeChild(child) → {DisplayObject}

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

Параметры

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

<internal> removedFromWorld()

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

Внутреннее:

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

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

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

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

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

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

Если у объекта есть физический компонент (Body), он сбросит его состояние.

Параметры

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

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

PIXI.DisplayObject -

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

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

• Phaser.Component.Reset#reset

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

resetFrame()

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

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

• Phaser.Component.LoadTexture#resetFrame

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

resizeFrame(parent, width, height)

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

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

Параметры

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

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

• Phaser.Component.LoadTexture#resizeFrame

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

revive(health) → {PIXI.DisplayObject}

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

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

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

Параметры

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.LifeSpan#revive

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

sendToBack() → {PIXI.DisplayObject}

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

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

Возвращает

PIXI.DisplayObject -

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

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

• Phaser.Component.BringToTop#sendToBack

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

setChildIndex(child, index)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#setChildIndex

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

setDownSound(sound, marker)

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

Параметры

Имя	Тип	Аргумент	Описание
sound	Phaser.Sound | Phaser.AudioSprite		Звук, который будет воспроизводиться.
marker	строка	<необязательно>	Маркер звука, который будет использоваться при воспроизведении.

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

setFrame(frame)

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

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

Параметры

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

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

• Phaser.Component.LoadTexture#setFrame

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

setFrames(overFrame, outFrame, downFrame, upFrame)

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

Кадры могут быть указаны либо как целое число (идентификатор кадра), либо как строка (имя кадра); эти значения совпадают с теми, которые могут быть использованы с конструктором Sprite.

Параметры

Имя	Тип	Аргумент	Описание
overFrame	строка | целое число	<необязательно>	Кадр / имя кадра, когда кнопка находится в состоянии Over.
outFrame	строка | целое число	<необязательно>	Кадр / имя кадра, когда кнопка находится в состоянии Out.
downFrame	строка | целое число	<необязательно>	Кадр / имя кадра, когда кнопка находится в состоянии Down.
upFrame	строка | целое число	<необязательно>	Кадр / имя кадра, когда кнопка находится в состоянии Up.

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

setOutSound(sound, marker)

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

Параметры

Имя	Тип	Аргумент	Описание
sound	Phaser.Sound | Phaser.AudioSprite		Звук, который будет воспроизводиться.
marker	строка	<необязательно>	Маркер звука, который будет использоваться при воспроизведении.

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

setOverSound(sound, marker)

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

Параметры

Имя	Тип	Аргумент	Описание
sound	Phaser.Sound | Phaser.AudioSprite		Звук, который будет воспроизводиться.
marker	строка	<необязательно>	Маркер звука, который будет использоваться при воспроизведении.

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

setScaleMinMax(minX, minY, maxX, maxY)

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

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

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

Если указан только один параметр, это значение будет использоваться как для 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)

setSounds(overSound, overMarker, downSound, downMarker, outSound, outMarker, upSound, upMarker)

Устанавливает звуки, которые будут воспроизводиться при взаимодействии с этой кнопкой. Звуки могут быть как полными объектами звуков, так и маркерами, указывающими на часть объекта звука.
Наиболее распространенными формами звуков являются эффекты «наведения» и «нажатия», поэтому порядок параметров — overSound, затем downSound.

Вызовите эту функцию без параметров, чтобы сбросить все звуки на этой кнопке.

Параметры

Имя	Тип	Аргумент	Описание
overSound	Phaser.Sound | Phaser.AudioSprite	<optional>	Звук при наведении на кнопку.
overMarker	строка	<optional>	Маркер звука при наведении на кнопку.
downSound	Phaser.Sound | Phaser.AudioSprite	<optional>	Звук при нажатии на кнопку.
downMarker	строка	<optional>	Маркер звука при нажатии на кнопку.
outSound	Phaser.Sound | Phaser.AudioSprite	<optional>	Звук при выходе с кнопки.
outMarker	строка	<optional>	Маркер звука при выходе с кнопки.
upSound	Phaser.Sound | Phaser.AudioSprite	<optional>	Звук при отпускании кнопки.
upMarker	строка	<optional>	Маркер звука при отпускании кнопки.

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

setTexture(texture, destroy)

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

Параметры

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

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

• PIXI.Sprite#setTexture

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

setUpSound(sound, marker)

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

Параметры

Имя	Тип	Аргумент	Описание
sound	Phaser.Sound | Phaser.AudioSprite		Звук, который будет воспроизводиться.
marker	строка	<optional>	Маркер звука, который будет использоваться при воспроизведении.

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

swapChildren(child, child2)

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

Параметры

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

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

• PIXI.DisplayObjectContainer#swapChildren

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

update()

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

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

• Phaser.Component.Core#update

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

updateCrop()

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

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

• Phaser.Component.Crop#updateCrop

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