Spec-Zone.ru › Phaser

Класс: Phaser.Particle

Конструктор

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

Создать новый Particle объект. Частицы — это расширенные спрайты, которые испускаются эмиттером частиц, например, Phaser.Particles.Arcade.Emitter.

Параметры
Имя Тип Описание
game Phaser.Game

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

x number

Координата x (в мировом пространстве) для позиционирования частицы.

y number

Координата y (в мировом пространстве) для позиционирования частицы.

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

Это изображение или текстура, используемые частицей во время отрисовки. Может быть строкой, которая ссылается на запись кэша, или экземпляром RenderTexture или PIXI.Texture.

frame string | number

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

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

Расширяет

  • Phaser.Sprite

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

alive : boolean

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

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

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

Унаследовано от
  • Phaser.Component.LifeSpan#alive
Значение по умолчанию
  • true
Исходный код: gameobjects/components/LifeSpan.js (Строка 50)

<internal> alphaData :array

Ссылка на массив alphaData, принадлежащий Эмиттеру, который испустил эту частицу.

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: gameobjects/Particle.js (Строка 51)

anchor :Point

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

Унаследовано от
  • PIXI.Sprite#anchor
Исходный код: pixi/display/Sprite.js (Строка 17)

angle : number

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

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

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

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

Унаследовано от
  • 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

<internal> autoAlpha : boolean

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

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: gameobjects/Particle.js (Строка 45)

autoCull : boolean

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

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

Унаследовано от
  • Phaser.Component.AutoCull#autoCull
Исходный код: gameobjects/components/AutoCull.js (Строка 28)

<internal> autoScale : boolean

Если эта частица автоматически масштабируется, это свойство устанавливается в true методом Particle.setScaleData.

Внутреннее:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: gameobjects/Particle.js (Строка 27)

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

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

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

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

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

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

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

Тип
  • Phaser.Physics.Arcade.Body | Phaser.Physics.P2.Body | Phaser.Physics.Ninja.Body | null
Унаследовано от
  • Phaser.Component.PhysicsBody#body
Исходный код: gameobjects/components/PhysicsBody.js (Строка 91)

bottom : number

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

Унаследовано от
  • Phaser.Component.Bounds#bottom
Исходный код: gameobjects/components/Bounds.js (Строка 168)

cameraOffset : Phaser.Point

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

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

Inherited From
  • Phaser.Component.FixedToCamera#cameraOffset
Source code: gameobjects/components/FixedToCamera.js (Line 86)

centerX : number

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

Inherited From
  • Phaser.Component.Bounds#centerX
Source code: gameobjects/components/Bounds.js (Line 58)

centerY : number

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

Inherited From
  • Phaser.Component.Bounds#centerY
Source code: gameobjects/components/Bounds.js (Line 80)

checkWorldBounds : boolean

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

Когда объект перестаёт пересекать границы мира, генерируется событие onOutOfBounds.

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

Также объект может быть уничтожен, если outOfBoundsKill имеет значение true.

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

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

Inherited From
  • Phaser.Component.InWorld#checkWorldBounds
Source code: gameobjects/components/InWorld.js (Line 98)

[readonly] children : Array.<DisplayObject>

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

Type
  • Array.<DisplayObject>
Inherited From
  • PIXI.DisplayObjectContainer#children
Source code: pixi/display/DisplayObjectContainer.js (Line 17)

<internal> components : Object

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

Inherited From
  • Phaser.Component.Core#components
Внутреннее:
  • Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
Source code: gameobjects/components/Core.js (Line 167)

cropRect : Phaser.Rectangle

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

Inherited From
  • Phaser.Component.Crop#cropRect
Source code: gameobjects/components/Crop.js (Line 24)

damage

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

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

Inherited From
  • Phaser.Component.Health#damage
Source code: gameobjects/components/Health.js (Line 46)

data : Object

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

Inherited From
  • Phaser.Component.Core#data
