Check if the animation can start playing
Returns:
| Type | Description |
|---|
| boolean | True if the animation can start |
Check if the animation has ended. Sets playing to false if ended
Destroys the sprite
Gets the blend color for the sprite
Returns:
| Type | Description |
|---|
| array | The blend color [r, g, b, a] |
Gets the color tone for the sprite
Returns:
| Type | Description |
|---|
| array | The color tone [r, g, b, gray] |
Makes the sprite "hidden" (not visible)
Initialize sprite variables
Initializes the sprite
| Name | Type | Description |
|---|
bitmap | Bitmap | The bitmap of the sprite |
Check if the animation is playing
Returns:
| Type | Description |
|---|
| boolean | True if animation is currently playing |
Sets the x and y coordiantes of the sprite
| Name | Type | Description |
|---|
x | number | The x coordinate of the sprite |
y | number | The y coordinate of the sprite |
Handling after render occurs
| Name | Type | Description |
|---|
The | PIXI.Renderer | renderer for the game |
Handling before render occurs
| Name | Type | Description |
|---|
The | PIXI.Renderer | renderer for the game |
Handles showing flashes at the right frame
Handles playing sound effects at the right frame
Resets the viewport
| Name | Type | Description |
|---|
The | PIXI.Renderer | renderer for the game |
Sets the blend color for the sprite
| Name | Type | Description |
|---|
color | array | The blend color [r, g, b, a] |
Sets the camera matrix for the animation
Sets the color tone for the sprite
| Name | Type | Description |
|---|
tone | array | The color tone [r, g, b, gray] |
Sets the rectagle of the bitmap that the sprite displays
| Name | Type | Description |
|---|
x | number | The x coordinate of the frame |
y | number | The y coordinate of the frame |
width | number | The width of the frame |
height | number | The height of the frame |
Sets the hue rotation value
| Name | Type | Description |
|---|
hue | number | The hue value (-360, 360) |
Sets the projection matrix for the animation
| Name | Type | Description |
|---|
The | PIXI.Renderer | renderer for the game |
Sets the rotation of the animation
| Name | Type | Description |
|---|
x | number | The x value of the rotation |
y | number | The y value of the rotation |
z | number | The z value of the rotation |
Sets the viewport for the animation
| Name | Type | Description |
|---|
The | PIXI.Renderer | renderer for the game |
setup({Array, animation, mirror, delay, previous)
Set up the animation sprite
| Name | Type | Description |
|---|
{Array | | targets - The targets of the animation |
animation | Object | The animation object to play |
mirror | boolean | If the animation should mirror |
delay | number | Frame delay for the animation |
previous | Sprite_Animation|Sprite_AnimationMV|null | The previous animation sprite |
shouldWaitForPrevious()boolean
Check if the animation should wait for the previous animation to finish
Returns:
| Type | Description |
|---|
| boolean | True if animation should wait for the previous animation to finish |
Removes the "hidden" state of the sprite, making it visible
Sets the target position for the animation
| Name | Type | Description |
|---|
The | PIXI.Renderer | renderer for the game |
Returns:
| Type | Description |
|---|
| Point | The point representing the x and y coordinates of the animation |
targetSpritePosition(The)Point
Gets the target sprite's position
| Name | Type | Description |
|---|
The | Sprite | sprite to show the animation on |
Returns:
| Type | Description |
|---|
| Point | A point representing the x/y coordinates where the sprite is |
Updates the sprite for each frame
Update for effect geometry
Update for flash effects
Update for main effects
Updates the visibility status of the sprite