Sprite Class
The Sprite object is the base for all textured objects that are rendered to the screen
Constructor
Item Index
Methods
Methods
addChild
-
child
Adds a child to the container.
Parameters:
-
childDisplayObjectThe DisplayObject to add to the container
addChildAt
-
child -
index
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
Parameters:
-
childDisplayObjectThe child to add
-
indexNumberThe index to place the child in
click
-
interactionData
A callback that is used when the users clicks on the displayObject with their mouse
Parameters:
-
interactionDataInteractionData
fromFrame
-
frameId
Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId The frame ids are created when a Texture packer file has been loaded
Parameters:
-
frameIdStringThe frame Id of the texture in the cache
Returns:
A new Sprite using a texture from the texture cache matching the frameId
fromImage
-
imageId
Helper function that creates a sprite that will contain a texture based on an image url If the image is not in the texture cache it will be loaded
Parameters:
-
imageIdStringThe image url of the texture
Returns:
A new Sprite using a texture from the texture cache matching the image id
getChildAt
-
index
Returns the child at the specified index
Parameters:
-
indexNumberThe index to get the child from
mousedown
-
interactionData
A callback that is used when the user clicks the mouse down over the sprite
Parameters:
-
interactionDataInteractionData
mouseout
-
interactionData
A callback that is used when the users mouse leaves the displayObject
Parameters:
-
interactionDataInteractionData
mouseover
-
interactionData
A callback that is used when the users mouse rolls over the displayObject
Parameters:
-
interactionDataInteractionData
mouseup
-
interactionData
A callback that is used when the user releases the mouse that was over the displayObject for this callback to be fired the mouse must have been pressed down over the displayObject
Parameters:
-
interactionDataInteractionData
mouseupoutside
-
interactionData
A callback that is used when the user releases the mouse that was over the displayObject but is no longer over the displayObject for this callback to be fired, The touch must have started over the displayObject
Parameters:
-
interactionDataInteractionData
onTextureUpdate
-
event
When the texture is updated, this event will fire to update the scale and frame
Parameters:
-
eventObject
removeChild
-
child
Removes a child from the container.
Parameters:
-
childDisplayObjectThe DisplayObject to remove
setInteractive
-
interactive
[Deprecated] Indicates if the sprite will have touch and mouse interactivity. It is false by default Instead of using this function you can now simply set the interactive property to true or false
Parameters:
-
interactiveBoolean
setTexture
-
texture
Sets the texture of the sprite
Parameters:
-
textureTextureThe PIXI texture that is displayed by the sprite
swapChildren
-
child -
child2
[NYI] Swaps the depth of 2 displayObjects
Parameters:
-
childDisplayObject -
child2DisplayObject
tap
-
interactionData
A callback that is used when the users taps on the sprite with their finger basically a touch version of click
Parameters:
-
interactionDataInteractionData
touchend
-
interactionData
A callback that is used when the user releases a touch over the displayObject
Parameters:
-
interactionDataInteractionData
touchendoutside
-
interactionData
A callback that is used when the user releases the touch that was over the displayObject for this callback to be fired, The touch must have started over the sprite
Parameters:
-
interactionDataInteractionData
touchstart
-
interactionData
A callback that is used when the user touches over the displayObject
Parameters:
-
interactionDataInteractionData
Properties
_height
Number
private
The height of the sprite (this is initially set by the texture)
_interactive
Boolean
private
[read-only] Whether or not the object is interactive, do not toggle directly! use the interactive property
_width
Number
private
The width of the sprite (this is initially set by the texture)
alpha
Number
The opacity of the object.
anchor
Point
The anchor sets the origin point of the texture. The default is 0,0 this means the textures origin is the top left Setting than anchor to 0.5,0.5 means the textures origin is centered Setting the anchor to 1,1 would mean the textures origin points will be the bottom right
blendMode
Number
The blend mode to be applied to the sprite
Default: PIXI.blendModes.NORMAL;
children
Array[read-only] The of children of this container.
color
Array<>
private
[NYI] Unknown
defaultCursor
String
This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true
dynamic
Boolean
private
[NYI] Holds whether or not this object is dynamic, for rendering optimization
filters
Array An array of filters
Sets the filters for the displayObject.
- IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'
height
Number
The height of the sprite, setting this will actually modify the scale to achieve the value set
hitArea
Rectangle | Circle | Ellipse | Polygon
This is the defined area that will pick up mouse / touch events. It is null by default. Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)
interactive
Boolean
Indicates if the sprite will have touch and mouse interactivity. It is false by default
Default: false
localTransform
Mat3
private
[read-only] Current transform of the object locally
mask
Graphics
Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.
parent
DisplayObjectContainer
[read-only] The display object container that contains this display object.
renderable
Boolean
Can this object be rendered
rotation
Number
The rotation of the object in radians.
stage
Stage
[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.
tint
Number
The tint applied to the sprite. This is a hex value
Default: 0xFFFFFF
visible
Boolean
The visibility of the object.
width
Number
The width of the sprite, setting this will actually modify the scale to achieve the value set
worldAlpha
Number
[read-only] The multiplied alpha of the displayObject
worldTransform
Mat3
private
[read-only] Current transform of the object based on world (parent) factors
worldVisible
Boolean
[read-only] Indicates if the sprite is globaly visible.