Значение по умолчанию
  • {}
Source code: gameobjects/components/Core.js (Line 160)

debug : boolean

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

Inherited From
  • Phaser.Component.Core#debug
Source code: gameobjects/components/Core.js (Line 218)

[readonly] deltaX : number

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

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

Inherited From
  • Phaser.Component.Delta#deltaX
Source code: gameobjects/components/Delta.js (Line 24)

[readonly] deltaY : number

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

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

Inherited From
  • Phaser.Component.Delta#deltaY
Source code: gameobjects/components/Delta.js (Line 42)

[readonly] deltaZ : number

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

Inherited From
  • Phaser.Component.Delta#deltaZ
Source code: gameobjects/components/Delta.js (Line 58)

[readonly] destroyPhase : boolean

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

Inherited From
  • Phaser.Component.Destroy#destroyPhase
Source code: gameobjects/components/Destroy.js (Line 22)

events : Phaser.Events

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

Inherited From
  • Phaser.Component.Core#events
Source code: gameobjects/components/Core.js (Line 185)
See
  • Phaser.Events

exists : boolean

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

Inherited From
  • PIXI.Sprite#exists
Значение по умолчанию
  • true
Source code: pixi/display/Sprite.js (Line 103)

fixedToCamera : boolean

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

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

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

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

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

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

Inherited From
  • Phaser.Component.FixedToCamera#fixedToCamera
Source code: gameobjects/components/FixedToCamera.js (Line 56)

frame : integer

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

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

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

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

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

Inherited From
  • Phaser.Component.LoadTexture#frame
Source code: gameobjects/components/LoadTexture.js (Line 254)

frameName : string

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

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

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

Если вы используете спрайт-лист, то вместо этого используйте свойство frame.

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

Inherited From
  • Phaser.Component.LoadTexture#frameName
Source code: gameobjects/components/LoadTexture.js (Line 279)

[readonly] fresh : boolean

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

Inherited From
  • Phaser.Component.Core#fresh
Source code: gameobjects/components/Core.js (Line 248)

game : Phaser.Game

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

Inherited From
  • Phaser.Component.Core#game
Source code: gameobjects/components/Core.js (Line 142)

heal

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

Inherited From
  • Phaser.Component.Health#heal
Source code: gameobjects/components/Health.js (Line 90)

health : number

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

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

Inherited From
  • Phaser.Component.Health#health
Значение по умолчанию
  • 1
Source code: gameobjects/components/Health.js (Line 26)

height : number

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

Inherited From
  • PIXI.Sprite#height
Source code: pixi/display/Sprite.js (Line 144)

ignoreChildInput : boolean

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

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

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

Inherited From
  • PIXI.DisplayObjectContainer#ignoreChildInput
Source code: pixi/display/DisplayObjectContainer.js (Line 26)

[readonly] inCamera : boolean

Проверяет, пересекаются ли границы объекта Game с границами камеры Game.
Возвращает 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 : boolean

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

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

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

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

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

Наследуется от
  • Phaser.Component.InputEnabled#inputEnabled
Исходный код: gameobjects/components/InputEnabled.js (Строка 42)

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

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

Наследуется от
  • Phaser.Component.InWorld#inWorld
Исходный код: gameobjects/components/InWorld.js (Строка 129)

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

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

Тип
  • string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture
Наследуется от
  • Phaser.Component.Core#key
Исходный код: gameobjects/components/Core.js (Строка 203)

left : number

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

Наследуется от
  • Phaser.Component.Bounds#left
Исходный код: gameobjects/components/Bounds.js (Строка 102)

lifespan : number

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

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

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

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

Наследуется от
  • Phaser.Component.LifeSpan#lifespan
Исходный код: gameobjects/components/LifeSpan.js (Строка 65)

maxHealth : number

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

Наследуется от
  • Phaser.Component.Health#maxHealth
