Class

io.scalajs.dom.html.phaser

FrameData

Related Doc: package phaser

Permalink

class FrameData extends Object

FrameData is a container for Frame objects, which are the internal representation of animation data in Phaser.

Annotations
@RawJSType() @native() @JSName( "Phaser.FrameData" )
See also

https://phaser.io/docs/2.6.2/Phaser.FrameData.html

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FrameData
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FrameData()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addFrame(frame: Phaser.Frame): Phaser.Frame

    Permalink

    Adds a new Frame to this FrameData collection.

    Adds a new Frame to this FrameData collection. Typically called by the Animation.Parser and not directly.

    frame

    The frame to add to this FrameData set.

    returns

    The frame that was just added.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def checkFrameName(name: String): Boolean

    Permalink

    Check if there is a Frame with the given name.

    Check if there is a Frame with the given name.

    name

    The name of the frame you want to check.

    returns

    True if the frame is found, otherwise false.

  7. def clone(): FrameData.this.type

    Permalink

    Makes a copy of this FrameData including copies (not references) to all of the Frames it contains.

    Makes a copy of this FrameData including copies (not references) to all of the Frames it contains.

    returns

    A clone of this object, including clones of the Frame objects it contains.

    Definition Classes
    FrameData → AnyRef
  8. def destroy(): Unit

    Permalink

    Destroys this FrameData collection by nulling the _frames and _frameNames arrays.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getFrame(index: Int): Phaser.Frame

    Permalink

    Get a Frame by its numerical index.

    Get a Frame by its numerical index.

    index

    The index of the frame you want to get.

    returns

    The frame, if found.

  14. def getFrameByName(name: String): Phaser.Frame

    Permalink

    Get a Frame by its frame name.

    Get a Frame by its frame name.

    name

    The name of the frame you want to get.

    returns

    The frame, if found.

  15. def getFrameIndexes(frames: Array[Int] = js.native, useNumericIndex: Boolean = js.native, output: Array[Int] = js.native): Array[Int]

    Permalink

    Returns all of the Frame indexes in this FrameData set.

    Returns all of the Frame indexes in this FrameData set. The frames indexes are returned in the output array, or if none is provided in a new Array object.

    frames

    An Array containing the indexes of the frames to retrieve. If undefined or the array is empty then all frames in the FrameData are returned.

    useNumericIndex

    Are the given frames using numeric indexes (default) or strings? (false)

    output

    If given the results will be appended to the end of this array otherwise a new array will be created.

    returns

    An array of all Frame indexes matching the given names or IDs.

  16. def getFrameRange(start: Int, end: Int, output: Array[Phaser.Frame] = js.native): Array[Phaser.Frame]

    Permalink

    Returns a range of frames based on the given start and end frame indexes and returns them in an Array.

    Returns a range of frames based on the given start and end frame indexes and returns them in an Array.

    start

    The starting frame index.

    end

    The ending frame index.

    output

    If given the results will be appended to the end of this array otherwise a new array will be created.

    returns

    An array of Frames between the start and end index values, or an empty array if none were found.

  17. def getFrames(frames: Array[Int] = js.native, useNumericIndex: Boolean = js.native, output: Array[Frame] = js.native): Array[Frame]

    Permalink

    Returns all of the Frames in this FrameData set where the frame index is found in the input array.

    Returns all of the Frames in this FrameData set where the frame index is found in the input array. The frames are returned in the output array, or if none is provided in a new Array object.

    frames

    An Array containing the indexes of the frames to retrieve. If the array is empty or undefined then all frames in the FrameData are returned.

    useNumericIndex

    Are the given frames using numeric indexes (default) or strings? (false)

    output

    If given the results will be appended to the end of this array otherwise a new array will be created.

    returns

    An array of all Frames in this FrameData set matching the given names or IDs.

  18. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  19. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  21. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. def total: Int

    Permalink

    The total number of frames in this FrameData set.

  30. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  31. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped