Класс: Phaser.Rope
Конструктор
new Rope(game, x, y, key, frame, points)
Rope — это спрайт с повторяющейся текстурой.
Текстура автоматически будет повторяться по краям при перемещении.
Обратите внимание, что у Ropes не может быть обработчика ввода.
Параметры
| Имя | Тип | Описание |
|---|---|---|
game | Phaser.Game | Ссылка на текущую запущенную игру. |
x | число | Координата x (в пространстве мира) для позиционирования Rope. |
y | число | Координата y (в пространстве мира) для позиционирования Rope. |
key | строка | Phaser.RenderTexture | Phaser.BitmapData | PIXI.Texture | Изображение или текстура, используемая Rope при отрисовке. Может быть строкой, ссылающейся на запись в кэше, или экземпляром RenderTexture или PIXI.Texture. |
frame | строка | число | Если Rope использует часть спрайт-листа или текстурного атласа, вы можете указать точный кадр для использования, указав строку или числовой индекс. |
points | Массив | Массив {Phaser.Point}. |
- Исходный код: gameobjects/Rope.js (Строка 42)
Расширяет
- PIXI.Rope
- Phaser.Component.Core
- Phaser.Component.Angle
- Phaser.Component.Animation
- Phaser.Component.AutoCull
- Phaser.Component.Bounds
- Phaser.Component.BringToTop
- Phaser.Component.Crop
- Phaser.Component.Delta
- Phaser.Component.Destroy
- Phaser.Component.FixedToCamera
- Phaser.Component.InWorld
- Phaser.Component.LifeSpan
- Phaser.Component.LoadTexture
- Phaser.Component.Overlap
- Phaser.Component.PhysicsBody
- Phaser.Component.Reset
- Phaser.Component.ScaleMinMax
- Phaser.Component.Smoothed
Общественные свойства
- Унаследовано от
- Значение по умолчанию
- true
- Исходный код: gameobjects/components/LifeSpan.js (Строка 50)
- Унаследовано от
- Исходный код: gameobjects/components/Angle.js (Строка 29)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 193)
- См.
- Унаследовано от
- Исходный код: gameobjects/components/AutoCull.js (Строка 28)
- Унаследовано от
- Значение по умолчанию
- PIXI.blendModes.NORMAL;
- Исходный код: pixi/extras/Strip.js (Строка 51)
- Унаследовано от
- Исходный код: gameobjects/components/PhysicsBody.js (Строка 91)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 168)
- Унаследовано от
- Исходный код: gameobjects/components/FixedToCamera.js (Строка 86)
- Унаследовано от
- Исходный код: pixi/extras/Strip.js (Строка 60)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 58)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 80)
alive : boolean
Полезный флаг для управления тем, жив объект Game Object или мёртв.
Он устанавливается автоматически компонентами Health damage метода, если у объекта закончилось здоровье.
Или вы можете переключать его через код вашей игры.
Это свойство в основном предоставлено для использования вашей игрой — оно не влияет на отображение или логические обновления.
Однако вы можете использовать Group.getFirstAlive в сочетании с этим свойством для быстрой работы с пулом и ресайклингом объектов.
angle : number
Свойство angle — это угол поворота объекта Game Object в градусах от его начальной ориентации.
Значения от 0 до 180 представляют поворот по часовой стрелке; значения от 0 до -180 представляют поворот против часовой стрелки.
Значения вне этого диапазона добавляются к 360 или вычитаются из 360, чтобы получить значение в пределах диапазона.
Например, оператор player.angle = 450 эквивалентен player.angle = 90.
Если вы хотите работать в радианах вместо градусов, вы можете использовать свойство rotation вместо него.
Работа в радианах немного быстрее, так как не нужно выполнять никаких вычислений.
animations : Phaser.AnimationManager
Если объект Game Object включён для анимации (например, Phaser.Sprite), это ссылка на его экземпляр AnimationManager.
Через него вы можете создавать, воспроизводить, приостанавливать и останавливать анимации.
autoCull : boolean
Объект Game Object с autoCull установленным в значение true будет проверять свои границы по отношению к камере World каждый кадр.
Если он не пересекает границы камеры в какой-либо момент, то его свойство renderable устанавливается в false.
Это сохраняет объект Game Object живым и продолжает обработку обновлений, но полностью пропускает этап рендеринга.
Это относительно дорогостоящая операция, особенно если она включена для сотен объектов Game Object. Поэтому включайте её только если это необходимо,
или вы протестировали производительность и сочли это приемлемым.
blendMode : number
Режим смешивания, применяемый к спрайту. Установите PIXI.blendModes.NORMAL, чтобы удалить любой режим смешивания.
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.
Если вам нужен другой результат, настройте или пересоздайте смещения формы тела вручную или сбросьте якорь после включения физики.
Тип
bottom : number
Сумма свойств y и height.
Это то же самое, что и y + height - offsetY.
cameraOffset : Phaser.Point
Смещение координат x/y, применяемое к верхнему левому углу камеры, относительно которой будет отображаться этот объект Game Object, если fixedToCamera равно true.
Значения относительны к верхнему левому углу области просмотра камеры и в дополнение к любому родителю объекта Game Object в списке отображения.
canvasPadding : number
Треугольники в режиме canvas автоматически имеют сглаживание краёв, используйте это значение, чтобы принудительно перекрыть треугольники друг с другом.
centerX : number
Координата центра x объекта Game Object.
Это то же самое, что и (x - offsetX) + (width / 2).
centerY : number
Координата центра y объекта Game Object.
Это то же самое, что и (y - offsetY) + (height / 2).
checkWorldBounds : boolean
- Наследуется от
- Исходный код: gameobjects/components/InWorld.js (Строка 98)
- Array.<DisplayObject>
- Наследуется от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 17)
- Наследуется от
- Внутренний:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: gameobjects/components/Core.js (Строка 167)
- Наследуется от
- Исходный код: gameobjects/components/Crop.js (Строка 24)
- Наследуется от
- Значение по умолчанию
- {}
- Исходный код: gameobjects/components/Core.js (Строка 160)
- Наследуется от
- Исходный код: gameobjects/components/Core.js (Строка 218)
- Наследуется от
- Исходный код: gameobjects/components/Delta.js (Строка 24)
- Наследуется от
- Исходный код: gameobjects/components/Delta.js (Строка 42)
- Наследуется от
- Исходный код: gameobjects/components/Delta.js (Строка 58)
- Наследуется от
- Исходный код: gameobjects/components/Destroy.js (Строка 22)
- Наследуется от
- Исходный код: pixi/extras/Strip.js (Строка 43)
- Наследуется от
- Исходный код: gameobjects/components/Core.js (Строка 185)
- См.
Если это значение установлено в true, игровой объект проверяет, находится ли он в пределах границ мира на каждом кадре.
Когда он больше не пересекает границы мира, он отправляет событие onOutOfBounds.
Если он ранее находился за границами, но теперь снова пересекает границы мира, он отправляет событие onEnterBounds.
Он также может уничтожить игровой объект, если outOfBoundsKill равно true.
Когда checkWorldBounds включено, оно заставляет игровой объект вычислять свои полные границы каждый кадр.
Это относительно дорогая операция, особенно если она включена для сотен игровых объектов. Поэтому включайте её только если вы знаете, что она необходима,
или вы протестировали производительность и посчитали её приемлемой.
[только для чтения] children : Array.<DisplayObject>
[только для чтения] Массив дочерних элементов этого контейнера.
Тип
<internal> components : Object
Компоненты, установленные в этом игровом объекте.
cropRect : Phaser.Rectangle
Прямоугольник, используемый для обрезки текстуры, используемой этим игровым объектом.
Установите это свойство через crop.
Если вы изменяете это свойство напрямую, вы должны вызвать updateCrop, чтобы изменения вступили в силу.
data : Object
Пустой объект, принадлежащий этому игровому объекту.
Это значение никогда не используется внутри Phaser, но может использоваться вашим собственным кодом или
плагинами Phaser для хранения данных, которые должны быть связаны с игровым объектом,
без прямого загрязнения игрового объекта.
debug : boolean
Флаг отладки, предназначенный для использования с Game.enableStep.
[только для чтения] deltaX : number
Возвращает значение delta x. Разница между world.x сейчас и на предыдущем кадре.
Значение будет положительным, если игровой объект переместился вправо, или отрицательным, если влево.
[только для чтения] deltaY : number
Возвращает значение delta y. Разница между world.y сейчас и на предыдущем кадре.
Значение будет положительным, если игровой объект переместился вниз, или отрицательным, если вверх.
[только для чтения] deltaZ : number
Возвращает значение delta z. Разница между вращением сейчас и на предыдущем кадре. Значение delta.
[только для чтения] destroyPhase : boolean
Когда игровой объект проходит через свой метод destroy, этот флаг устанавливается в true,
и может быть проверен в любых подсистемах или плагинах, из которых он уничтожается.
dirty : boolean
Загрязнена ли полоса или нет
events : Phaser.Events
Все игровые объекты Phaser имеют класс Events, который содержит все события, отправляемые, когда происходят определённые вещи с этим
игровым объектом или любым из его компонентов.
exists : boolean
Управляет обработкой этого игрового объекта основным игровым циклом.
Если у этого игрового объекта есть физическое тело, он также управляет обновлением его физического тела или нет.
Когда exists установлено в false, оно удалит его физическое тело из физического мира, если оно есть.
Он также переключает свойство visible в false.
Установка exists в true вернёт его физическое тело в физический мир, если оно есть.
Он также установит свойство visible в true.
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 284)
- Унаследовано от
- Исходный код: gameobjects/components/FixedToCamera.js (Строка 56)
- Унаследовано от
- Исходный код: gameobjects/components/LoadTexture.js (Строка 254)
- Унаследовано от
- Исходный код: gameobjects/components/LoadTexture.js (Строка 279)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 248)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 142)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 600)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 26)
- Унаследовано от
- Исходный код: gameobjects/components/AutoCull.js (Строка 37)
- Унаследовано от
- Исходный код: gameobjects/components/InWorld.js (Строка 129)
- string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 203)
fixedToCamera : boolean
Объект игры, «привязанный» к камере, использует свои координаты x/y в качестве смещений от левого верхнего угла камеры во время отрисовки.
Значения корректируются на стадии отрисовки, переопределяя фактическое мировое положение объекта игры.
В результате объект игры будет казаться «привязанным» к камере, независимо от того, где в игровом мире
находится камера. Это полезно, например, если этот объект игры — элемент пользовательского интерфейса, который вы хотите видеть всегда
независимо от того, где в мире находится камера.
Смещения хранятся в свойстве cameraOffset.
Обратите внимание, что значения cameraOffset добавляются к любым родительским элементам этого объекта игры в списке отображения.
Будьте осторожны, не устанавливайте fixedToCamera для объектов игры, которые находятся в группах, в которых уже включен fixedToCamera.
frame : integer
Получает или задаёт индекс текущего кадра текстуры, используемой для отрисовки этого объекта игры.
Чтобы изменить кадр, установите frame в индекс нового кадра в спрайт-листе, который вы хотите использовать для этого объекта игры,
например: player.frame = 4.
Если заданный индекс кадра не существует, он вернётся к первому кадру, найденному в текстуре.
Если вы используете атлас текстур, то вместо этого следует использовать свойство frameName.
Если вы хотите полностью заменить используемую текстуру, см. loadTexture.
frameName : string
Получает или задаёт имя текущего кадра текстуры, используемой для отрисовки этого объекта игры.
Чтобы изменить кадр, установите frameName в имя нового кадра в атласе текстур, который вы хотите использовать для этого объекта игры,
например: player.frameName = "idle".
Если указанного имени кадра не существует, он вернётся к первому кадру, найденному в текстуре, и выведет предупреждение в консоль.
Если вы используете спрайт-лист, то вместо этого следует использовать свойство frame.
Если вы хотите полностью заменить используемую текстуру, см. loadTexture.
[только для чтения] fresh : boolean
Объект игры считается fresh , если он только что был создан или сброшен и ещё не получил обновление преобразования рендера.
Это свойство в основном используется внутренними системами физики, но доступно для использования плагинами.
game : Phaser.Game
Ссылка на текущую запущенную игру.
height : number
Высота displayObjectContainer, установка этого значения фактически изменяет масштаб для достижения заданного значения.
ignoreChildInput : boolean
Если ignoreChildInput равно false, это позволит считать дочерние элементы этого объекта допустимыми для событий Input.
Если это свойство равно true, дочерние элементы не будут считаться допустимыми для событий Input.
Обратите внимание, что это свойство не рекурсивно: затрагиваются только непосредственные дочерние элементы, дальнейшее сканирование не выполняется.
[только для чтения] inCamera : boolean
Проверяет, пересекаются ли границы объекта игры с границами игровой камеры.
Возвращает true, если они пересекаются, иначе false, если полностью находятся вне границ камеры.
[только для чтения] inWorld : boolean
Проверяет, находятся ли границы объекта игры внутри или пересекаются ли они в любой точке с границами игрового мира.
key : string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture
Ключ изображения или текстуры, используемого этим объектом игры во время отрисовки.
Если это строка, это строка, используемая для извлечения текстуры из кэша изображений Phaser.
Это также может быть экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
Если объект игры создан без ключа, ему автоматически назначается ключ __default, который представляет собой 32x32 прозрачный PNG, хранящийся в кэше.
Если объекту игры присваивается ключ, которого нет в кэше изображений, ему повторно присваивается ключ __missing, который представляет собой 32x32 PNG зелёного прямоугольника с линией.
Тип
left : number
Координата слева объекта игры.
Это то же самое, что и x - offsetX.
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 102)
- Унаследовано от
- Исходный код: gameobjects/components/LifeSpan.js (Строка 65)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 150)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 24)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 42)
- Унаследовано от
- Исходный код: gameobjects/components/InWorld.js (Строка 106)
- Унаследовано от
- Исходный код: gameobjects/components/InWorld.js (Строка 115)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 259)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 225)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 232)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 240)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 124)
- Унаследовано от
- Исходный код: gameobjects/components/ScaleMinMax.js (Строка 46)
- Унаследовано от
- Исходный код: gameobjects/components/ScaleMinMax.js (Строка 36)
lifespan : number
Срок жизни позволяет задать объекту игры срок жизни в миллисекундах.
После того, как объект игры «родился», вы можете установить для него положительное значение.
Он автоматически уменьшается на миллисекунды, эквивалентные game.time.physicsElapsed, каждый кадр.
Когда он достигнет нуля, он вызовет метод kill.
Очень удобно для частиц, пуль, коллекционных предметов или любого другого короткоживущего существа.
name : string
Пользовательское имя, заданное этому объекту игры.
Это значение никогда не используется внутри Phaser, оно предназначено как свойство уровня игры.
[только для чтения] offsetX : number
Значение смещения объекта игры по оси x относительно его координаты x.
Это то же самое, что и width * anchor.x.
Будет больше 0 только если anchor.x не равно нулю.
[только для чтения] offsetY : number
Значение смещения объекта игры по оси y относительно его координаты y.
Это то же самое, что и height * anchor.y.
Будет больше 0 только если anchor.y не равно нулю.
outOfBoundsKill : boolean
Если это и свойство checkWorldBounds оба установлены в true, то метод kill вызывается, как только inWorld возвращает false.
outOfCameraBoundsKill : boolean
Если это и свойство autoCull оба установлены в true, то метод kill вызывается, как только объект игры покидает границы камеры.
pendingDestroy : boolean
Объект игры помечен для вызова метода destroy на следующем логическом обновлении.
Вы можете установить его напрямую, чтобы пометить объект для уничтожения на следующем обновлении.
Это очень полезно, если вы хотите уничтожить объект из одного из своих собственных обратных вызовов, таких как с кнопок или других событий ввода.
[только для чтения] previousPosition : Phaser.Point
Положение объекта игры в предыдущем кадре.
[только для чтения] previousRotation : number
Угол поворота объекта игры в предыдущем кадре. Значение в радианах.
[только для чтения] renderOrderID : number
ID порядка отрисовки используется внутри рендерером и менеджером ввода и не должен изменяться.
Это свойство в основном используется внутри рендерерами, но доступно для использования плагинами.
right : number
Координата справа от объекта игры.
Это то же самое, что и x + width - offsetX.
scaleMax : Phaser.Point
Максимальное масштабирование, до которого будет масштабироваться данный объект игры.
Позволяет предотвратить масштабирование родительского элемента этого объекта игры больше, чем заданное значение.
Установите значение в null, чтобы снять ограничение.
scaleMin : Phaser.Point
Минимальный масштаб, до которого будет масштабироваться данный объект игры.
Позволяет предотвратить масштабирование родительского элемента этого объекта игры меньше, чем заданное значение.
Установите значение в null, чтобы снять ограничение.
- Исходный код: gameobjects/Rope.js (Строка 175)
- Унаследовано от
- Исходный код: gameobjects/components/Smoothed.js (Строка 25)
- Унаследовано от
- Исходный код: pixi/extras/Strip.js (Строка 20)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 146)
- Унаследовано от
- Исходный код: gameobjects/components/ScaleMinMax.js (Строка 20)
- Унаследовано от
- Исходный код: gameobjects/components/ScaleMinMax.js (Строка 26)
- Исходный код: gameobjects/Rope.js (Строка 57)
- Исходный код: gameobjects/Rope.js (Строка 144)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 571)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 211)
- Унаследовано от
- Исходный код: gameobjects/components/PhysicsBody.js (Строка 98)
- Унаследовано от
- Исходный код: gameobjects/components/PhysicsBody.js (Строка 124)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 177)
сегменты
Сегменты, составляющие тело верёвки, как массив Phaser.Rectangles
Свойства:
| Имя | Тип | Описание |
|---|---|---|
updateAnimation | Array.<Phaser.Rectangles> | Возвращает массив Phaser.Rectangles, представляющих сегменты заданной верёвки |
сглаженные : boolean
Включить или отключить сглаживание текстуры для этого объекта игры.
Это работает только в том случае, если объект игры использует текстуру на основе изображения.
Сглаживание включено по умолчанию.
текстура : PIXI.Texture
Текстура полосы
верх : number
Координата y объекта игры.
Это то же самое, что и y - offsetY.
обратный вызов преобразования
Обратный вызов, который будет применять любое ограничение масштаба к worldTransform.
контекст обратного вызова преобразования
Контекст, в котором вызывается transformCallback.
[только для чтения] тип : number
Постоянный тип этого объекта.
обновить анимацию
Верёвка вызовет функцию updateAnimation в каждом цикле обновления, если она есть. Установите функцию, если вы хотите, чтобы верёвка анимировалась во время фазы обновления. Установите значение false или null, чтобы удалить её.
ширина
Ширина контейнера displayObjectContainer, установка этого значения фактически изменит масштаб для достижения заданного значения.
мир
Мировые координаты этого объекта игры в пикселях.
В зависимости от того, где в списке отображения находится этот объект игры, это значение может отличаться от position,
который содержит координаты x/y, относительные к родительскому объекту игры.
x
Положение объекта игры на оси x относительно локальных координат родителя.
y
Положение объекта игры на оси y относительно локальных координат родителя.
[только для чтения] z : number
Глубина z этого объекта игры в пределах его родительской группы.
Два объекта в группе не могут иметь одинаковое значение z.
Это значение автоматически корректируется при изменении иерархии группы.
Если вы хотите изменить порядок расположения объекта игры, см. методы, такие как Group.moveUp или Group.bringToTop.
Методы
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 42)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 55)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 223)
addChild(child) → {DisplayObject}
Добавляет дочерний элемент в контейнер.
Parameters
| Name | Type | Описание |
|---|---|---|
child | DisplayObject | DisplayObject, который нужно добавить в контейнер |
Returns
Добавленный дочерний элемент.
addChildAt(child, index) → {DisplayObject}
Добавляет дочерний элемент в контейнер на указанный индекс. Если индекс вне границ, будет выброшено исключение.
Parameters
| Name | Type | Описание |
|---|---|---|
child | DisplayObject | Дочерний элемент для добавления |
index | Number | Индекс, на котором нужно разместить дочерний элемент |
Returns
Добавленный дочерний элемент.
alignIn(container, position, offsetX, offsetY) → {Object}
Выравнивает данный объект игры внутри другого объекта игры или прямоугольника, известного как
'контейнер', по одному из 9 возможных позиций.
Контейнер должен быть объектом игры или объектом Phaser.Rectangle. Это может включать свойства
такие как World.bounds или Camera.view, для выравнивания объектов игры в пределах
мировых и камерных границ. Или это может включать другие Sprites, Images, Text objects, BitmapText,
TileSprites или Buttons.
Обратите внимание, что выравнивание Sprites к другому объекту игры не делает его дочерним
элементом контейнера. Это просто изменяет его координаты положения, чтобы он выровнялся с ним.
Постоянные значения положения, которые вы можете использовать:
Phaser.TOP_LEFT, Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER,Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT,Phaser.BOTTOM_CENTER и Phaser.BOTTOM_RIGHT.
Объекты игры размещаются таким образом, что их границы выравниваются с
контейнером, учитывая вращение, масштаб и свойство якоря.
Это позволяет аккуратно выровнять объекты игры независимо от их значения положения.
Дополнительные аргументы offsetX и offsetY позволяют вам применить дополнительный отступ к окончательному
выровненному положению объекта игры. Например:
sprite.alignIn(background, Phaser.BOTTOM_RIGHT, -20, -20)
Выровнял бы sprite в нижний правый угол, но сместился на 20 пикселей от угла.
Подумайте об отступах как о применении корректировки к границам контейнеров перед выравниванием.
Итак, отрицательный отступ 'уменьшит' границы контейнера на эту величину, а положительный
увеличит их.
Parameters
| Name | Type | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
container | Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite | Объект игры или прямоугольник, к которому следует выровнять данный объект игры. Может также включать свойства, такие как | ||
position | integer | <optional> | Постоянная позиция. Одно из значений | |
offsetX | integer | <optional> | 0 | Горизонтальная настройка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное для увеличения. |
offsetY | integer | <optional> | 0 | Вертикальная настройка границ контейнера, применяемая к выровненному положению объекта игры. Используйте отрицательное значение для уменьшения границ, положительное для увеличения. |
Returns
Данный объект игры.
alignTo(parent, position, offsetX, offsetY) → {Object}
Выравнивает данный объект игры по стороне другого объекта игры или прямоугольника, известного как
'родитель', в одной из 11 возможных позиций.
Родитель должен быть объектом игры или объектом Phaser.Rectangle. Это может включать свойства
такие как World.bounds или Camera.view, для выравнивания объектов игры в пределах
мировых и камерных границ. Или это может включать другие Sprites, Images, Text objects, BitmapText,
TileSprites или Buttons.
Обратите внимание, что выравнивание Sprite к другому объекту игры не делает его дочерним
элементом родителя. Это просто изменяет его координаты положения, чтобы он выровнялся с ним.
Постоянные значения позиции, которые вы можете использовать:
Phaser.TOP_LEFT (по умолчанию), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_TOP,Phaser.LEFT_CENTER, Phaser.LEFT_BOTTOM, Phaser.RIGHT_TOP, Phaser.RIGHT_CENTER,Phaser.RIGHT_BOTTOM, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER
и Phaser.BOTTOM_RIGHT.
Дополнительные аргументы offsetX и offsetY позволяют вам применить дополнительный отступ к окончательному
выровненному положению объекта игры. Например:
sprite.alignTo(background, Phaser.BOTTOM_RIGHT, -20, -20)
Выровнял бы sprite в нижний правый угол, но сместился на 20 пикселей от угла.
Подумайте об отступах как о применении корректировки к границам родителей перед выравниванием.
Итак, отрицательный отступ 'уменьшит' границы родителя на эту величину, а положительный
увеличит их.
Parameters
- Унаследованно от
- Исходный код: gameobjects/components/Bounds.js (Строка 321)
- Унаследованно от
- Исходный код: gameobjects/components/BringToTop.js (Строка 24)
- Унаследованно от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 449)
- Унаследованно от
- Исходный код: gameobjects/components/Crop.js (Строка 49)
- Унаследованно от
- Исходный код: gameobjects/components/Destroy.js (Строка 37)
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
parent | Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite | Объект игры или прямоугольник, к которому нужно выровнять этот объект игры. Также может включать свойства, такие как | ||
position | целое число | <необязательно> | Постоянная позиция. Одно из значений | |
offsetX | целое число | <необязательно> | 0 | Горизонтальная корректировка границ контейнера, применяемая к выровненной позиции объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения. |
offsetY | целое число | <необязательно> | 0 | Вертикальная корректировка границ контейнера, применяемая к выровненной позиции объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения. |
Возвращает
Этот объект игры.
bringToTop() → {PIXI.DisplayObject}
Перемещает этот объект игры в самый верхний слой списка отображения его родителя.
Визуально это означает, что он будет отображаться поверх любого старого дочернего элемента в той же группе.
Если этот объект игры не был добавлен в пользовательскую группу, то этот метод поместит его в самый верхний слой игрового мира,
потому что мир является корневой группой, из которой происходят все объекты игры.
Возвращает
Этот экземпляр.
contains(child) → {Boolean}
Определяет, является ли указанный объект отображения потомком экземпляра DisplayObjectContainer или самим экземпляром.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | - |
Возвращает
crop(rect, copy)
Обрезка позволяет обрезать текстуру, используемую для отображения этого объекта игры.
Установка прямоугольника обрезки изменяет фрейм основной текстуры. Свойства ширины и высоты объекта игры будут соответственно скорректированы.
Обрезка происходит сверху слева и может быть изменена в реальном времени, либо путем предоставления обновленного объекта прямоугольника в этом методе,
либо путем прямого изменения свойства cropRect и последующего вызова updateCrop.
Объект прямоугольника, переданный в этот метод, может быть Phaser.Rectangle или любым другим объектом,
пока у него есть открытые свойства x, y, width, height, right и bottom.
Ссылка на прямоугольник хранится в cropRect за исключением случая, когда параметр copy равен true,
в этом случае значения дублируются в локальный объект.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
rect | Phaser.Rectangle | Прямоугольник, используемый при обрезке. Передайте null или не передавайте параметров, чтобы очистить ранее установленный прямоугольник обрезки. | ||
copy | boolean | <необязательно> | false | Если false, |
destroy(destroyChildren, destroyTexture)
Уничтожает объект игры. Это удаляет его из родительской группы, уничтожает обработчики ввода, событий и анимации, если они присутствуют,
и обнуляет ссылку на game, освобождая его для сбора мусора.
Если у этого объекта игры есть компонент событий, он также отправит событие onDestroy.
Вы можете также необязательно уничтожить BaseTexture, которую использует этот объект игры. Будьте осторожны, если у вас
более одного объекта игры, использующего ту же BaseTexture.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
destroyChildren | boolean | <необязательно> | true | Должен ли каждый дочерний элемент этого объекта также вызвать свой метод уничтожения? |
destroyTexture | boolean | <необязательно> | false | Уничтожить BaseTexture, используемую этим объектом игры? Обратите внимание, что если другой объект игры использует ту же BaseTexture, она будет аннулирована. |
getBounds(matrix) → {Rectangle}
Возвращает границы сетки в виде прямоугольника. Вычисление границ учитывает worldTransform.
Параметры
| Имя | Тип | Описание |
|---|---|---|
matrix | Matrix | матрица преобразования спрайта |
Возвращает
прямоугольник очерчивания
- Унаследовано от
- Исходный код: pixi/extras/Strip.js (Строка 405)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 153)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 112)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 437)
- Унаследовано от
- Исходный код: gameobjects/components/LifeSpan.js (Строка 113)
- Унаследовано от
- Исходный код: gameobjects/components/LoadTexture.js (Строка 51)
- Унаследовано от
- Исходный код: gameobjects/components/BringToTop.js (Строка 87)
getChildAt(index) → {DisplayObject}
Возвращает дочерний элемент по указанному индексу
Параметры
| Имя | Тип | Описание |
|---|---|---|
index | Число | Индекс, по которому нужно получить дочерний элемент |
Возвращаемое значение
Дочерний элемент по заданному индексу, если таковой имеется.
getChildIndex(child) → {Число}
Возвращает индекс позиции дочернего объекта DisplayObject
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | Объект DisplayObject для идентификации |
Возвращаемое значение
Индекс позиции дочернего объекта отображения для идентификации
getLocalBounds() → {Прямоугольник}
Возвращает локальные границы объекта displayObjectContainer без глобальных преобразований в виде прямоугольника. Вычисление учитывает все видимые дочерние элементы.
Возвращаемое значение
Прямоугольная область
kill() → {PIXI.DisplayObject}
Уничтожает объект Game. У объекта Game, помеченного как убитый, свойства alive, exists и visible установлены в false.
Он будет отправлять событие onKilled. Вы можете прослушивать событие events.onKilled.
Обратите внимание, что убийство объекта Game — это способ быстрого его повторного использования в пуле объектов, оно не уничтожает объект и не освобождает его из памяти.
Если вам больше не нужен объект Game, необходимо вызвать метод destroy.
Возвращаемое значение
Этот экземпляр.
loadTexture(key, frame, stopAnimation)
Изменяет базовую текстуру, используемую объектом Game. Старая текстура удаляется, и новая текстура ссылается или извлекается из кэша.
Если ваш объект Game использует фрейм из атласа текстур и вы просто хотите изменить фрейм, см. свойства frame или frameName.
Вы должны использовать loadTexture только в том случае, если хотите полностью заменить базовую текстуру.
Вызов этого метода вызывает обновление текстуры WebGL, поэтому используйте его экономно или в малоинтенсивных частях игры, или если вы знаете, что новая текстура уже находится на GPU.
Вы можете использовать новую константу Phaser.PENDING_ATLAS в качестве ключа текстуры для любого спрайта.
Это установит ключ в аргумент frame (фрейм устанавливается в ноль).
Это позволяет создавать спрайты, используя load.image во время разработки, а затем изменять их
на использование атласа текстур позже в процессе разработки, просто найдя в коде 'PENDING_ATLAS'
и заменив его ключом данных атласа.
Примечание: Вы не можете использовать RenderTexture в качестве текстуры для TileSprite.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
key | строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture | Это изображение или текстура, используемая спрайтом во время отрисовки. Это может быть строка, являющаяся ссылкой на запись в кэше изображения, или экземпляр RenderTexture, BitmapData, Video или PIXI.Texture. | ||
frame | строка | число | <необязательно> | Если этот спрайт использует часть спрайт-листа или атласа текстур, вы можете указать точный фрейм, используя строку или числовой индекс. | |
stopAnimation | логическое | <необязательно> | true | Если на этом спрайте уже воспроизводится анимация, вы можете выбрать остановить ее или позволить ей продолжить воспроизведение. |
moveDown() → {PIXI.DisplayObject}
Перемещает этот объект Game вниз на одну позицию в списке отображения родителя.
Этот вызов не имеет эффекта, если объект Game уже находится внизу списка отображения.
Если этот объект Game не добавлен в пользовательскую группу, этот метод переместит его на один объект вниз в игровом мире,
потому что Мир является корневой группой, от которой происходят все объекты Game.
Возвращаемое значение
Этот экземпляр.
moveUp() → {PIXI.DisplayObject}
Перемещает этот объект Game вверх на одну позицию в списке отображения родителя.
Этот вызов не имеет эффекта, если объект Game уже находится вверху списка отображения.
Если этот объект Game не добавлен в пользовательскую группу, этот метод переместит его на один объект вверх в игровом мире,
потому что Мир является корневой группой, от которой происходят все объекты Game.
Возвращаемое значение
Этот экземпляр.
- Унаследовано от
- Исходный код: gameobjects/components/BringToTop.js (Строка 66)
- Унаследовано от
- Исходный код: gameobjects/components/Overlap.js (Строка 29)
- Унаследовано от
- Исходный код: gameobjects/components/Animation.js (Строка 31)
- Унаследовано от
- Внутренний:
- Этот член является внутренним (защищенным) и может быть изменен или удален в будущем.
- Исходный код: gameobjects/components/Core.js (Строка 338)
- Исходный код: gameobjects/Rope.js (Строка 93)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 171)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 191)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 213)
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 | Объект отображения для проверки. |
Возвращаемое значение
True, если границы этого объекта Game Object пересекаются в любой точке с границами заданного объекта отображения.
play(name, frameRate, loop, killOnComplete) → {Phaser.Animation}
Проигрывает анимацию.
Анимация должна быть предварительно создана с помощью animations.add.
Если анимация уже воспроизводится, повторный вызов этой функции ничего не сделает.
Если вам нужно перезапустить уже выполняемую анимацию, сделайте это напрямую в самом объекте Animation или с помощью AnimationManager.stop.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
name | string | Имя анимации для воспроизведения, например, "fire", "walk", "jump". Должно быть предварительно создано с помощью 'AnimationManager.add'. | ||
frameRate | number | <опционально> | null | Частота кадров для воспроизведения анимации. Скорость задается в кадрах в секунду. Если не указано, используется предварительно установленная частота кадров анимации. |
loop | boolean | <опционально> | false | Должна ли анимация повторяться после воспроизведения. Если не указано, используется предварительно установленное значение цикла анимации. |
killOnComplete | boolean | <опционально> | false | Если установлено в true, при завершении анимации (происходит только если loop=false) родительский Sprite будет уничтожен. |
Возвращаемое значение
Ссылка на воспроизводимую анимацию.
<internal> postUpdate()
Внутренний метод, вызываемый циклом World postUpdate.
preUpdate()
Автоматически вызывается методом World.preUpdate.
removeChild(child) → {DisplayObject}
Удаляет дочерний элемент из контейнера.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | Удаляемый объект DisplayObject |
Возвращаемое значение
Удаленный дочерний элемент.
removeChildAt(index) → {DisplayObject}
Удаляет дочерний элемент из контейнера по указанному индексу.
Параметры
| Имя | Тип | Описание |
|---|---|---|
index | Number | Индекс для получения дочернего элемента |
Возвращаемое значение
Удаленный дочерний элемент.
removeChildren(beginIndex, endIndex)
Удаляет всех дочерних элементов из этого контейнера, находящихся между начальным и конечным индексами.
Параметры
| Имя | Тип | Описание |
|---|---|---|
beginIndex | Number | Начальная позиция. Значение по умолчанию - 0. |
endIndex | Number | Конечная позиция. Значение по умолчанию - размер контейнера. |
reset(x, y) → {Phaser.Rope}
- Исходный код: gameobjects/Rope.js (Строка 125)
- Унаследовано от
- Исходный код: gameobjects/components/LoadTexture.js (Строка 232)
- Унаследовано от
- Исходный код: gameobjects/components/LoadTexture.js (Строка 220)
- Унаследовано от
- Исходный код: gameobjects/components/LifeSpan.js (Строка 78)
- Унаследовано от
- Исходный код: gameobjects/components/BringToTop.js (Строка 45)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 132)
- Унаследовано от
- Исходный код: gameobjects/components/LoadTexture.js (Строка 155)
Сбрасывает Rope. Это помещает Rope в заданные мировые координаты x/y и затем
устанавливает alive, exists, visible и renderable во все значения true. Также сбрасывает состояние outOfBounds.
Если у Rope есть физический объект, он также сбрасывается.
Параметры
| Имя | Тип | Описание |
|---|---|---|
x | число | Координата x (в мировом пространстве) для позиционирования Sprite. |
y | число | Координата y (в мировом пространстве) для позиционирования Sprite. |
Возвращаемое значение
Этот экземпляр.
resetFrame()
Сбрасывает размеры фрейма текстуры, которые использует Game Object для отрисовки.
resizeFrame(parent, width, height)
Изменяет размеры фрейма, используемого объектом игры для отрисовки.
Обычно вам не нужно вызывать эту функцию, но в случае с такими типами текстур, как Video или BitmapData,
это может быть полезно для прямого изменения размеров.
Параметры
| Имя | Тип | Описание |
|---|---|---|
parent | объект | Родительский объект текстуры, вызвавший изменение размера, например, объект Phaser.Video. |
width | целое число | Новая ширина текстуры. |
height | целое число | Новая высота текстуры. |
revive(health) → {PIXI.DisplayObject}
Возвращает 'мертвый' Game Object к жизни, при необходимости сбрасывая его значение здоровья.
Воскресший Game Object имеет alive, exists и visible свойства, установленные в true.
Он отправит событие onRevived. Подпишитесь на events.onRevived для получения сигнала.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
health | число | <необязательно> | 100 | Здоровье, которое необходимо дать Game Object. Устанавливается только если у GameObject есть компонент Health. |
Возвращаемое значение
Этот экземпляр.
sendToBack() → {PIXI.DisplayObject}
Перемещает этот Game Object в конец списка отображения его родителя.
Визуально это означает, что он будет отображаться под всеми другими дочерними элементами в той же группе.
Если этот Game Object не был добавлен в пользовательскую группу, то этот метод поместит его в конец игрового мира,
поскольку World — это корневая группа, от которой происходят все Game Object.
Возвращаемое значение
Этот экземпляр.
setChildIndex(child, index)
Изменяет позицию существующего дочернего элемента в контейнере отображения.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | Экземпляр дочернего объекта DisplayObject, для которого вы хотите изменить номер индекса. |
index | Число | Полученный номер индекса для дочернего объекта отображения. |
setFrame(frame)
Устанавливает фрейм текстуры, который Game Object использует для отрисовки.
В основном это внутренний метод, используемый loadTexture, но он доступен для использования плагинами и пользовательскими классами.
Параметры
| Имя | Тип | Описание |
|---|---|---|
frame | Phaser.Frame | Фрейм, который будет использоваться текстурой. |
setScaleMinMax(minX, minY, maxX, maxY)
Устанавливает значения scaleMin и scaleMax. Эти значения используются для ограничения того, насколько этот Game Object будет масштабироваться относительно своего родителя.
Например, если у этого Game Object значение minScale равно 1, а у его родителя значение scale равно 0,5, то значение 0,5 будет проигнорировано
и будет использоваться значение масштаба 1, так как масштаб родителя меньше минимального масштаба, которого должен придерживаться этот Game Object.
Устанавливая эти значения, вы можете тщательно контролировать, как Game Object справляются с адаптивным масштабированием.
Если задан только один параметр, то это значение будет использоваться для scaleMin и scaleMax:setScaleMinMax(1) = scaleMin.x, scaleMin.y, scaleMax.x и scaleMax.y все = 1
Если заданы только два параметра, то первый устанавливается как scaleMin.x и y, а второй как scaleMax.x и y:setScaleMinMax(0.5, 2) = scaleMin.x и y = 0,5 и scaleMax.x и y = 2
Если вы хотите установить scaleMin с разными значениями для x и y, то либо измените Game Object.scaleMin напрямую,
либо передайте null для параметров maxX и maxY.
Вызовите setScaleMinMax(null) для очистки всех ранее установленных значений.
Параметры
- Унаследовано от
- Исходный код: gameobjects/components/ScaleMinMax.js (Строка 110)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 85)
- Исходный код: gameobjects/Rope.js (Строка 110)
- Унаследовано от
- Исходный код: gameobjects/components/Crop.js (Строка 86)
| Имя | Тип | Описание |
|---|---|---|
minX | число | null | Минимальное значение горизонтального масштаба, до которого этот объект игры может уменьшаться. |
minY | число | null | Минимальное значение вертикального масштаба, до которого этот объект игры может уменьшаться. |
maxX | число | null | Максимальное значение горизонтального масштаба, до которого этот объект игры может увеличиваться. |
maxY | число | null | Максимальное значение вертикального масштаба, до которого этот объект игры может увеличиваться. |
swapChildren(child, child2)
Меняет местами положение 2 графических объектов в этом контейнере.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | - |
child2 | DisplayObject | - |
update()
Переопределите и используйте эту функцию в собственных пользовательских объектах для обработки любых необходимых обновлений.
updateCrop()
Если вы установили прямоугольник обрезки для этого объекта игры с помощью crop и с тех пор изменили свойство cropRect,
или прямоугольник, на который оно ссылается, тогда вам необходимо обновить кадр обрезки, вызвав этот метод.
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.Rope.html