Класс: Phaser.TileSprite
Конструктор
new TileSprite(game, x, y, width, height, key, frame)
TileSprite — это Sprite с повторяющейся текстурой. Текстуру можно прокручивать и масштабировать независимо от самого TileSprite.
Текстуры автоматически будут повторяться и разработаны так, чтобы вы могли создавать фоны игр с использованием бесшовных текстур в качестве источника.
TileSprite по умолчанию не имеет обработчика ввода или физических тел, оба необходимо включить так же, как и для обычных Sprites.
Вы не должны создавать TileSprite размером больше, чем размер вашего экрана. Если вы хотите создать большой повторяющийся фон,
который прокручивается по всей карте вашей игры, тогда вы создаете TileSprite, который соответствует размеру экрана, и затем используете tilePosition
свойство для прокрутки текстуры по мере перемещения игрока. Если вы создаете TileSprite размером в тысячи пикселей, он
будет потреблять огромное количество памяти и вызовет проблемы с производительностью. Помните: используйте tilePosition для прокрутки текстуры и tileScale для
настройки масштаба текстуры — не изменяйте размер самого спрайта и не делайте его больше, чем нужно.
Важное примечание о размерах текстуры:
При работе с Canvas TileSprite может использовать любой размер текстуры без проблем. При работе с WebGL текстура должна, в идеале,
быть степенью двойки в размерах (например, 4, 8, 16, 32, 64, 128, 256, 512 и т. д. пикселей в ширину и высоту). Если текстура не является степенью двойки,
она будет рендериться на пустой холст соответствующего размера, что означает, что у вас могут появляться «пустые» области справа и
снизу вашей рамки. Чтобы этого избежать, убедитесь, что ваши текстуры являются точными степенями двойки.
TileSprite поддерживают анимации так же, как и Sprites. Вы добавляете и воспроизводите анимации с помощью AnimationManager. Однако,
если ваша игра работает под WebGL, обратите внимание, что каждый кадр анимации должен быть степенью двойки в размерах, в противном случае он получит
дополнительное заполнение, чтобы обеспечить это.
Параметры
| Имя | Тип | Описание |
|---|---|---|
game | Phaser.Game | Ссылка на текущую запущенную игру. |
x | number | Координата x (в мировом пространстве) для позиционирования TileSprite. |
y | number | Координата y (в мировом пространстве) для позиционирования TileSprite. |
width | number | Ширина TileSprite. |
height | number | Высота TileSprite. |
key | string | Phaser.BitmapData | PIXI.Texture | Это изображение или текстура, используемая TileSprite во время рендеринга. Может быть строкой, которая является ссылкой на запись Phaser Image Cache, или экземпляром PIXI.Texture или BitmapData. |
frame | string | number | Если TileSprite использует часть спрайт-шита или текстурного атласа, вы можете указать точный кадр, используя строку или числовой индекс. |
- Исходный код: gameobjects/TileSprite.js (Строка 59)
Расширяет
- PIXI.TilingSprite
- Phaser.Component.Core
- Phaser.Component.Angle
- Phaser.Component.Animation
- Phaser.Component.AutoCull
- Phaser.Component.Bounds
- Phaser.Component.BringToTop
- Phaser.Component.Destroy
- Phaser.Component.FixedToCamera
- Phaser.Component.Health
- Phaser.Component.InCamera
- Phaser.Component.InputEnabled
- Phaser.Component.InWorld
- Phaser.Component.LifeSpan
- Phaser.Component.LoadTexture
- Phaser.Component.Overlap
- Phaser.Component.PhysicsBody
- Phaser.Component.Reset
- Phaser.Component.Smoothed
Общественные свойства
- Inherited From
- Значение по умолчанию
- true
- Исходный код: gameobjects/components/LifeSpan.js (Строка 50)
- Inherited From
- Исходный код: pixi/display/Sprite.js (Строка 17)
- Inherited From
- Исходный код: gameobjects/components/Angle.js (Строка 29)
- Inherited From
- Исходный код: gameobjects/components/Core.js (Строка 193)
- См.
- Inherited From
- Исходный код: gameobjects/components/AutoCull.js (Строка 28)
- Inherited From
- Значение по умолчанию
- PIXI.blendModes.NORMAL;
- Исходный код: pixi/extras/TilingSprite.js (Строка 86)
- Inherited From
- Исходный код: gameobjects/components/PhysicsBody.js (Строка 91)
- Inherited From
- Исходный код: gameobjects/components/Bounds.js (Строка 168)
- Inherited From
- Исходный код: gameobjects/components/FixedToCamera.js (Строка 86)
- Inherited From
- Исходный код: pixi/extras/TilingSprite.js (Строка 95)
- Inherited From
- Исходный код: gameobjects/components/Bounds.js (Строка 58)
alive : boolean
Полезный флаг для управления тем, жив объект Game Object или нет.
Он автоматически устанавливается компонентами Health damage метода, если у объекта закончится здоровье.
Или вы можете переключать его через код игры.
Это свойство в основном предназначено для использования в вашей игре — оно не влияет на отрисовку или логические обновления.
Однако вы можете использовать Group.getFirstAlive в сочетании с этим свойством для быстрой пулирования и рециклинга объектов.
anchor :Point
Якорь устанавливает точку начала текстуры.
По умолчанию — 0,0, что означает начало текстуры в левом верхнем углу
Установка якоря в 0,5;0,5 означает, что начало текстуры находится по центру
Установка якоря в 1,1 означает, что начальная точка текстуры будет в правом нижнем углу
angle : number
Свойство угла — поворот объекта Game Object в градусах от его первоначального ориентации.
Значения от 0 до 180 представляют поворот по часовой стрелке; значения от 0 до -180 представляют поворот против часовой стрелки.
Значения за пределами этого диапазона добавляются или вычитаются из 360, чтобы получить значение в этом диапазоне.
Например, оператор player.angle = 450 эквивалентен player.angle = 90.
Если вы хотите работать в радианах вместо градусов, вы можете использовать свойство rotation вместо.
Работа в радианах немного быстрее, так как не нужно выполнять никаких вычислений.
animations : Phaser.AnimationManager
Если для объекта Game Object включены анимации (например, Phaser.Sprite), это ссылка на его экземпляр AnimationManager.
Через него можно создавать, воспроизводить, приостанавливать и останавливать анимации.
autoCull : boolean
Объект Game Object с autoCull значением true будет проверять свои границы относительно камеры мира каждый кадр.
Если он не пересекает границы камеры в какой-либо момент, его свойство renderable устанавливается в false.
Это сохраняет объект Game Object живым и продолжает обрабатывать обновления, но заставляет его полностью пропустить этап отрисовки.
Это относительно дорогостоящая операция, особенно если включена для сотен объектов Game Object. Поэтому включайте ее только если это необходимо,
или если вы протестировали производительность и она приемлема.
blendMode : number
Режим смешивания, применяемый к спрайту
body : Phaser.Physics.Arcade.Body | Phaser.Physics.P2.Body | Phaser.Physics.Ninja.Body | null
Физическое тело объекта Game Object. После включения физики для объекта Game Object вы получаете доступ ко всем связанным
свойствам и методам через него.
По умолчанию объекты Game Object не добавляются к какой-либо физической системе, и их свойство body будет null.
Чтобы включить физику для этого объекта Game Object, необходимо вызвать game.physics.enable(object, system), где object — этот объект,
а system — используемая физическая система. Если ни один не указан, используется Phaser.Physics.Arcade.
Вы также можете вызвать game.physics.arcade.enable(object), или добавить этот объект Game Object в группу с физикой.
Важно: Включение объекта Game Object для физики P2 или Ninja автоматически установит его свойство anchor в 0,5,
поэтому физическое тело будет центрировано на объекте Game Object.
Если вам нужен другой результат, отрегулируйте или пересоздайте смещения формы тела вручную или сбросьте якорь после включения физики.
Тип
bottom : number
Сумма свойств y и height.
Это то же самое, что и y + height - offsetY.
cameraOffset : Phaser.Point
Смещение координат x/y, применяемое к верхнему левому углу камеры, в котором будет нарисован этот объект Game Object, если fixedToCamera равно true.
Значения относительны к верхнему левому углу области просмотра камеры и дополняют любые родительские элементы объекта Game Object в списке отображения.
canvasBuffer :PIXICanvasBuffer
Объект CanvasBuffer, к которому отрисовывается текстура плиток.
centerX : number
Координата центра x объекта Game Object.
Это то же самое, что и (x - offsetX) + (width / 2).
centerY : number
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 80)
- Унаследовано от
- Исходный код: gameobjects/components/InWorld.js (Строка 98)
- Array.<DisplayObject>
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 17)
- Унаследовано от
- Внутреннее:
- Этот член является внутренним (защищённым) и может быть изменён или удалён в будущем.
- Исходный код: gameobjects/components/Core.js (Строка 167)
- Унаследовано от
- Исходный код: gameobjects/components/Health.js (Строка 46)
- Унаследовано от
- Значение по умолчанию
- {}
- Исходный код: gameobjects/components/Core.js (Строка 160)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 218)
- Унаследовано от
- Исходный код: gameobjects/components/Destroy.js (Строка 22)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 185)
- См.
- Унаследовано от
- Значение по умолчанию
- true
- Исходный код: pixi/display/Sprite.js (Строка 103)
- Унаследовано от
- Исходный код: gameobjects/components/FixedToCamera.js (Строка 56)
- Унаследовано от
- Исходный код: gameobjects/components/LoadTexture.js (Строка 254)
Координата центральной точки по оси y объекта игры.
Это то же самое, что и (y - offsetY) + (height / 2).
checkWorldBounds : boolean
Если это значение установлено в true, объект игры проверяет, находится ли он в границах мира каждый кадр.
Когда объект больше не пересекает границы мира, он отправляет событие onOutOfBounds.
Если он ранее находился за пределами границ, но теперь снова пересекает границы мира, он отправляет событие onEnterBounds.
Он также необязательно уничтожает объект игры, если outOfBoundsKill имеет значение true.
При включённом checkWorldBounds объекту игры принудительно вычисляются полные границы каждый кадр.
Это относительно дорогостоящая операция, особенно если она включена для сотен объектов игры. Поэтому включайте её только если это необходимо,
или если вы протестировали производительность и она вас устраивает.
[readonly] children : Array.<DisplayObject>
[только для чтения] Массив дочерних элементов этого контейнера.
Тип
<internal> components : Object
Компоненты, установленные у этого объекта игры.
damage
Наносит урон объекту игры. Это уменьшает заданное количество здоровья из свойства health.
Если здоровье падает ниже или равно нулю, вызывается метод kill.
data : Object
Пустой объект, принадлежащий этому объекту игры.
Это значение никогда не используется внутри Phaser, но может использоваться вашим кодом или
плагинами Phaser для хранения данных, которые необходимо связать с объектом игры,
не загрязняя напрямую сам объект игры.
debug : boolean
Флаг отладки, предназначенный для использования с Game.enableStep.
[readonly] destroyPhase : boolean
При выполнении метода уничтожения объекта игры этот флаг устанавливается в значение true
и может быть проверен в любых подсистемах или плагинах, из которых он уничтожается.
events : Phaser.Events
Все объекты игры Phaser имеют класс событий, который содержит все события, отправляемые, когда происходят определённые действия с этим
объектом игры или любым из его компонентов.
exists : boolean
Определяет, обрабатывается ли этот спрайт основными циклами игры Phaser и циклами групп.
fixedToCamera : boolean
Объект игры, "закреплённый" за камерой, использует свои координаты x/y как смещения от левого верхнего угла камеры при отрисовке.
Значения корректируются на стадии отрисовки, перезаписывая фактическое мировое положение объекта игры.
В итоге объект игры будет казаться закреплённым за камерой, независимо от того, где в мире игры камера просматривает.
Это полезно, например, если этот объект игры — элемент пользовательского интерфейса, который вы хотите видеть всегда,
независимо от того, где в мире находится камера.
Смещения хранятся в свойстве cameraOffset.
Обратите внимание, что значения cameraOffset добавляются к любому родителю этого объекта игры в списке отображения.
Будьте осторожны, не устанавливайте fixedToCamera для объектов игры, которые находятся в группах, где уже включено fixedToCamera.
frame : integer
Возвращает или устанавливает текущий индекс кадра используемой текстуры для отрисовки этого объекта игры.
Чтобы изменить кадр, установите frame в индекс нового кадра в таблице спрайтов, который вы хотите использовать для этого объекта игры,
например: player.frame = 4.
Если указанный индекс кадра не существует, он будет изменён на первый кадр, найденный в текстуре.
Если вы используете карту текстур, вместо этого используйте свойство frameName.
Если вы хотите полностью заменить используемую текстуру, см. loadTexture.
- Inherited From
- Source code: gameobjects/components/LoadTexture.js (Line 279)
- Inherited From
- Source code: gameobjects/components/Core.js (Line 248)
- Inherited From
- Source code: gameobjects/components/Core.js (Line 142)
- Inherited From
- Source code: gameobjects/components/Health.js (Line 90)
- Inherited From
- Default Value
- 1
- Source code: gameobjects/components/Health.js (Line 26)
- Inherited From
- Source code: pixi/extras/TilingSprite.js (Line 27)
- Inherited From
- Source code: pixi/display/DisplayObjectContainer.js (Line 26)
- Inherited From
- Source code: gameobjects/components/AutoCull.js (Line 37)
- Phaser.InputHandler | null
- Inherited From
- Source code: gameobjects/components/InputEnabled.js (Line 24)
- Inherited From
- Source code: gameobjects/components/InputEnabled.js (Line 42)
- Inherited From
- Source code: gameobjects/components/InWorld.js (Line 129)
- string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture
frameName : string
Получает или задаёт текущее имя кадра текстуры, используемой для отрисовки этого объекта игры.
Чтобы изменить кадр, установите frameName на имя нового кадра в атласе текстур, который должен использовать этот объект игры,
например: player.frameName = "idle".
Если указанного имени кадра не существует, будет использован первый кадр в текстуре, и в консоль будет выведено предупреждение.
Если вы используете спрайт-лист, то вместо этого следует использовать свойство frame.
Если вы хотите полностью заменить используемую текстуру, см. loadTexture.
[readonly] fresh : boolean
Объект игры считается fresh , если он только что был создан или сброшен и ещё не получил обновление преобразования рендерера.
Это свойство в основном используется внутренними системами физики, но доступно для использования плагинами.
game : Phaser.Game
Ссылка на текущую запущенную игру.
heal
Вылечить объект игры. Это добавляет указанное количество здоровья к свойству health.
health : number
Значение здоровья объекта игры. Это полезное свойство для установки и изменения здоровья объекта игры.
Его можно использовать в сочетании с методом damage или изменять непосредственно.
height : number
Высота плиссированного спрайта
ignoreChildInput : boolean
Если ignoreChildInput равно false, это позволит рассматривать потомков этого объекта как допустимые для событий Input.
Если это свойство равно true, потомки не будут рассматриваться как допустимые для событий Input.
Обратите внимание, что это свойство не рекурсивно: влияют только непосредственные потомки, дальнейший поиск не производится.
[readonly] inCamera : boolean
Проверяет, пересекаются ли границы объекта игры с границами камеры игры.
Возвращает true , если пересекаются, в противном случае false , если полностью вне границ камеры.
input : Phaser.InputHandler | null
Обработчик Input для этого объекта игры.
По умолчанию отключен. Если вы хотите, чтобы этот объект игры обрабатывал события ввода, включите его с помощью: inputEnabled = true.
После этого свойство будет ссылаться на обработчик Phaser Input.
Type
inputEnabled : boolean
По умолчанию объект игры не обрабатывает события ввода. Установив inputEnabled в значение true, создаётся обработчик Phaser.InputHandler
для этого объекта игры, и он начнёт обрабатывать события щелчка/нажатия и другие.
Затем вы можете получить доступ к обработчику Input с помощью this.input.
Обратите внимание, что события, связанные с Input, отправляются из this.events, т.е.: events.onInputDown.
Если вы установите это свойство в false, обработчик Input перестанет обрабатывать события ввода.
Если вы хотите временно отключить ввод для объекта игры, лучше установитьinput.enabled = false, так как это не сбросит внутренние свойства обработчиков Input.
Затем вы можете по мере необходимости включить его снова.
[readonly] inWorld : boolean
Проверяет, находятся ли границы объекта игры внутри или пересекаются ли они с границами игрового мира.
key : string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture
Ключ изображения или текстуры, используемый этим объектом игры во время отрисовки.
Если это строка, это строка, используемая для получения текстуры из кэша изображений Phaser.
Это также может быть экземпляр RenderTexture, BitmapData, Video или PIXI.Texture.
Если объект игры создан без ключа, ему автоматически назначается ключ __default, который представляет собой прозрачный PNG размером 32x32, хранящийся в кэше.
Если объекту игры присваивается ключ, которого нет в кэше изображений, ему повторно назначается ключ __missing, который представляет собой PNG размером 32x32 с зелёным прямоугольником и линией через него.
Type
- Унаследованно от
- Исходный код: gameobjects/components/Core.js (Строка 203)
- Унаследованно от
- Исходный код: gameobjects/components/Bounds.js (Строка 102)
- Унаследованно от
- Исходный код: gameobjects/components/LifeSpan.js (Строка 65)
- Унаследованно от
- Значение по умолчанию
- 100
- Исходный код: gameobjects/components/Health.js (Строка 35)
- Унаследованно от
- Исходный код: 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/TileSprite.js (Строка 78)
- Унаследованно от
- Исходный код: gameobjects/components/Core.js (Строка 225)
- Унаследованно от
- Исходный код: gameobjects/components/Core.js (Строка 232)
- Унаследованно от
- Значение по умолчанию
- true
- Исходный код: pixi/extras/TilingSprite.js (Строка 119)
left : число
Координата слева объекта Game Object.
Это то же самое, что и x - offsetX.
lifespan : число
Время жизни позволяет задать время жизни объекта Game Object в миллисекундах.
После создания объекта Game Object вы можете задать этому свойству положительное значение.
Это значение автоматически уменьшается на эквивалент миллисекунд game.time.physicsElapsed каждый кадр.
Когда оно достигает нуля, вызывается метод kill.
Очень удобно для частиц, пуль, коллекционных предметов или любых других объектов с коротким сроком жизни.
maxHealth : число
Максимальное значение здоровья объекта Game Object. Это работает в сочетании с методом heal, чтобы гарантировать,
что значение здоровья никогда не превышает максимума.
name : строка
Пользовательское имя, заданное этому объекту Game Object.
Это значение никогда не используется внутри Phaser, оно предназначено как свойство уровня игры.
[только для чтения] offsetX : число
Величина смещения объекта Game Object по оси x от его координаты x.
Это то же самое, что и width * anchor.x.
Будет больше 0 только если anchor.x не равен нулю.
[только для чтения] offsetY : число
Величина смещения объекта Game Object по оси y от его координаты y.
Это то же самое, что и height * anchor.y.
Будет больше 0 только если anchor.y не равен нулю.
outOfBoundsKill : логическое значение
Если это и свойство checkWorldBounds оба установлены в true, то метод kill вызывается, как только inWorld возвращает false.
outOfCameraBoundsKill : логическое значение
Если это и свойство autoCull оба установлены в true, то метод kill вызывается,
как только объект Game Object выходит за пределы области камеры.
pendingDestroy : логическое значение
Объект Game Object, для которого отмечено pendingDestroy, будет иметь вызываемый метод destroy на следующем логическом обновлении.
Вы можете установить его напрямую, чтобы отметить объект для уничтожения на следующем обновлении.
Это очень полезно, если вы хотите уничтожить объект внутри одного из его собственных обратных вызовов,
например, с кнопками или другими событиями ввода.
[только для чтения] physicsType : число
Тип физического тела объекта.
[только для чтения] previousPosition : Phaser.Point
Положение объекта Game Object в предыдущем кадре.
[только для чтения] previousRotation : число
Угол поворота объекта Game Object в предыдущем кадре. Значение в радианах.
refreshTexture : логическое значение
Если true, TilingSprite выполнит generateTexture в следующем проходе отрисовки.
Это устанавливается такими операциями, как Phaser.LoadTexture.setFrame.
renderable : логическое значение
Определяет, может ли этот спрайт быть отрисован
- Унаследовано от
- Значение по умолчанию
- true
- Исходный код: pixi/extras/TilingSprite.js (Строка 59)
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 240)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 124)
- Унаследовано от
- Исходный код: gameobjects/components/Health.js (Строка 70)
- Унаследовано от
- Значение по умолчанию
- null
- Исходный код: pixi/display/Sprite.js (Строка 93)
- Унаследовано от
- Исходный код: gameobjects/components/Smoothed.js (Строка 25)
- Унаследовано от
- Исходный код: pixi/display/Sprite.js (Строка 28)
- Унаследовано от
- Исходный код: pixi/extras/TilingSprite.js (Строка 77)
- Унаследовано от
- Исходный код: pixi/extras/TilingSprite.js (Строка 111)
- Унаследовано от
- Исходный код: pixi/extras/TilingSprite.js (Строка 51)
- Унаследовано от
- Исходный код: pixi/extras/TilingSprite.js (Строка 35)
- Унаследовано от
- Исходный код: pixi/extras/TilingSprite.js (Строка 43)
- Унаследовано от
- Исходный код: pixi/extras/TilingSprite.js (Строка 103)
- Унаследовано от
- Значение по умолчанию
- 0xFFFFFF
- Исходный код: pixi/extras/TilingSprite.js (Строка 68)
- Унаследовано от
- Значение по умолчанию
- null
- Исходный код: pixi/display/Sprite.js (Строка 73)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 146)
[только для чтения] renderOrderID : число
Идентификатор порядка отрисовки используется внутренне рендером и Input Manager и не должен изменяться.
Это свойство в основном используется внутренними рендерами, но доступно для использования плагинами.
right : число
Координата правой границы объекта игры.
Это то же самое, что и x + width - offsetX.
setHealth
Устанавливает свойство health объекта игры заданному значению.
Никогда не превысит значение maxHealth.
shader : PIXI.AbstractFilter
Фрагментный шейдер, который будет использоваться для отрисовки этого спрайта.
Установите в null, чтобы удалить текущий шейдер.
smoothed : логическое
Включить или отключить сглаживание текстуры для этого объекта игры.
Это влияет только если объект использует текстуру на основе изображения.
Сглаживание включено по умолчанию.
texture : PIXI.Texture
Текстура, используемая спрайтом.
textureDebug : логическое
Если включено, за генерированной текстурой черепицы будет нарисован зелёный прямоугольник, позволяя визуально
отладить используемую текстуру.
tilePattern :PIXITexture
Шаблон заливки контекста, который используется для рисования TilingSprite в режиме Canvas (в WebGL будет null).
tilePosition :Point
Смещённое положение изображения, которое повторяется.
tileScale :Point
Масштабирование изображения, которое повторяется.
tileScaleOffset :Point
Точка, представляющая масштаб объекта текстуры.
tilingTexture :PIXITexture
Внутренний объект Texture, содержащий текстуру черепицы, сгенерированную из TilingSprite.texture.
tint : число
Оттенок, применяемый к спрайту. Это шестнадцатеричное значение.
tintedTexture :Canvas
Канвас, содержащий затонированную версию спрайта (в режиме Canvas, в WebGL этот объект не заполняется).
top : число
Координата y объекта игры.
Это то же самое, что и y - offsetY.
- Исходный код: gameobjects/TileSprite.js (Строка 72)
- Унаследованно от
- Исходный код: pixi/extras/TilingSprite.js (Строка 19)
- Унаследованно от
- Исходный код: gameobjects/components/Core.js (Строка 211)
- Унаследованно от
- Исходный код: gameobjects/components/PhysicsBody.js (Строка 98)
- Унаследованно от
- Исходный код: gameobjects/components/PhysicsBody.js (Строка 124)
- Унаследованно от
- Исходный код: gameobjects/components/Core.js (Строка 177)
[readonly] type : number
Тип константы этого объекта.
width : number
Ширина плисового спрайта
world : Phaser.Point
Мировые координаты этого объекта Game в пикселях.
В зависимости от местоположения этого объекта в списке отображения это значение может отличаться от position,
которое содержит координаты x/y относительно родителя объекта Game.
x : number
Положение объекта Game по оси x относительно локальных координат родителя.
y : number
Положение объекта Game по оси y относительно локальных координат родителя.
[readonly] z : number
Глубина z этого объекта Game внутри родительской группы.
Два объекта в группе не могут иметь одинаковое значение z.
Это значение автоматически корректируется при изменении иерархии группы.
Если вы хотите переупорядочить слои объекта Game, см. методы, такие как Group.moveUp или Group.bringToTop.
Общедоступные методы
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 42)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 55)
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 223)
addChild(child) → {DisplayObject}
Добавляет дочерний элемент в контейнер.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | Элемент DisplayObject для добавления в контейнер |
Возвращает
Добавленный дочерний элемент.
addChildAt(child, index) → {DisplayObject}
Добавляет дочерний элемент в контейнер на указанный индекс. Если индекс находится вне границ, будет выброшено исключение.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | Дочерний элемент для добавления |
index | Number | Индекс, на котором необходимо разместить дочерний элемент |
Возвращает
Добавленный дочерний элемент.
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 или кнопки.
Обратите внимание, что выравнивание 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 размещаются таким образом, что их границы выравниваются с
контейнером, учитывая вращение, масштабирование и свойство якоря.
Это позволяет аккуратно выравнивать объекты Game Object независимо от их значения позиции.
Дополнительные аргументы offsetX и offsetY позволяют применить дополнительное отступы к окончательному
выровненному положению объекта Game Object. Например:
sprite.alignIn(background, Phaser.BOTTOM_RIGHT, -20, -20)
Выровняет sprite в нижний правый угол, но сместит его на 20 пикселей от угла.
Представьте, что смещения применяют корректировку к границам контейнера перед выравниванием.
Таким образом, отрицательное смещение уменьшит границы контейнера, а положительное - увеличит их.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
container | Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite | Объект Game или прямоугольник, к которому необходимо выровнять этот объект Game Object. Может включать такие свойства, как | ||
position | integer | <optional> | Постоянное значение позиции. Одно из значений | |
offsetX | integer | <optional> | 0 | Горизонтальная корректировка границ контейнера, применяемая к выровненному положению объекта Game Object. Использование отрицательного значения уменьшит границы, положительного - увеличит их. |
offsetY | integer | <optional> | 0 | Вертикальная корректировка границ контейнера, применяемая к выровненному положению объекта Game Object. Использование отрицательного значения уменьшит границы, положительного - увеличит их. |
Возвращает
Этот объект Game Object.
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 или кнопки.
Обратите внимание, что выравнивание 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 пикселей от угла.
Представьте, что смещения применяют корректировку к границам родителя перед выравниванием.
Таким образом, отрицательное смещение уменьшит границы родителя, а положительное - увеличит их.
Параметры
- Унаследовано от
- Исходный код: gameobjects/components/Bounds.js (Строка 321)
- Исходный код: gameobjects/TileSprite.js (Строка 149)
- Унаследовано от
- Исходный код: gameobjects/components/BringToTop.js (Строка 24)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 449)
- Исходный код: gameobjects/TileSprite.js (Строка 178)
- Унаследовано от
- Исходный код: pixi/extras/TilingSprite.js (Строка 332)
- Унаследовано от
- Исходный код: pixi/extras/TilingSprite.js (Строка 417)
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
parent | Phaser.Rectangle | Phaser.Sprite | Phaser.Image | Phaser.Text | Phaser.BitmapText | Phaser.Button | Phaser.Graphics | Phaser.TileSprite | Объект игры или прямоугольник, к которому следует выровнять этот объект игры. Может также содержать свойства, такие как | ||
position | целое число | <необязательно> | Постоянная для позиции. Одна из | |
offsetX | целое число | <необязательно> | 0 | Горизонтальная корректировка границ контейнера, применяемая к выровненной позиции объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения. |
offsetY | целое число | <необязательно> | 0 | Вертикальная корректировка границ контейнера, применяемая к выровненной позиции объекта игры. Используйте отрицательное значение для уменьшения границ, положительное — для увеличения. |
Возвращаемое значение
Этот объект игры.
autoScroll(x, y)
Устанавливает этот TileSprite для автоматической прокрутки в заданном направлении до остановки с помощью TileSprite.stopScroll().
Скорость прокрутки задается в пикселях в секунду.
Отрицательное значение x приведет к прокрутке влево. Положительное значение x — к прокрутке вправо.
Отрицательное значение y — к прокрутке вверх. Положительное значение y — к прокрутке вниз.
Параметры
| Имя | Тип | Описание |
|---|---|---|
x | число | Горизонтальная скорость прокрутки в пикселях в секунду. |
y | число | Вертикальная скорость прокрутки в пикселях в секунду. |
bringToTop() → {PIXI.DisplayObject}
Выводит этот объект игры наверх списка отображения его родителя.
Визуально это означает, что он будет отображаться поверх любого старого дочернего элемента в той же группе.
Если этот объект игры не был добавлен в пользовательскую группу, то этот метод выведет его наверх игрового мира,
потому что мир является корневой группой, от которой происходят все объекты игры.
Возвращаемое значение
Этот экземпляр.
contains(child) → {Boolean}
Определяет, является ли указанный объект отображения дочерним элементом экземпляра DisplayObjectContainer или самим экземпляром.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | - |
Возвращаемое значение
destroy(destroyChildren)
Уничтожает TileSprite. Это удаляет его из родительской группы, уничтожает обработчики событий и анимаций, если они есть,
и обнуляет ссылку на игру, освобождая его для сбора мусора.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
destroyChildren | boolean | <необязательно> | true | Нужно ли вызвать метод destroy для каждого дочернего элемента этого объекта? |
generateTilingTexture(forcePowerOfTwo, renderSession)
Параметры
| Имя | Тип | Описание |
|---|---|---|
forcePowerOfTwo | Boolean | Нужно ли принудительно сделать текстуру степенью двойки |
renderSession | RenderSession | - |
getBounds() → {Rectangle}
Возвращает прямоугольник обрамления спрайта в виде объекта PIXI.Rectangle
Возвращаемое значение
прямоугольник обрамления
getChildAt(index) → {DisplayObject}
Возвращает дочерний элемент в указанном индексе
Параметры
| Имя | Тип | Описание |
|---|---|---|
index | Число | Индекс для получения дочернего элемента |
Возвращаемое значение
Дочерний элемент в заданном индексе, если таковой имеется.
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 153)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 112)
- Унаследовано от
- Исходный код: pixi/display/Sprite.js (Строка 315)
- Унаследовано от
- Исходный код: gameobjects/components/LifeSpan.js (Строка 113)
- Унаследовано от
- Исходный код: gameobjects/components/LoadTexture.js (Строка 51)
- Унаследовано от
- Исходный код: gameobjects/components/BringToTop.js (Строка 87)
- Унаследовано от
- Исходный код: gameobjects/components/BringToTop.js (Строка 66)
getChildIndex(child) → {Число}
Возвращает индекс позиции дочернего объекта DisplayObject.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | Объект DisplayObject для идентификации. |
Возвращаемое значение
Индекс позиции дочернего объекта отображения для идентификации.
getLocalBounds() → {Прямоугольник}
Получает локальные границы объекта Sprite, не глобальные, как прямоугольник. Вычисление учитывает все видимые дочерние элементы.
Возвращаемое значение
Прямоугольная область границ.
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, поэтому используйте экономно или в малоинтенсивных частях вашей игры, или если вы знаете, что новая текстура уже находится в видеопамяти.
Вы можете использовать новую константу Phaser.PENDING_ATLAS в качестве ключа текстуры для любого спрайта.
Это устанавливает ключ в значение frame (фрейм установлен в ноль).
Это позволяет создавать спрайты, используя load.image во время разработки, а затем изменять их
на использование атласа текстур позднее, просто найдя в вашем коде 'PENDING_ATLAS'
и поменяв его на ключ данных атласа.
Примечание: вы не можете использовать RenderTexture в качестве текстуры для TileSprite.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
key | строка | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture | Это изображение или текстура, используемая объектом Sprite во время рендеринга. Это может быть строка, которая является ссылкой на запись изображения кэша, или экземпляр RenderTexture, BitmapData, Video или PIXI.Texture. | ||
frame | строка | число | <необязательно> | Если этот Sprite использует часть спрайт-листа или атласа текстур, вы можете указать точный фрейм, используя строку или числовой индекс. | |
stopAnimation | логическое | <необязательно> | true | Если на этом Sprite уже воспроизводится анимация, вы можете выбрать остановить её или продолжить воспроизведение. |
moveDown() → {PIXI.DisplayObject}
Перемещает этот объект Game на одну позицию вниз в списке отображения родителя.
Этот вызов не имеет эффекта, если объект Game уже находится внизу списка отображения.
Если этот объект Game не добавлен в пользовательскую группу, этот метод переместит его на один объект вниз в мире Game,
потому что мир — это корневая группа, от которой происходят все объекты Game.
Возвращаемое значение
Этот экземпляр.
moveUp() → {PIXI.DisplayObject}
Перемещает этот объект Game на одну позицию вверх в списке отображения родителя.
Этот вызов не имеет эффекта, если объект Game уже находится вверху списка отображения.
Если этот объект Game не добавлен в пользовательскую группу, этот метод переместит его на один объект вверх в мире Game,
потому что мир — это корневая группа, от которой происходят все объекты Game.
Возвращаемое значение
Этот экземпляр.
overlap(displayObject) → {boolean}
Проверяет, пересекаются ли границы этого объекта Game с границами заданного объекта Display Object,
который может быть Sprite, Image, TileSprite или чем-либо, что расширяет эти, например, Button или предоставляет метод getBounds и результат.
Эта проверка игнорирует свойство hitArea, если оно установлено, и выполняет сравнение getBounds обоих объектов, чтобы определить результат.
Поэтому его относительно дорого использовать в больших количествах, т. е. с большим количеством Sprites с высокой частотой.
Он должен быть хорош для проверки с низким объемом, где физика не требуется.
Параметры
- Унаследовано от
- Исходный код: gameobjects/components/Overlap.js (Строка 29)
- Унаследовано от
- Исходный код: gameobjects/components/Animation.js (Строка 31)
- Унаследовано от
- Внутренний:
- Этот член является внутренним (защищенным) и может быть изменен или удалён в будущем.
- Исходный код: gameobjects/components/Core.js (Строка 338)
- Исходный код: gameobjects/TileSprite.js (Строка 122)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 171)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 191)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 213)
- Исходный код: gameobjects/TileSprite.js (Строка 194)
| Имя | Тип | Описание |
|---|---|---|
displayObject | Phaser.Sprite | Phaser.Image | Phaser.TileSprite | Phaser.Button | PIXI.DisplayObject | Объект отображения для проверки. |
Возвращает
Истина, если границы этого объекта Game Object пересекаются с границами данного объекта отображения в любой точке.
play(name, frameRate, loop, killOnComplete) → {Phaser.Animation}
Запускает анимацию.
Анимация должна быть предварительно создана с помощью animations.add.
Если анимация уже запущена, повторный вызов этой функции ничего не сделает.
Если вам нужно перезапустить уже запущенную анимацию, сделайте это непосредственно на самом объекте Animation или с помощью AnimationManager.stop.
Параметры
| Имя | Тип | Аргумент | Значение по умолчанию | Описание |
|---|---|---|---|---|
name | string | Имя анимации для воспроизведения, например, "огонь", "ходьба", "прыжок". Должна быть предварительно создана с помощью 'AnimationManager.add'. | ||
frameRate | number | <optional> | null | Частота кадров для воспроизведения анимации. Скорость задаётся в кадрах в секунду. Если не указано, используется ранее установленная частота кадров анимации. |
loop | boolean | <optional> | false | Должна ли анимация циклически повторяться после воспроизведения. Если не указано, используется ранее установленное значение циклического повтора анимации. |
killOnComplete | boolean | <optional> | false | Если установлено в true, при завершении анимации (только если loop=false) родительский Sprite будет уничтожен. |
Возвращает
Ссылка на воспроизводимую анимацию.
<internal> postUpdate()
Внутренний метод, вызываемый циклом postUpdate в World.
preUpdate()
Автоматически вызывается World.preUpdate.
removeChild(child) → {DisplayObject}
Удаляет дочерний элемент из контейнера.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | Удаляемый DisplayObject. |
Возвращает
Удаленный дочерний элемент.
removeChildAt(index) → {DisplayObject}
Удаляет дочерний элемент по указанному индексу.
Параметры
| Имя | Тип | Описание |
|---|---|---|
index | Число | Индекс дочернего элемента. |
Возвращает
Удаленный дочерний элемент.
removeChildren(beginIndex, endIndex)
Удаляет всех дочерних элементов контейнера, находящихся в диапазоне индексов begin и end.
Параметры
| Имя | Тип | Описание |
|---|---|---|
beginIndex | Число | Начальная позиция. Значение по умолчанию 0. |
endIndex | Число | Конечная позиция. Значение по умолчанию — размер контейнера. |
reset(x, y) → {Phaser.TileSprite}
Сбрасывает состояние TileSprite. Размещает TileSprite в заданных мировых координатах x/y, сбрасывает tilePosition и затем устанавливает alive, exists, visible и renderable в true. Также сбрасывает состояние outOfBounds.
Если у TileSprite есть физическое тело, оно также сбрасывается.
Параметры
| Имя | Тип | Описание |
|---|---|---|
x | число | Координата x (в мировом пространстве) для размещения Sprite. |
y | число | Координата y (в мировом пространстве) для размещения Sprite. |
Возвращает
Этот экземпляр.
- Унаследовано от
- Исходный код: 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)
- Унаследовано от
- Исходный код: pixi/display/Sprite.js (Строка 163)
- Исходный код: gameobjects/TileSprite.js (Строка 166)
- Унаследовано от
- Исходный код: pixi/display/DisplayObjectContainer.js (Строка 85)
resetFrame()
Сбрасывает размеры рамки текстуры, которую использует объект игры для отрисовки.
resizeFrame(parent, width, height)
Изменяет размеры рамки, которые использует объект игры для отрисовки.
Обычно вам не нужно вызывать этот метод, но в случае со специальными типами текстур, такими как Video или BitmapData,
он может быть полезен для прямого изменения размеров.
Параметры
| Имя | Тип | Описание |
|---|---|---|
parent | object | Объект родительской текстуры, вызвавший изменение размера, например, объект Phaser.Video. |
width | integer | Новая ширина текстуры. |
height | integer | Новая высота текстуры. |
revive(health) → {PIXI.DisplayObject}
Возвращает 'мёртвый' объект игры к жизни, при необходимости сбросив его значение здоровья.
Возрождённый объект игры имеет свойства alive, exists и visible установленные в true.
Он будет отправлять событие onRevived. Слушайте событие events.onRevived.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
health | number | <optional> | 100 | Здоровье, которое нужно присвоить объекту игры. Устанавливается только если у GameObject есть компонент Health. |
Возвращает
Этот экземпляр.
sendToBack() → {PIXI.DisplayObject}
Перемещает этот объект игры в конец списка отображения родителя.
Визуально это означает, что он будет отрисовываться ниже всех других дочерних элементов в той же группе.
Если этот объект игры не был добавлен в пользовательскую группу, то этот метод поместит его в конец отображения игры,
потому что World — это корневая группа, из которой происходят все объекты игры.
Возвращает
Этот экземпляр.
setChildIndex(child, index)
Изменяет положение существующего дочернего элемента в контейнере отображения.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | Экземпляр дочернего элемента DisplayObject, для которого вы хотите изменить номер индекса. |
index | Number | Результирующий номер индекса для дочернего объекта отображения. |
setFrame(frame)
Устанавливает рамку текстуры, которую объект игры использует для отрисовки.
Это в основном внутренний метод, используемый loadTexture, но доступен для использования плагинами и пользовательскими классами.
Параметры
| Имя | Тип | Описание |
|---|---|---|
frame | Phaser.Frame | Рамка, используемая для текстуры. |
setTexture(texture, destroy)
Устанавливает текстуру спрайта. Обратите внимание, что это не удаляет или не уничтожает предыдущую
текстуру, которую использовал этот Sprite.
Параметры
| Имя | Тип | Аргумент | По умолчанию | Описание |
|---|---|---|---|---|
texture | PIXI.Texture | PIXI текстура, отображаемая спрайтом | ||
destroy | Boolean | <optional> | false | Вызвать Texture.destroy для текущей текстуры перед заменой её новой? |
stopScroll()
Останавливает автоматическое прокручивание TileSprite.
swapChildren(child, child2)
Меняет местами положение 2 объектов отображения внутри этого контейнера.
Параметры
| Имя | Тип | Описание |
|---|---|---|
child | DisplayObject | - |
child2 | DisplayObject | - |
update()
- Унаследовано от
- Исходный код: gameobjects/components/Core.js (Строка 328)
Переопределите этот метод в собственных пользовательских объектах для обработки любых требований к обновлению.
Он вызывается сразу после preUpdate и перед postUpdate.
Помните, если у этого объекта игры есть какие-либо дочерние элементы, вы также должны вызвать обновление для них.
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.TileSprite.html