Spec-Zone.ru › Phaser

Класс: Phaser.Graphics

Конструктор

new Graphics(game, x, y)

Объект Graphics предназначен для рисования примитивов в игре. Примитивы включают в себя геометрические фигуры, такие как прямоугольники,
круги и многоугольники. Они также включают линии, дуги и кривые. При первоначальном создании объект Graphics будет
пустым. Для «рисования» в нем необходимо сначала указать стиль линии или заливки (или оба), а затем нарисовать фигуру. Например:

graphics.beginFill(0xff0000);
graphics.drawCircle(50, 50, 100);
graphics.endFill();

Это нарисует круг в объекте Graphics с диаметром 100, расположенный по координатам x: 50, y: 50.

При отрисовке объекта Graphics, отрисовка будет отличаться в зависимости от того, работает ли игра в режиме Canvas или
WebGL. В режиме Canvas используется контекст HTML Canvas для рисования пути. В режиме WebGL данные графики разбиваются на многоугольники. Оба этих процесса являются ресурсоемкими, особенно для сложных фигур.

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

Как вы можете понять, объекты Graphics являются компромиссом. Хотя они очень полезны, необходимо быть осторожным с их сложностью и количеством в вашей игре.

Параметры
Имя Тип Аргумент По умолчанию Описание
game Phaser.Game

Текущая инстанция игры.

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

Позиция X нового объекта Graphics.

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

Позиция Y нового объекта Graphics.

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

Расширяет

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

Публичные свойства

alive : boolean

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

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

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

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

angle : number

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

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

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

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

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

animations : Phaser.AnimationManager

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

Inherited From
  • Phaser.Component.Core#animations
Исходный код: gameobjects/components/Core.js (Строка 193)
См.
  • Phaser.AnimationManager

autoCull : boolean

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

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

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

blendMode : number

Режим смешивания, применяемый к форме графики. Примените значение PIXI.blendModes.NORMAL для сброса режима смешивания.

Inherited From
  • PIXI.Graphics#blendMode
Значение по умолчанию
  • PIXI.blendModes.NORMAL;
Исходный код: pixi/primitives/Graphics.js (Строка 61)

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
Inherited From
  • Phaser.Component.PhysicsBody#body
Исходный код: gameobjects/components/PhysicsBody.js (Строка 91)

bottom : number

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

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

boundsPadding : number

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

Inherited From
  • PIXI.Graphics#boundsPadding
Исходный код: pixi/primitives/Graphics.js (Строка 96)

cameraOffset : Phaser.Point

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

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

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

centerX : number

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

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

centerY : number

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

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

checkWorldBounds : boolean

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

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

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

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

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

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

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

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

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

Тип
  • Array.<DisplayObject>
Унаследовано от
  • PIXI.DisplayObjectContainer#children
Исходный код: pixi/display/DisplayObjectContainer.js (Строка 17)

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

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

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

data : Object

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

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

debug : boolean

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

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

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

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

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

events : Phaser.Events

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

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

exists : boolean

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

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

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

fillAlpha : number

Значение альфа, используемое при заполнении объекта Graphics.

Унаследовано от
  • PIXI.Graphics#fillAlpha
Исходный код: pixi/primitives/Graphics.js (Строка 18)

fixedToCamera : boolean

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

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

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

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

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

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

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

[только для чтения] 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 : number

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

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

ignoreChildInput : boolean

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

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

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

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

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

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

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

input : Phaser.InputHandler | null

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

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

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

Тип
  • Phaser.InputHandler | null
Унаследовано от
  • Phaser.Component.InputEnabled#input
Исходный код: gameobjects/components/InputEnabled.js (Строка 24)

inputEnabled : boolean

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

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

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

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

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

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

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

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

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

isMask : boolean

Является ли эта фигура маской.

Унаследовано от
  • PIXI.Graphics#isMask
Исходный код: pixi/primitives/Graphics.js (Строка 88)

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

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

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

left : число

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

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

lifespan : число

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

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

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

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

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

lineColor : строка

Цвет любой проведенной линии.

Унаследовано от
  • PIXI.Graphics#lineColor
Значение по умолчанию
  • 0
Исходный код: pixi/primitives/Graphics.js (Строка 34)

lineWidth : число

Ширина (толщина) любой проведенной линии.

Унаследовано от
  • PIXI.Graphics#lineWidth
Исходный код: pixi/primitives/Graphics.js (Строка 26)

name : строка

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Тип физического тела по умолчанию для этого объекта.

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

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

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

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

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

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

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

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

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

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

right : число

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

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

tint : число

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

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

top : число

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

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

type : число

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

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

width : число

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

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

world : Phaser.Point

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

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

x : number

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

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

y : number

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

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

[readonly] z : number

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

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

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

addChild(child) → {DisplayObject}

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

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

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

Returns
DisplayObject -

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

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

addChildAt(child, index) → {DisplayObject}

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

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

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

index Number

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

Returns
DisplayObject -

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

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

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

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

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

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

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

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

position integer <optional>

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

offsetX integer <optional>
0

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

offsetY integer <optional>
0

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

