Animation

Instance Constructors

new Animation(game: Phaser.Game, parent: Phaser.Sprite, name: String, frameData: Phaser.FrameData, frames: Array[|[JsNumber, String]], frameRate: Double = js.native, loop: Boolean = js.native)

game
A reference to the currently running game.
parent
A reference to the owner of this Animation.
name
The unique name for this animation, used in playback commands.
frameData
The FrameData object that contains all frames used by this Animation.
frames
An array of numbers or strings indicating which frames to play in which order.
frameRate
The speed at which the animation should play. The speed is given in frames per second.
loop
Whether or not the animation is looped or just plays once.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def complete(): Unit

Called internally when the animation finishes playback.
Called internally when the animation finishes playback. Sets the isPlaying and isFinished states and dispatches the onAnimationComplete event if it exists on the parent and local onComplete event.
var currentFrame: Phaser.Frame

The currently displayed frame of the Animation.
var delay: Double

The delay in ms between each frame of the Animation, based on the given frameRate.
def destroy(): Unit

Cleans up this animation ready for deletion.
Cleans up this animation ready for deletion. Nulls all values and references.
var enableUpdate: Boolean

Gets or sets if this animation will dispatch the onUpdate events upon changing frame.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
var frame: Int

Gets or sets the current frame index and updates the Texture Cache for display.
var frameData: Phaser.FrameData

The FrameData object that contains all frames used by this Animation.
var frameRate: Double

The speed at which the animation should play.
The speed at which the animation should play. The speed is given in frames per second.
def frameTotal: Int

The total number of frames in the currently loaded FrameData, or -1 if no FrameData is loaded.
var frames: Array[|[JsNumber, String]]

An array of numbers or strings indicating which frames to play in which order.
var game: Phaser.Game

A reference to the currently running game.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
var isFinished: Boolean

The finished state of the Animation.
The finished state of the Animation. Set to true once playback completes, false during playback.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
var isPaused: Boolean

The paused state of the Animation.
var isPlaying: Boolean

The playing state of the Animation.
The playing state of the Animation. Set to false once playback completes, true during playback.
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
var isReversed: Boolean

Indicates if the animation will play backwards.
var killOnComplete: Boolean

Should the parent of this Animation be killed when the animation completes?
var loop: Boolean

Whether or not the animation is looped or just plays once.
var loopCount: Int

The number of times the animation has looped since it was last started.
var name: String

The unique name for this animation, used in playback commands.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def next(quantity: Int = js.native): Unit

Advances by the given number of frames in the Animation, taking the loop value into consideration.
Advances by the given number of frames in the Animation, taking the loop value into consideration.
quantity
The number of frames to advance.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
var onComplete: Phaser.Signal

This event is dispatched when this Animation completes playback.
This event is dispatched when this Animation completes playback. If the animation is set to loop this is never fired, listen for onLoop instead.
var onLoop: Phaser.Signal

This event is dispatched when this Animation starts playback.
def onPause(): Unit

Called when the Game enters a paused state.
def onResume(): Unit

Called when the Game resumes from a paused state.
var onUpdate: Phaser.Signal

This event is dispatched when the Animation changes frame.
This event is dispatched when the Animation changes frame. By default this event is disabled due to its intensive nature. Enable it with: Animation.enableUpdate = true. Note that the event is only dispatched with the current frame. In a low-FPS environment Animations will automatically frame-skip to try and claw back time, so do not base your code on expecting to receive a perfectly sequential set of frames from this event.
var parent: Phaser.Sprite

A reference to the owner of this Animation.
var paused: Boolean

Gets and sets the paused state of this Animation.
def play(frameRate: Double = js.native, loop: Boolean = js.native, killOnComplete: Boolean = js.native): Animation.this.type

Plays this animation.
Plays this animation.
frameRate
The framerate to play the animation at. The speed is given in frames per second. If not provided the previously set frameRate of the Animation is used.
loop
Should the animation be looped after playback. If not provided the previously set loop value of the Animation is used.
killOnComplete
If set to true when the animation completes (only happens if loop=false) the parent Sprite will be killed.
returns
A reference to this Animation instance.
def previous(quantity: Int = js.native): Unit

