Class: Phaser::Animation

Inherits:

Object

• Object
• Phaser::Animation

Includes:

Native

Defined in:

lib/opal/phaser/core/animation.rb

Overview

An Animation instance contains a single animation and the controls to play it. It is created by the AnimationManager, consists of Animation.Frame objects and belongs to a single Game Object such as a Sprite.

See Also:

• http://docs.phaser.io/Phaser.Animation.html

Instance Attribute Summary

• #native ⇒ Object

  Returns the value of attribute native.

Instance Method Summary

• #initialize(game, parent, name, frameData, frames, frameRate = 60, _loop = false) ⇒ Animation constructor

  A new instance of Animation.

Constructor Details

#initialize(game, parent, name, frameData, frames, frameRate = 60, _loop = false) ⇒ Animation

Returns a new instance of Animation.

Parameters:

• game (Phaser.Game) —

  A reference to the currently running game.

• parent (Phaser.Sprite) —

  A reference to the owner of this Animation.

• name (String) —

  The unique name for this animation, used in playback commands.

• frame_data (Phaser.FrameData) —

  The FrameData object that contains all frames used by this Animation.

• frames (Array<Integer>, Array<String>) —

  An array of numbers or strings indicating which frames to play in which order.

• frame_rate (Integer) —

  frameRate=60

  The speed at which the animation should play. The speed is given in frames per second.

• loop (True, False) —

  loop=false

  Whether or not the animation is looped or just plays once.

# File 'lib/opal/phaser/core/animation.rb', line 18

def initialize(game, parent, name, frameData, frames, frameRate = 60, _loop = false)
  @native_game = game
  @native = `new Phaser.Animation(#@native_game, parent, name, frameData, frames, frameRate, _loop)`
end

Instance Attribute Details

#native ⇒ Object

Returns the value of attribute native.

# File 'lib/opal/phaser/core/animation.rb', line 9

def native
  @native
end