AnimationManager

Instance Constructors

new AnimationManager(sprite: Phaser.Sprite)

sprite
A reference to the Game Object that owns this AnimationManager.

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
def add(name: String, frames: Array[|[JsNumber, String]] = js.native, frameRate: Double = js.native, loop: Boolean = js.native, useNumericIndex: Boolean = js.native): Animation

Adds a new animation under the given key.
Adds a new animation under the given key. Optionally set the frames, frame rate and loop. Animations added in this way are played back with the play function.
name
The unique (within this Sprite) name for the animation, i.e. "run", "fire", "walk".
frames
An array of numbers/strings that correspond to the frames to add to this animation and in which order. e.g. [1, 2, 3] or ['run0', 'run1', run2]). If null then all frames will be used.
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.
useNumericIndex
Are the given frames using numeric indexes (default) or strings?
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
var currentAnim: Phaser.Animation

The currently displayed animation, if any.
var currentFrame: Phaser.Frame

The currently displayed Frame of animation, if any.
The currently displayed Frame of animation, if any. This property is only set once an Animation starts playing. Until that point it remains set as null.
def destroy(): Unit

Destroys all references this AnimationManager contains.
Destroys all references this AnimationManager contains. Iterates through the list of animations stored in this manager and calls destroy on each of them.
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.
def frameData: Phaser.FrameData

The current animations FrameData
var frameName: String

Gets or sets the current frame name and updates the Texture Cache for display.
def frameTotal: Int

The total number of frames in the currently loaded FrameData, or -1 if no FrameData is loaded.
var game: Phaser.Game

A reference to the currently running Game.
def getAnimation(name: String): Phaser.Animation

Returns an animation that was previously added by name.
Returns an animation that was previously added by name.
name
The name of the animation to be returned, e.g. "fire".
returns
The Animation instance, if found, otherwise null.
final def getClass(): Class[_]

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

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
var isLoaded: Boolean

Set to true once animation data has been loaded.
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
var name: String

Gets the current animation name, if set.
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 current animation, taking the loop value into consideration.
Advances by the given number of frames in the current 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 paused: Boolean

Gets and sets the paused state of the current animation.
def play(name: String, frameRate: Double = js.native, loop: Boolean = js.native, killOnComplete: Boolean = js.native): Phaser.Animation

Play an animation based on the given key.
Play an animation based on the given key. The animation should previously have been added via animations.add If the requested animation is already playing this request will be ignored. If you need to reset an already running animation do so directly on the Animation object itself.
name
The name of the animation to be played, e.g. "fire", "walk", "jump".
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 playing Animation instance.
def previous(quantity: Int = js.native): Unit

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

Definition Classes
Object
def refreshFrame(): Unit

Refreshes the current frame data back to the parent Sprite and also resets the texture data.
def stop(name: String = js.native, resetFrame: Boolean = js.native): Unit

Stop playback of an animation.
Stop playback of an animation. If a name is given that specific animation is stopped, otherwise the current animation is stopped.
The currentAnim property of the AnimationManager is automatically set to the animation given.
name
The name of the animation to be stopped, e.g. "fire". If none is given the currently running animation is stopped.
resetFrame
When the animation is stopped should the currentFrame be set to the first frame of the animation (true) or paused on the last frame displayed (false)
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
var updateIfVisible: Boolean

Should the animation data continue to update even if the Sprite.visible is set to false.
def validateFrames(frames: Array[_], useNumericIndex: Boolean = js.native): Boolean

frames
An array of frames to be validated.
useNumericIndex
Validate the frames based on their numeric index (true) or string index (false)
returns
True if all given Frames are valid, otherwise false.
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 Doc: package phaser

class AnimationManager extends Object

Instance Constructors

new AnimationManager(sprite: Phaser.Sprite)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def add(name: String, frames: Array[|[JsNumber, String]] = js.native, frameRate: Double = js.native, loop: Boolean = js.native, useNumericIndex: Boolean = js.native): Animation

final def asInstanceOf[T0]: T0

def clone(): AnyRef

var currentAnim: Phaser.Animation

var currentFrame: Phaser.Frame

def destroy(): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

var frame: Int

def frameData: Phaser.FrameData

var frameName: String

def frameTotal: Int

var game: Phaser.Game

def getAnimation(name: String): Phaser.Animation

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

var isLoaded: Boolean

def isPrototypeOf(v: Object): Boolean

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 paused: Boolean

def play(name: String, frameRate: Double = js.native, loop: Boolean = js.native, killOnComplete: Boolean = js.native): Phaser.Animation

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

def propertyIsEnumerable(v: String): Boolean

def refreshFrame(): Unit

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

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

def toLocaleString(): String

def toString(): String

var updateIfVisible: Boolean

def validateFrames(frames: Array[_], useNumericIndex: Boolean = js.native): Boolean

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