Moves backwards the given number of frames in the Animation, taking the loop value into consideration.
Moves backwards the given number of frames in the Animation, taking the loop value into consideration.
quantity
The number of frames to move back.
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
def restart(): Unit

Sets this animation back to the first frame and restarts the animation.
def reverse(): Animation.this.type

Reverses the animation direction.
Reverses the animation direction.
returns
A reference to this Animation instance.
def reverseOnce(): Animation.this.type

Reverses the animation direction for the current/next animation only Once the onComplete event is called this method will be called again and revert the reversed state.
Reverses the animation direction for the current/next animation only Once the onComplete event is called this method will be called again and revert the reversed state.
returns
The animation instance.
var reversed: Boolean

Gets and sets the isReversed state of this Animation.
def setFrame(frameId: |[JsNumber, String] = js.native, useLocalFrameIndex: Boolean = js.native): Unit

Sets this animations playback to a given frame with the given ID.
Sets this animations playback to a given frame with the given ID.
frameId
The identifier of the frame to set. Can be the name of the frame, the sprite index of the frame, or the animation-local frame index.
useLocalFrameIndex
If you provide a number for frameId, should it use the numeric indexes of the frameData, or the 0-indexed frame index local to the animation.
var speed: Double

Gets or sets the current speed of the animation in frames per second.
Gets or sets the current speed of the animation in frames per second. Changing this in a playing animation will take effect from the next frame. Value must be greater than 0.
def stop(resetFrame: Boolean = js.native, dispatchComplete: Boolean = js.native): Unit

Stops playback of this animation and set it to a finished state.
Stops playback of this animation and set it to a finished state. If a resetFrame is provided it will stop playback and set frame to the first in the animation. If dispatchComplete is true it will dispatch the complete events, otherwise they'll be ignored.
resetFrame
If true after the animation stops the currentFrame value will be set to the first frame in this animation.
dispatchComplete
Dispatch the Animation.onComplete and parent.onAnimationComplete events?
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
def update(): Unit

Updates this animation.
Updates this animation. Called automatically by the AnimationManager.
def updateFrameData(frameData: Phaser.FrameData): Unit

Changes the FrameData object this Animation is using.
Changes the FrameData object this Animation is using.
frameData
The FrameData object that contains all frames used by this Animation.
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Animation | package phaser

class Animation extends Object

Instance Constructors

new Animation(game: Phaser.Game, parent: Phaser.Sprite, name: String, frameData: Phaser.FrameData, frames: Array[|[JsNumber, String]], frameRate: Double = js.native, loop: Boolean = js.native)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def complete(): Unit

var currentFrame: Phaser.Frame

var delay: Double

def destroy(): Unit

var enableUpdate: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

var frame: Int

var frameData: Phaser.FrameData

var frameRate: Double

def frameTotal: Int

var frames: Array[|[JsNumber, String]]

var game: Phaser.Game

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

var isFinished: Boolean

final def isInstanceOf[T0]: Boolean

var isPaused: Boolean

var isPlaying: Boolean

def isPrototypeOf(v: Object): Boolean

var isReversed: Boolean

var killOnComplete: Boolean

var loop: Boolean

var loopCount: Int

var name: String

final def ne(arg0: AnyRef): Boolean

def next(quantity: Int = js.native): Unit

final def notify(): Unit

final def notifyAll(): Unit

var onComplete: Phaser.Signal

var onLoop: Phaser.Signal

def onPause(): Unit

def onResume(): Unit

var onUpdate: Phaser.Signal

var parent: Phaser.Sprite

var paused: Boolean

def play(frameRate: Double = js.native, loop: Boolean = js.native, killOnComplete: Boolean = js.native): Animation.this.type

def previous(quantity: Int = js.native): Unit

def propertyIsEnumerable(v: String): Boolean

def restart(): Unit

def reverse(): Animation.this.type

def reverseOnce(): Animation.this.type

var reversed: Boolean

def setFrame(frameId: |[JsNumber, String] = js.native, useLocalFrameIndex: Boolean = js.native): Unit

var speed: Double

def stop(resetFrame: Boolean = js.native, dispatchComplete: Boolean = js.native): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toLocaleString(): String

def toString(): String

def update(): Unit

def updateFrameData(frameData: Phaser.FrameData): Unit

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped