Spec-Zone.ru › Phaser

Класс: PIXI.Sprite

Конструктор

new Sprite(texture)

Объект Sprite является основой для всех текстурированных объектов, которые отображаются на экране

Параметры
Имя Тип Описание
texture PIXI.Texture

Текстура для этого спрайта

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

Расширяет

  • PIXI.DisplayObjectContainer

Открытые свойства

anchor :Point

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

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

blendMode : number

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

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

Значение по умолчанию
  • PIXI.blendModes.NORMAL;
Исходный код: pixi/display/Sprite.js (Строка 82)

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

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

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

exists : boolean

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

Значение по умолчанию
  • true
Исходный код: pixi/display/Sprite.js (Строка 103)

height : number

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

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

ignoreChildInput : boolean

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

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

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

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

shader : PIXI.AbstractFilter

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

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

texture : PIXI.Texture

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

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

tint : number

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

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

tintedTexture :Canvas

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

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

width : number

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

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

Открытые методы

addChild(child) → {DisplayObject}

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

Parameters
Name Type Description
child DisplayObject

Элемент DisplayObject, который нужно добавить в контейнер

Returns
DisplayObject -

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

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

addChildAt(child, index) → {DisplayObject}

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

Parameters
Name Type Description
child DisplayObject

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

index Number

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

Returns
DisplayObject -

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

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

contains(child) → {Boolean}

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

Parameters
Name Type Description
child DisplayObject

-

Returns
Boolean -
Inherited From
  • PIXI.DisplayObjectContainer#contains
Source code: pixi/display/DisplayObjectContainer.js (Line 449)

getBounds(matrix) → {Rectangle}

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

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

Parameters
Name Type Description
matrix Matrix

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

Returns
Rectangle -

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

Source code: pixi/display/Sprite.js (Line 199)

getChildAt(index) → {DisplayObject}

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

Parameters
Name Type Description
index Number

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

Returns
DisplayObject -

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

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

getChildIndex(child) → {Number}

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

Parameters
Name Type Description
child DisplayObject

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

Returns
Number -

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

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

getLocalBounds() → {Rectangle}

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

Returns
Rectangle -

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

Source code: pixi/display/Sprite.js (Line 315)

removeChild(child) → {DisplayObject}

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

Parameters
Name Type Description
child DisplayObject

Элемент DisplayObject для удаления

Returns
DisplayObject -

Дочерний элемент, который был удалён.

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

removeChildAt(index) → {DisplayObject}

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

Parameters
Name Type Description
index Number

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

Returns
DisplayObject -

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

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

removeChildren(beginIndex, endIndex)

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

Parameters
Name Type Описание
beginIndex Number

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

endIndex Number

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

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

setChildIndex(child, index)

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

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

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

index Number

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

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

setTexture(texture, destroy)

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

Parameters
Name Type Аргумент Значение по умолчанию Описание
texture PIXI.Texture

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

destroy Boolean <необязательно>
false

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

Source code: pixi/display/Sprite.js (Line 163)

swapChildren(child, child2)

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

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

-

child2 DisplayObject

-

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

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

Spec-Zone.ru

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