Returns
Object -

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

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

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

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

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

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

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

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

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

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

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

Выровняет sprite по нижнему правому углу, но сместит его на 20 пикселей от угла.
Рассматривайте смещения как корректировку границ родителя перед выравниванием объекта Game Object.
Отрицательное смещение уменьшит границы родителя, а положительное – увеличит.

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

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

position integer <optional>

Постоянная позиция. Одно из значений 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 integer <optional>
0

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

offsetY integer <optional>
0

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

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

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

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

arc(cx, cy, radius, startAngle, endAngle, anticlockwise, segments) → {PIXI.Graphics}

Метод arc создаёт дугу/кривую (используется для создания окружностей или их частей).

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

Координата x центра окружности

cy Число

Координата y центра окружности

radius Число

Радиус окружности

startAngle Число

Угол начала, в радианах (0 — в 3 часа на часах)

endAngle Число

Угол окончания, в радианах

anticlockwise Булево

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

segments Число

Необязательно. Количество сегментов для расчёта дуги. По умолчанию 40. Для большей точности используйте большее число.

Возвращает
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#arc
Исходный код: pixi/primitives/Graphics.js (Строка 405)

beginFill(color, alpha) → {PIXI.Graphics}

Устанавливает простой одноцветный заливки, который последующие вызовы других методов Graphics (например, lineTo() или drawCircle()) используют при рисовании.

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

Цвет заливки

alpha Число

Прозрачность заливки

Возвращает
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#beginFill
Исходный код: pixi/primitives/Graphics.js (Строка 491)

bezierCurveTo(cpX, cpY, cpX2, cpY2, toX, toY) → {PIXI.Graphics}

Вычисляет точки для кривой Безье и рисует её.

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

Координата x контрольной точки

cpY Число

Координата y контрольной точки

cpX2 Число

Координата x второй контрольной точки

cpY2 Число

Координата y второй контрольной точки

toX Число

Координата x целевой точки

toY Число

Координата y целевой точки

Возвращает
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#bezierCurveTo
Исходный код: pixi/primitives/Graphics.js (Строка 276)

clear() → {PIXI.Graphics}

Очищает графику, нарисованную в этом объекте Graphics, и сбрасывает настройки стиля заливки и линии.

Возвращает
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#clear
Исходный код: pixi/primitives/Graphics.js (Строка 633)

contains(child) → {Boolean}

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

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

-

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

destroy(destroyChildren)

Уничтожить этот экземпляр Graphics.

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

Следует ли вызвать метод destroy для каждого дочернего элемента этого объекта?

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

destroyCachedSprite()

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

Унаследовано от
  • PIXI.Graphics#destroyCachedSprite
Исходный код: pixi/primitives/Graphics.js (Строка 1173)

drawCircle(x, y, diameter) → {PIXI.Graphics}

Рисует окружность.

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

Координата X центра окружности

y Число

Координата Y центра окружности

diameter Число

Диаметр окружности

Возвращаемое значение
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#drawCircle
Исходный код: pixi/primitives/Graphics.js (Строка 565)

drawEllipse(x, y, width, height) → {PIXI.Graphics}

Рисует эллипс.

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

Координата X центра эллипса

y Число

Координата Y центра эллипса

width Число

Половина ширины эллипса

height Число

Половина высоты эллипса

Возвращаемое значение
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#drawEllipse
Исходный код: pixi/primitives/Graphics.js (Строка 581)

drawPolygon(path) → {PIXI.Graphics}

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

Параметры
Имя Тип Описание
path Массив | PhaserPolygon

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

Возвращаемое значение
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#drawPolygon
Исходный код: pixi/primitives/Graphics.js (Строка 598)

drawRect(x, y, width, height) → {PIXI.Graphics}

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

Координата X левого верхнего угла прямоугольника

y Число

Координата Y левого верхнего угла прямоугольника

width Число

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

height Число

Высота прямоугольника

Возвращаемое значение
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#drawRect
Исходный код: pixi/primitives/Graphics.js (Строка 534)

drawRoundedRect(x, y, width, height, radius)

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

Координата X левого верхнего угла прямоугольника

y Число

Координата Y левого верхнего угла прямоугольника

width Число

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

height Число

Высота прямоугольника

radius Число

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

Унаследовано от
  • PIXI.Graphics#drawRoundedRect
Исходный код: pixi/primitives/Graphics.js (Строка 550)

drawShape(shape) → {PIXI.GraphicsData}

Рисует заданную форму в этот объект Graphics. Может быть любой из Circle, Rectangle, Ellipse, Line или Polygon.

Параметры
Имя Тип Описание
shape Circle | Rectangle | Ellipse | Line | Polygon

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

Возвращаемое значение
PIXI.GraphicsData -

Сгенерированный объект GraphicsData.

Унаследовано от
  • PIXI.Graphics#drawShape
Исходный код: pixi/primitives/Graphics.js (Строка 1184)

endFill() → {PIXI.Graphics}

Применяет заливку к линиям и фигурам, добавленным с момента последнего вызова метода beginFill().

Возвращает
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#endFill
Исходный код: pixi/primitives/Graphics.js (Строка 519)