Значение по умолчанию
  • 100
Исходный код: gameobjects/components/Health.js (Строка 35)

name : string

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

Наследуется от
  • Phaser.Component.Core#name
Исходный код: gameobjects/components/Core.js (Строка 150)

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

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

Наследуется от
  • Phaser.Component.Bounds#offsetX
Исходный код: gameobjects/components/Bounds.js (Строка 24)

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

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

Наследуется от
  • Phaser.Component.Bounds#offsetY
Исходный код: gameobjects/components/Bounds.js (Строка 42)

outOfBoundsKill : boolean

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

Наследуется от
  • Phaser.Component.InWorld#outOfBoundsKill
Исходный код: gameobjects/components/InWorld.js (Строка 106)

outOfCameraBoundsKill : boolean

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

Inherited From
  • Phaser.Component.InWorld#outOfCameraBoundsKill
Source code: gameobjects/components/InWorld.js (Line 115)

pendingDestroy : boolean

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

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

Inherited From
  • Phaser.Component.Core#pendingDestroy
Source code: gameobjects/components/Core.js (Line 259)

[readonly] physicsType : number

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

Inherited From
  • Phaser.Sprite#physicsType
Source code: gameobjects/Sprite.js (Line 61)

[readonly] previousPosition : Phaser.Point

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

Inherited From
  • Phaser.Component.Core#previousPosition
Source code: gameobjects/components/Core.js (Line 225)

[readonly] previousRotation : number

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

Inherited From
  • Phaser.Component.Core#previousRotation
Source code: gameobjects/components/Core.js (Line 232)

[readonly] renderOrderID : number

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

Inherited From
  • Phaser.Component.Core#renderOrderID
Source code: gameobjects/components/Core.js (Line 240)

right : number

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

Inherited From
  • Phaser.Component.Bounds#right
Source code: gameobjects/components/Bounds.js (Line 124)

<internal> scaleData :array

Ссылка на массив scaleData, принадлежащий Emitter, который испустил эту частицу.

Internal:
  • Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
Source code: gameobjects/Particle.js (Line 33)

scaleMax : Phaser.Point

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

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

Установите его в null, чтобы удалить ограничение.

Inherited From
  • Phaser.Component.ScaleMinMax#scaleMax
Source code: gameobjects/components/ScaleMinMax.js (Line 46)

scaleMin : Phaser.Point

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

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

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

Inherited From
  • Phaser.Component.ScaleMinMax#scaleMin
Source code: gameobjects/components/ScaleMinMax.js (Line 36)

setHealth

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

Inherited From
  • Phaser.Component.Health#setHealth
Source code: gameobjects/components/Health.js (Line 70)

shader : PIXI.AbstractFilter

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

Inherited From
  • PIXI.Sprite#shader
Default Value
  • null
Source code: pixi/display/Sprite.js (Line 93)

smoothed : boolean

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

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

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

Inherited From
  • Phaser.Component.Smoothed#smoothed
Source code: gameobjects/components/Smoothed.js (Line 25)

texture : PIXI.Texture

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

Inherited From
  • PIXI.Sprite#texture
Source code: pixi/display/Sprite.js (Line 28)

tint : number

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

Унаследованно от
  • PIXI.Sprite#tint
Значение по умолчанию
  • 0xFFFFFF
Исходный код: pixi/display/Sprite.js (Строка 54)

tintedTexture :Canvas

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

Унаследованно от
  • PIXI.Sprite#tintedTexture
Значение по умолчанию
  • null
Исходный код: pixi/display/Sprite.js (Строка 73)

top : number

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

Унаследованно от
  • Phaser.Component.Bounds#top
Исходный код: gameobjects/components/Bounds.js (Строка 146)

transformCallback : Function

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

Унаследованно от
  • Phaser.Component.ScaleMinMax#transformCallback
Исходный код: gameobjects/components/ScaleMinMax.js (Строка 20)

