Name | Type | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | int |
optional
The options object or the mode to play
|
Extends
Members
-
The default framerate if none is specified or there's not parent clip with a framerate.
- Default Value:
- 24
-
The MovieClip will advance independently of its parent, even if its parent is paused. This is the default mode.
- Default Value:
- 0
-
The MovieClip will only display a single frame (as determined by the startPosition property).
- Default Value:
- 1
-
The MovieClip will be advanced only when its parent advances and will be synched to the position of the parent MovieClip.
- Default Value:
- 2
-
Array of frame scripts, indexed by frame.
-
By default MovieClip instances advance one frame per tick. Specifying a framerate for the MovieClip will cause it to advance based on elapsed time between ticks as appropriate to maintain the target framerate.
- Default Value:
- 0
-
Array of child timelines denoting if a child is actively a child of this movieclip on any given frame. Each element in the _timedChildTimelines is an array with a 'target' property, and is an array of boolean values indexed by frame.
-
Standard tween timelines for all objects. Each element in the _timelines array is a Timeline object - an array of tweens for one target, in order of occurrence.
-
If true, actions in this MovieClip's tweens will be run when the playhead advances.
- Default Value:
- true
-
alpha number inherited
-
The opacity of the object.
-
If true, the MovieClip will automatically be reset to its first frame whenever the timeline adds it back onto the display list. This only applies to MovieClip instances with mode=INDEPENDENT.
For example, if you had a character animation with a 'body' child MovieClip instance with different costumes on each frame, you could set body.autoReset = false, so that you can manually change the frame it is on, without worrying that it will be reset automatically.- Default Value:
- true
-
buttonMode boolean inherited
-
If enabled, the mouse cursor use the pointer behavior when hovered over the displayObject if it is interactive Setting this changes the 'cursor' property to
'pointer'
.Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.buttonMode = true;
-
cacheAsBitmap boolean inherited
-
Set this to true if you want this display object to be cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to 'false'
IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.
-
children readonly inherited
-
The array of children of this container.
-
The current frame of the movieclip.
- Default Value:
- 0
-
Returns the name of the label on or immediately before the current frame.
-
cursor string inherited
-
This defines what cursor mode is used when the mouse cursor is hovered over the displayObject.
Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.cursor = 'wait';
-
When the MovieClip is framerate independent, this is the time elapsed from frame 0 in seconds.
- Default Value:
- 0
-
filterArea PIXI.Rectangle inherited
-
The area the filter is applied to. This is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle
Also works as an interaction mask
-
filters inherited
-
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'
-
By default MovieClip instances advance one frame per tick. Specifying a framerate for the MovieClip will cause it to advance based on elapsed time between ticks as appropriate to maintain the target framerate.
For example, if a MovieClip with a framerate of 10 is placed on a Stage being updated at 40fps, then the MovieClip will advance roughly one frame every 4 ticks. This will not be exact, because the time between each tick will vary slightly between frames.
This feature is dependent on the tick event object (or an object with an appropriate 'delta' property) being passed into {{#crossLink 'Stage/update'}}{{/crossLink}}.
- Default Value:
- 0
-
height number inherited
-
The height of the Container, setting this will actually modify the scale to achieve the value set
-
hitArea PIXI.Rectangle | PIXI.Circle | PIXI.Ellipse | PIXI.Polygon | PIXI.RoundedRectangle inherited
-
Interaction shape. Children will be hit first, then this shape will be checked. Setting this will cause this shape to be checked in hit tests rather than the displayObject's bounds.
Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.hitArea = new PIXI.Rectangle(0, 0, 100, 100);
-
interactive boolean inherited
-
Enable interaction events for the DisplayObject. Touch, pointer and mouse events will not be emitted unless
interactive
is set totrue
.Example
const sprite = new PIXI.Sprite(texture); sprite.interactive = true; sprite.on('tap', (event) => { //handle event });
-
interactiveChildren boolean inherited
-
Determines if the children to the displayObject can be clicked/touched Setting this to false allows PixiJS to bypass a recursive
hitTest
function -
Returns an array of objects with label and position (aka frame) properties, sorted by position.
-
Returns a dictionary of labels where key is the label and value is the frame.
-
localTransform PIXI.Matrix readonly inherited
-
Current transform of the object based on local factors: position, scale, other stuff
-
Indicates whether this MovieClip should loop when it reaches the end of its timeline.
- Default Value:
- true
-
mask PIXI.Graphics | PIXI.Sprite inherited
-
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 or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilises shape clipping. To remove a mask, set this property to null.
- TODO
-
- For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.
-
Controls how this MovieClip advances its time. Must be one of 0 (INDEPENDENT), 1 (SINGLE_FRAME), or 2 (SYNCHED). See each constant for a description of the behaviour.
- Default Value:
- null
-
name string inherited
-
The instance name of the object.
-
parent PIXI.Container readonly inherited
-
The display object container that contains this display object.
-
Get the close parent with a valid framerate. If no parent, returns the default framerate.
-
If true, the MovieClip's position will not advance when ticked.
- Default Value:
- false
-
pivot PIXI.Point | PIXI.ObservablePoint inherited
-
The pivot point of the displayObject that it rotates around. Assignment by value since pixi-v4.
-
position PIXI.Point | PIXI.ObservablePoint inherited
-
The coordinate of the object relative to the local coordinates of the parent. Assignment by value since pixi-v4.
-
renderable boolean inherited
-
Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called.
Only affects recursive calls from parent. You can ask for bounds manually
-
rotation number inherited
-
The rotation of the object in radians.
-
scale PIXI.Point | PIXI.ObservablePoint inherited
-
The scale factor of the object. Assignment by value since pixi-v4.
-
If true, this movieclip will animate automatically whenever it is on the stage.
- Default Value:
- true
-
The skew factor for the object in radians. Assignment by value since pixi-v4.
-
Specifies what the first frame to play in this movieclip, or the only frame to display if mode is SINGLE_FRAME.
- Default Value:
- 0
-
Get the total number of frames (duration) of this MovieClip
- Default Value:
- 0
-
transform PIXI.TransformBase inherited
-
World transform and local transform of this object. This will become read-only later, please do not assign anything there unless you know what are you doing
-
visible boolean inherited
-
The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.
Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
-
width number inherited
-
The width of the Container, setting this will actually modify the scale to achieve the value set
-
worldAlpha number readonly inherited
-
The multiplied alpha of the displayObject
-
worldTransform PIXI.Matrix readonly inherited
-
Current transform of the object based on world (parent) factors
-
worldVisible boolean readonly inherited
-
Indicates if the object is globally visible.
-
x number inherited
-
The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x
-
y number inherited
-
The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y
Methods
-
PIXI.animate.MovieClip.e (child)PIXI.animate.MovieClip static
-
Extend a container (alias for
extend
)Name Type Description child
PIXI.animate.MovieClip The child function
Returns:
Type Description PIXI.animate.MovieClip The child -
PIXI.animate.MovieClip.extend (child)PIXI.animate.MovieClip static
-
Extend a container
Name Type Description child
PIXI.animate.MovieClip The child function
Returns:
Type Description PIXI.animate.MovieClip The child -
_calculateBounds () inherited
-
Recalculates the bounds of the object. Override this to calculate the bounds of the specific object (not including children).
-
Name Type Description positionOrLabel
String | Number The animation name or frame number to go to.
-
_recursivePostUpdateTransform () inherited
-
recursively updates transform of all objects from the root to this one internal function for toLocal()
-
Set the timeline position
Name Type Description startFrame
int currentFrame
int doActions
Boolean -
-
Shortcut for
setAlpha
.Name Type Description alpha
Number The alpha amount to use, from 0 to 1
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
aa (callback, startFrame)PIXI.animate.MovieClip
-
Short cut for
addAction
Name Type Description callback
function The clip call on a certain frame
startFrame
int | String The starting frame index or label
Returns:
Type Description PIXI.animate.MovieClip -
ac (child*)PIXI.DisplayObject inherited
-
Shortcut for
addChild
.Name Type Description child*
* optional N-number of children
Returns:
Type Description PIXI.DisplayObject Instance of first child added -
addAction (callback, startFrame)PIXI.animate.MovieClip
-
Handle frame actions, callback is bound to the instance of the MovieClip.
Name Type Description callback
function The clip call on a certain frame
startFrame
int | String The starting frame index or label
Returns:
Type Description PIXI.animate.MovieClip -
addChild (child)PIXI.DisplayObject inherited
-
Adds one or more children to the container.
Multiple items can be added like so:
myContainer.addChild(thingOne, thingTwo, thingThree)
Name Type Description child
PIXI.DisplayObject repeatable The DisplayObject(s) to add to the container
Returns:
Type Description PIXI.DisplayObject The first child that was added. -
addChildAt (child, index)PIXI.DisplayObject inherited
-
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
Name Type Description child
PIXI.DisplayObject The child to add
index
number The index to place the child in
Returns:
Type Description PIXI.DisplayObject The child that was added. -
addKeyframe (instance, properties, startFrame, duration, ease)PIXI.animate.MovieClip
-
Add a tween to the clip
Name Type Default Description instance
PIXI.DisplayObject The clip to tween
properties
Object The property or property to tween
startFrame
int The frame to start tweening
duration
int 0 optional Number of frames to tween. If 0, then the properties are set with no tweening.
ease
function optional An optional easing function that takes the tween time from 0-1.
Returns:
Type Description PIXI.animate.MovieClip -
addTimedChild (instance, startFrame, duration, keyframes)PIXI.animate.MovieClip
-
Add a child to show for a certain number of frames before automatic removal.
Name Type Default Description instance
PIXI.DisplayObject The clip to show
startFrame
int The starting frame
duration
int 1 optional The number of frames to display the child before removing it.
keyframes
String | Array optional The collection of static keyframes to add
Returns:
Type Description PIXI.animate.MovieClip -
addTimedMask (instance, keyframes)PIXI.animate.MovieClip
-
Add mask or masks
Name Type Description instance
PIXI.DisplayObject Instance to mask
keyframes
Object The map of frames to mask objects
Returns:
Type Description PIXI.animate.MovieClip instance of clip for chaining -
addTween (instance, properties, startFrame, duration, ease)PIXI.animate.MovieClip
-
Add a tween to the clip
Name Type Default Description instance
PIXI.DisplayObject The clip to tween
properties
Object The property or property to tween
startFrame
int The frame to start tweening
duration
int 0 optional Number of frames to tween. If 0, then the properties are set with no tweening.
ease
function optional An optional easing function that takes the tween time from 0-1.
Returns:
Type Description PIXI.animate.MovieClip -
Advances the playhead. This occurs automatically each tick by default.
Name Type Description time
Number optional The amount of time in seconds to advance by. Only applicable if framerate is set.
-
am (instance, keyframes)PIXI.animate.MovieClip
-
Shortcut alias for
addTimedMask
Name Type Description instance
PIXI.DisplayObject Instance to mask
keyframes
Object The map of frames to mask objects
Returns:
Type Description PIXI.animate.MovieClip instance of clip for chaining -
Alias for method
addTimedChild
Returns:
Type Description PIXI.animate.MovieClip -
c (r, rA, g, gA, b, bA)PIXI.DisplayObject inherited
-
Shortcut to
setColor
.Name Type Description r
Number The multiply red value
rA
Number The additive red value
g
Number The multiply green value
gA
Number The additive green value
b
Number The multiply blue value
bA
Number The additive blue value
Returns:
Type Description PIXI.DisplayObject Object for chaining -
calculateBounds () inherited
-
Recalculates the bounds of the container.
-
Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling
destroy
.Name Type Description options
object | boolean optional Options parameter. A boolean will act as if all options have been set to that value
Name Type Default Description children
boolean false optional if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
texture
boolean false optional Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
baseTexture
boolean false optional Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite
-
getBounds (skipUpdate, rect)PIXI.Rectangle inherited
-
Retrieves the bounds of the displayObject as a rectangle object.
Name Type Description skipUpdate
boolean setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost
rect
PIXI.Rectangle Optional rectangle to store the result of the bounds calculation
Returns:
Type Description PIXI.Rectangle the rectangular bounding area -
getChildAt (index)PIXI.DisplayObject inherited
-
Returns the child at the specified index
Name Type Description index
number The index to get the child at
Returns:
Type Description PIXI.DisplayObject The child at the given index, if any. -
getChildByName (name)PIXI.DisplayObject inherited
-
Returns the display object in the container
Name Type Description name
string instance name
Returns:
Type Description PIXI.DisplayObject The child with the specified name. -
getChildIndex (child)number inherited
-
Returns the index position of a child DisplayObject instance
Name Type Description child
PIXI.DisplayObject The DisplayObject instance to identify
Returns:
Type Description number The index position of the child display object to identify -
getGlobalPosition (point, skipUpdate)Point inherited
-
Returns the global position of the displayObject. Does not depend on object scale, rotation and pivot.
Name Type Description point
Point the point to write the global value to. If null a new point will be returned
skipUpdate
boolean setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost
Returns:
Type Description Point The updated point -
getLocalBounds (rect)PIXI.Rectangle inherited
-
Retrieves the local bounds of the displayObject as a rectangle object
Name Type Description rect
PIXI.Rectangle optional Optional rectangle to store the result of the bounds calculation
Returns:
Type Description PIXI.Rectangle the rectangular bounding area -
Advances this movie clip to the specified position or label and sets paused to false.
Name Type Description positionOrLabel
String | Number The animation name or frame number to go to.
-
Advances this movie clip to the specified position or label and sets paused to true.
Name Type Description positionOrLabel
String | Number The animation or frame name to go to.
-
Shortcut for
setMask
.Name Type Description mask
PIXI.Sprite | PIXI.Graphics The mask shape to use
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
Sets paused to false.
-
playSound (alias, loop, context)PIXI.animate.MovieClip
-
Handle sounds.
Name Type Default Description alias
String The name of the Sound
loop
Boolean false optional The loop property of the sound
context
MovieClip The MovieClip the sound originates from
Returns:
Type Description PIXI.animate.MovieClip -
ps (alias, loop, context)PIXI.animate.MovieClip
-
Short cut for
playSound
Name Type Default Description alias
String The name of the Sound
loop
Boolean false optional The loop property of the sound
context
MovieClip The MovieClip the sound originates from
Returns:
Type Description PIXI.animate.MovieClip -
re (renderable)PIXI.DisplayObject inherited
-
Shortcut to
setRenderable
.Name Type Default Description renderable
Boolean false optional Make renderable
Returns:
Type Description PIXI.DisplayObject -
removeChild (child)PIXI.DisplayObject inherited
-
Removes one or more children from the container.
Name Type Description child
PIXI.DisplayObject repeatable The DisplayObject(s) to remove
Returns:
Type Description PIXI.DisplayObject The first child that was removed. -
removeChildAt (index)PIXI.DisplayObject inherited
-
Removes a child from the specified index position.
Name Type Description index
number The index to get the child from
Returns:
Type Description PIXI.DisplayObject The child that was removed. -
removeChildren (beginIndex, endIndex) inherited
-
Removes all children from this container that are within the begin and end indexes.
Name Type Default Description beginIndex
number 0 optional The beginning position.
endIndex
number this.children.length optional The ending position. Default value is size of the container.
Returns:
Type Description List of removed children -
renderCanvas (renderer) inherited
-
Renders the object using the Canvas renderer
Name Type Description renderer
PIXI.CanvasRenderer The renderer
-
renderWebGL (renderer) inherited
-
Renders the object using the WebGL renderer
Name Type Description renderer
PIXI.WebGLRenderer The renderer
-
setAlpha (alpha)PIXI.DisplayObject inherited
-
Setter for the alpha
Name Type Description alpha
Number The alpha amount to use, from 0 to 1
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
setChildIndex (child, index) inherited
-
Changes the position of an existing child in the display object container
Name Type Description child
PIXI.DisplayObject The child DisplayObject instance for which you want to change the index number
index
number The resulting index number for the child display object
-
setColorTransform (r, rA, g, gA, b, bA)PIXI.DisplayObject inherited
-
Set additive and multiply color, tinting
Name Type Description r
Number The multiply red value
rA
Number The additive red value
g
Number The multiply green value
gA
Number The additive green value
b
Number The multiply blue value
bA
Number The additive blue value
Returns:
Type Description PIXI.DisplayObject Object for chaining -
setMask (mask)PIXI.DisplayObject inherited
-
Setter for mask to be able to chain.
Name Type Description mask
PIXI.Graphics The mask shape to use
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
setParent (container)PIXI.Container inherited
-
Set the parent Container of this DisplayObject
Name Type Description container
PIXI.Container The Container to add this DisplayObject to
Returns:
Type Description PIXI.Container The Container that this DisplayObject was added to -
setRenderable (renderable)PIXI.DisplayObject inherited
-
Function to see if this is renderable or not. Useful for setting masks.
Name Type Default Description renderable
Boolean false optional Make renderable
Returns:
Type Description PIXI.DisplayObject -
setTint (tint)PIXI.DisplayObject inherited
-
Set the tint values by color.
Name Type Description tint
int The color value to tint
Returns:
Type Description PIXI.DisplayObject Object for chaining -
setTransform (x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY)PIXI.DisplayObject inherited
-
Convenience function to set the position, scale, skew and pivot at once.
Name Type Default Description x
number 0 optional The X position
y
number 0 optional The Y position
scaleX
number 1 optional The X scale value
scaleY
number 1 optional The Y scale value
rotation
number 0 optional The rotation
skewX
number 0 optional The X skew value
skewY
number 0 optional The Y skew value
pivotX
number 0 optional The X pivot value
pivotY
number 0 optional The Y pivot value
Returns:
Type Description PIXI.DisplayObject The DisplayObject instance -
Sets paused to true.
-
swapChildren (child, child2) inherited
-
Swaps the position of 2 Display Objects within this container.
Name Type Description child
PIXI.DisplayObject First display object to swap
child2
PIXI.DisplayObject Second display object to swap
-
Shortcut to
setTint
.Name Type Description tint
Number | String The red percentage value
Returns:
Type Description PIXI.DisplayObject Object for chaining -
toGlobal (position, point, skipUpdate)PIXI.Point inherited
-
Calculates the global position of the display object
Name Type Default Description position
PIXI.Point The world origin to calculate from
point
PIXI.Point optional A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdate
boolean false optional Should we skip the update transform.
Returns:
Type Description PIXI.Point A point object representing the position of this object -
toLocal (position, from, point, skipUpdate)PIXI.Point inherited
-
Calculates the local position of the display object relative to another point
Name Type Default Description position
PIXI.Point The world origin to calculate from
from
PIXI.DisplayObject optional The DisplayObject to calculate the global position from
point
PIXI.Point optional A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdate
boolean false optional Should we skip the update transform
Returns:
Type Description PIXI.Point A point object representing the position of this object -
tr (x, y, scaleX, scaleY, skewX, skewY, pivotX, pivotY)PIXI.DisplayObject inherited
-
Shortcut for
setTransform
.Name Type Description x
Number The X position
y
Number The Y position
scaleX
Number The X Scale value
scaleY
Number The Y Scale value
skewX
Number The X skew value
skewY
Number The Y skew value
pivotX
Number The X pivot value
pivotY
Number The Y pivot value
Returns:
Type Description PIXI.DisplayObject Instance for chaining -
updateTransform () inherited
-
Updates the transform on all children of this container for rendering
Events
-
Fired when this DisplayObject is added to a Container.
Name Type Description container
PIXI.Container The container added to.
-
Fired when a pointer device button (usually a mouse left-button) is pressed and released on the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
mousedown inherited
-
Fired when a pointer device button (usually a mouse left-button) is pressed on the display. object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
mousemove inherited
-
Fired when a pointer device (usually a mouse) is moved while over the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
mouseout inherited
-
Fired when a pointer device (usually a mouse) is moved off the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
mouseover inherited
-
Fired when a pointer device (usually a mouse) is moved onto the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
mouseup inherited
-
Fired when a pointer device button (usually a mouse left-button) is released over the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
mouseupoutside inherited
-
Fired when a pointer device button (usually a mouse left-button) is released outside the display object that initially registered a mousedown. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
pointercancel inherited
-
Fired when the operating system cancels a pointer event. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
pointerdown inherited
-
Fired when a pointer device button is pressed on the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
pointermove inherited
-
Fired when a pointer device is moved while over the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
pointerout inherited
-
Fired when a pointer device is moved off the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
pointerover inherited
-
Fired when a pointer device is moved onto the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
pointertap inherited
-
Fired when a pointer device button is pressed and released on the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
pointerup inherited
-
Fired when a pointer device button is released over the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
pointerupoutside inherited
-
Fired when a pointer device button is released outside the display object that initially registered a pointerdown. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
removed inherited
-
Fired when this DisplayObject is removed from a Container.
Name Type Description container
PIXI.Container The container removed from.
-
rightclick inherited
-
Fired when a pointer device secondary button (usually a mouse right-button) is pressed and released on the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
rightdown inherited
-
Fired when a pointer device secondary button (usually a mouse right-button) is pressed on the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
rightup inherited
-
Fired when a pointer device secondary button (usually a mouse right-button) is released over the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
rightupoutside inherited
-
Fired when a pointer device secondary button (usually a mouse right-button) is released outside the display object that initially registered a rightdown. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
Fired when a touch point is placed and removed from the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
touchcancel inherited
-
Fired when the operating system cancels a touch. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
touchend inherited
-
Fired when a touch point is removed from the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
touchendoutside inherited
-
Fired when a touch point is removed outside of the display object that initially registered a touchstart. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
touchmove inherited
-
Fired when a touch point is moved along the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event
-
touchstart inherited
-
Fired when a touch point is placed on the display object. DisplayObject's
interactive
property must be set totrue
to fire event.Name Type Description event
PIXI.interaction.InteractionEvent Interaction event