generateTexture(resolution, scaleMode, padding) → {PIXI.Texture}

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

Параметры
Имя Тип Аргумент Значение по умолчанию Описание
resolution Число <дополнительно>
1

Разрешение генерируемой текстуры

scaleMode Число <дополнительно>
0

Должно быть одним из констант PIXI.scaleMode

padding Число <дополнительно>
0

Добавить дополнительный отступ к сгенерированной текстуре (по умолчанию 0)

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

текстура объекта Graphics

Унаследовано от
  • PIXI.Graphics#generateTexture
Исходный код: pixi/primitives/Graphics.js (Строка 654)

getBounds() → {Rectangle}

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

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

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

Унаследовано от
  • PIXI.Graphics#getBounds
Исходный код: pixi/primitives/Graphics.js (Строка 848)

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

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

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

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

Унаследовано от
  • PIXI.Graphics#getLocalBounds
Исходный код: pixi/primitives/Graphics.js (Строка 936)

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)

lineStyle(lineWidth, color, alpha) → {PIXI.Graphics}

Устанавливает стиль линии, используемый для последующих вызовов методов Graphics, таких как lineTo() или drawCircle().

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

ширина линии для рисования, обновит хранимый стиль объекта

color Число

цвет линии для рисования, обновит хранимый стиль объекта

alpha Число

альфа-значение линии для рисования, обновит хранимый стиль объекта

Возвращает
PIXI.Graphics -
Унаследовано от
  • PIXI.Graphics#lineStyle
Исходный код: pixi/primitives/Graphics.js (Строка 149)

lineTo(x, y) → {PIXI.Graphics}

Рисует линию с текущим стилем линии от текущей позиции рисования до (x, y);
Текущая позиция рисования устанавливается в (x, y).

Parameters
Name Type Description
x Number

координата X, до которой рисовать

y Number

координата Y, до которой рисовать

Returns
PIXI.Graphics -
Inherited From
  • PIXI.Graphics#lineTo
Source code: pixi/primitives/Graphics.js (Line 198)

moveTo(x, y) → {PIXI.Graphics}

Перемещает текущую позицию рисования в x, y.

Parameters
Name Type Description
x Number

координата X, в которую перемещаться

y Number

координата Y, в которую перемещаться

Returns
PIXI.Graphics -
Inherited From
  • PIXI.Graphics#moveTo
Source code: pixi/primitives/Graphics.js (Line 183)

postUpdate()

Автоматически вызывается миром

Source code: gameobjects/Graphics.js (Line 117)

preUpdate()

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

Source code: gameobjects/Graphics.js (Line 106)

quadraticCurveTo(cpX, cpY, toX, toY) → {PIXI.Graphics}

Вычисляет точки для кривой Безье второго порядка и затем рисует ее.
Основано на: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c

Parameters
Name Type Description
cpX Number

Координата x контрольной точки

cpY Number

Координата y контрольной точки

toX Number

Координата x целевой точки

toY Number

Координата y целевой точки

Returns
PIXI.Graphics -
Inherited From
  • PIXI.Graphics#quadraticCurveTo
Source code: pixi/primitives/Graphics.js (Line 221)

removeChild(child) → {DisplayObject}

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

Parameters
Name Type Description
child DisplayObject

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

Returns
DisplayObject -

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

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

removeChildAt(index) → {DisplayObject}

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

Parameters
Name Type Description
index Number

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

Returns
DisplayObject -

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

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

removeChildren(beginIndex, endIndex)

Удаляет всех дочерних элементов контейнера, находящихся в диапазоне beginIndex и endIndex.

Parameters
Name Type Description
beginIndex Number

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

endIndex Number

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

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

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

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

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

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

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

Parameters
Name Type Argument Default Description
x number

Координата x (в мировом пространстве), в которую разместить объект игры.

y number

Координата y (в мировом пространстве), в которую разместить объект игры.

health number <optional>
1

Здоровье, которое будет присвоено объекту игры, если у него есть компонент Health.

Returns
PIXI.DisplayObject -

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

Inherited From
  • Phaser.Component.Reset#reset
Source code: gameobjects/components/Reset.js (Line 30)

revive(health) → {PIXI.DisplayObject}

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

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

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

Parameters
Name Type Argument Default Description
health number <optional>
100

Здоровье, которое нужно присвоить объекту игры. Устанавливается только если у GameObject есть компонент Health.

Returns
PIXI.DisplayObject -

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

Inherited From
  • Phaser.Component.LifeSpan#revive
Source code: gameobjects/components/LifeSpan.js (Line 78)

setChildIndex(child, index)

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

Parameters
Name Type Description
child DisplayObject

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

index Number

Получившийся номер индекса для дочернего объекта отображения.

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

swapChildren(child, child2)

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

Parameters
Name Type Description
child DisplayObject

-

child2 DisplayObject

-

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

update()

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

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

updateLocalBounds()

Обновить границы объекта.

Inherited From
  • PIXI.Graphics#updateLocalBounds
Source code: pixi/primitives/Graphics.js (Line 997)

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

Spec-Zone.ru

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