transformCallbackContext : Object

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

Унаследованно от
  • Phaser.Component.ScaleMinMax#transformCallbackContext
Исходный код: gameobjects/components/ScaleMinMax.js (Строка 26)

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

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

Унаследованно от
  • Phaser.Sprite#type
Исходный код: gameobjects/Sprite.js (Строка 55)

width : number

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

Унаследованно от
  • PIXI.Sprite#width
Исходный код: pixi/display/Sprite.js (Строка 125)

world : Phaser.Point

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

Унаследованно от
  • Phaser.Component.Core#world
Исходный код: gameobjects/components/Core.js (Строка 211)

x : number

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

Унаследованно от
  • Phaser.Component.PhysicsBody#x
Исходный код: gameobjects/components/PhysicsBody.js (Строка 98)

y : number

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

Унаследованно от
  • Phaser.Component.PhysicsBody#y
Исходный код: gameobjects/components/PhysicsBody.js (Строка 124)

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

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

Унаследованно от
  • Phaser.Component.Core#z
Исходный код: gameobjects/components/Core.js (Строка 177)

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

addChild(child) → {DisplayObject}

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

Parameters
Name Type Описание
child DisplayObject

DisplayObject для добавления в контейнер

Returns
DisplayObject -

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

Inherited From
  • PIXI.DisplayObjectContainer#addChild
Source code: pixi/display/DisplayObjectContainer.js (Строка 42)

addChildAt(child, index) → {DisplayObject}

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

Parameters
Name Type Описание
child DisplayObject

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

index Number

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

Returns
DisplayObject -

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

Inherited From
  • PIXI.DisplayObjectContainer#addChildAt
Source code: pixi/display/DisplayObjectContainer.js (Строка 55)

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

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

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

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

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

Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER,
Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT,
Phaser.BOTTOM_CENTER и Phaser.BOTTOM_RIGHT.

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

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

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

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

Parameters
Name Type Argument Default Описание
container Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite

Объект Game Object или прямоугольник, к которому выровнять этот объект Game Object. Может также включать свойства, такие как World.bounds или Camera.view.

position integer <optional>

Постоянное значение позиции. Одно из Phaser.TOP_LEFT (по умолчанию), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER, Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER или Phaser.BOTTOM_RIGHT.

offsetX integer <optional>
0

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

offsetY integer <optional>
0

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

Returns
Object -

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

Inherited From
  • Phaser.Component.Bounds#alignIn
Source code: gameobjects/components/Bounds.js (Строка 223)

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

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

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

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

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

Phaser.TOP_LEFT (по умолчанию), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_TOP,
Phaser.LEFT_CENTER, Phaser.LEFT_BOTTOM, Phaser.RIGHT_TOP, Phaser.RIGHT_CENTER,
Phaser.RIGHT_BOTTOM, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER
и Phaser.BOTTOM_RIGHT.

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

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

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

Parameters
Имя Тип Аргумент Значение по умолчанию Описание
parent Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite

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

Горизонтальная корректировка границ контейнера, применяемая к выровненной позиции объекта Game. Используйте отрицательное значение для уменьшения границ, положительное - для увеличения.

offsetY целое число <необязательно>
0

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

Возвращает
Объект -

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

Унаследованно от
  • Phaser.Component.Bounds#alignTo
Исходный код: gameobjects/components/Bounds.js (Строка 321)

bringToTop() → {PIXI.DisplayObject}

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

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

Возвращает
PIXI.DisplayObject -

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

Унаследованно от
  • Phaser.Component.BringToTop#bringToTop
Исходный код: gameobjects/components/BringToTop.js (Строка 24)

contains(child) → {Boolean}

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

Параметры
Имя Тип Описание
child DisplayObject

-

Возвращает
Boolean -
Унаследованно от
  • PIXI.DisplayObjectContainer#contains
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 449)

crop(rect, copy)

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

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

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

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
destroyChildren boolean <необязательно>
true

Должен ли каждый дочерний элемент этого объекта также вызвать свой метод destroy?

destroyTexture boolean <необязательно>
false

Уничтожить BaseTexture, используемую этим объектом Game? Обратите внимание, что если другой объект Game использует ту же BaseTexture, она будет недействительной.

Унаследованно от
  • Phaser.Component.Destroy#destroy
Исходный код: gameobjects/components/Destroy.js (Строка 37)

getBounds(matrix) → {Rectangle}

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

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

Параметры
Имя Тип Описание
matrix Matrix

матрица преобразования спрайта

Возвращает
Rectangle -

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

Inherited From
  • PIXI.Sprite#getBounds
Исходный код: pixi/display/Sprite.js (Строка 199)

getChildAt(index) → {DisplayObject}

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

Параметры
Имя Тип Описание
index Число

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

Возвращает
DisplayObject -

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

Inherited From
  • PIXI.DisplayObjectContainer#getChildAt
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 153)

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

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

Параметры
Имя Тип Описание
child DisplayObject

Элемент DisplayObject для идентификации

Возвращает
Число -

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

Inherited From
  • PIXI.DisplayObjectContainer#getChildIndex
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 112)

getLocalBounds() → {Rectangle}

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

Возвращает
Rectangle -

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

Inherited From
  • PIXI.Sprite#getLocalBounds
Исходный код: pixi/display/Sprite.js (Строка 315)

kill() → {PIXI.DisplayObject}

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

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

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

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

Возвращает
PIXI.DisplayObject -

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

Inherited From
  • 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'
и заменив его на ключ данных карты текстур.

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
key строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture

Это изображение или текстура, используемая спрайтом во время рендеринга. Может быть строкой, которая ссылается на запись кэша изображения, или экземпляром RenderTexture, BitmapData, Video или PIXI.Texture.

frame строка | число <дополнительный>

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

stopAnimation логическое <дополнительный>
true

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

Inherited From
  • Phaser.Component.LoadTexture#loadTexture
Исходный код: gameobjects/components/LoadTexture.js (Строка 51)

moveDown() → {PIXI.DisplayObject}

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

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

Возвращает
PIXI.DisplayObject -

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

Inherited From
  • Phaser.Component.BringToTop#moveDown
Исходный код: gameobjects/components/BringToTop.js (Строка 87)

moveUp() → {PIXI.DisplayObject}

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

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

Возвращает
PIXI.DisplayObject -

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

Унаследованно от
  • Phaser.Component.BringToTop#moveUp
Исходный код: gameobjects/components/BringToTop.js (Строка 66)

onEmit()

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

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

overlap(displayObject) → {boolean}

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

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

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

Параметры
Имя Тип Описание
displayObject Phaser.Sprite | Phaser.Image | Phaser.TileSprite | Phaser.Button | PIXI.DisplayObject

Объект отображения для проверки.

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

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

Унаследованно от
  • Phaser.Component.Overlap#overlap
Исходный код: gameobjects/components/Overlap.js (Строка 29)

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

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

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

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
name string

Имя воспроизводимой анимации, например, "огонь", "ходьба", "прыжок". Должно быть предварительно создано с помощью 'AnimationManager.add'.

frameRate number <необязательно>
null

Частота кадров воспроизведения анимации. Скорость задается в кадрах в секунду. Если не указано, используется ранее заданная частота кадров анимации.

loop boolean <необязательно>
false

Нужно ли циклически повторять анимацию после воспроизведения. Если не указано, используется ранее заданное значение loop анимации.

killOnComplete boolean <необязательно>
false

Если установлено в значение true, при завершении анимации (происходит только если loop=false) родительский Sprite будет уничтожен.

Возвращаемое значение
Phaser.Animation -

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

Унаследованно от
  • Phaser.Component.Animation#play
Исходный код: gameobjects/components/Animation.js (Строка 31)

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

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

Унаследованно от
  • Phaser.Component.Core#postUpdate
Внутренний:
  • Этот элемент является внутренним (защищенным) и может быть изменен или удален в будущем.
Исходный код: gameobjects/components/Core.js (Строка 338)

preUpdate() → {boolean}

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

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

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

Унаследованно от
  • Phaser.Sprite#preUpdate
Исходный код: gameobjects/Sprite.js (Строка 107)

removeChild(child) → {DisplayObject}

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

Параметры
Имя Тип Описание
child DisplayObject

Объект DisplayObject для удаления

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

Потомок, который был удален.

Унаследованно от
  • PIXI.DisplayObjectContainer#removeChild
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 171)

removeChildAt(index) → {DisplayObject}

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

Параметры
Имя Тип Описание
index Number

Индекс для получения потомка

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

Потомок, который был удален.

Унаследованно от
  • PIXI.DisplayObjectContainer#removeChildAt
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 191)

removeChildren(beginIndex, endIndex)

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

Параметры
Имя Тип Описание
beginIndex Число

Начальная позиция. Значение по умолчанию — 0.

endIndex Число

Конечная позиция. Значение по умолчанию — размер контейнера.

Унаследовано от
  • PIXI.DisplayObjectContainer#removeChildren
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 213)

reset(x, y, health) → {Phaser.Particle}

Сбрасывает частицу. Это помещает частицу в заданные мировые координаты x/y и затем
устанавливает alive, exists, visible и renderable в значение true. Также сбрасывает состояние outOfBounds и значения health.
Если у частицы есть физическое тело, то оно также сбрасывается.

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
x число

Координата x (в мировом пространстве), на которую должна быть помещена частица.

y число

Координата y (в мировом пространстве), на которую должна быть помещена частица.

health число <дополнительно>
1

Здоровье, которое нужно присвоить частице.

Возвращает
Phaser.Particle -

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

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

resetFrame()

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

Унаследовано от
  • Phaser.Component.LoadTexture#resetFrame
Исходный код: gameobjects/components/LoadTexture.js (Строка 232)

resizeFrame(parent, width, height)

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

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

Здоровье, которое нужно присвоить игровому объекту. Устанавливается только если у GameObject есть компонент 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)

setAlphaData()

Вызывается эмиттером, если включен autoAlpha. Передает данные о плавном изменении альфа-канала и сбрасывает счётчик альфы.

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

setChildIndex(child, index)

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

Параметры
Имя Тип Описание
child DisplayObject

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

index Число

Результирующий номер индекса для дочернего элемента отображения

Унаследовано от
  • PIXI.DisplayObjectContainer#setChildIndex
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 132)

setFrame(frame)

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

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

Параметры
Имя Тип Описание
frame Phaser.Frame

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

Унаследовано от
  • Phaser.Component.LoadTexture#setFrame
Исходный код: gameobjects/components/LoadTexture.js (Строка 155)

setScaleData()

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

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

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)

setTexture(texture, destroy)

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
texture PIXI.Texture

Текстура PIXI, отображаемая спрайтом

destroy Булево <необязательно>
false

Вызвать Texture.destroy для текущей текстуры перед заменой ее новой?

Унаследовано от
  • PIXI.Sprite#setTexture
Исходный код: pixi/display/Sprite.js (Строка 163)

swapChildren(child, child2)

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

Параметры
Имя Тип Описание
child DisplayObject

-

child2 DisplayObject

-

Унаследовано от
  • PIXI.DisplayObjectContainer#swapChildren
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 85)

update()

Обновляет масштаб частицы или альфа-канал, если установлены автомасштабирование и автоальфа.

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

updateCrop()

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

Унаследовано от
  • Phaser.Component.Crop#updateCrop
Исходный код: gameobjects/components/Crop.js (Строка 86)

© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Particle.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API