Module flower.MovieClip

Class for animated texture atlases ('MovieClip' is the Adobe Flash terminology)

Extends:

See:

Info:

  • Release: V3.0.0
  • Author: Makoto

Functions

MovieClip:init (texture, sizeX, sizeY, spacing, margin, flipX, flipY) Constructor.
MovieClip:setAnim (name, anim) Sets the custom animation.
MovieClip:setAnimData (name, data) Sets the animation data.
MovieClip:setAnimDatas (datas) Sets multiple animation data up at the same time (convenience function).
MovieClip:playAnim (name) Start the animation.
MovieClip:stopAnim () Stop the animation.
MovieClip:isCurrentAnim (name) Check the current animation with the specified name.
MovieClip:isBusy () Returns whether the running.


Functions

MovieClip:init (texture, sizeX, sizeY, spacing, margin, flipX, flipY)
Constructor.

Parameters:

  • texture Texture path, or texture
  • sizeX (option) The size of the sheet
  • sizeY (option) The size of the sheet
  • spacing (option)Spacing of the tiles
  • margin (option)Margin of the sheet
  • flipX (option)flipX
  • flipY (option)flipY
MovieClip:setAnim (name, anim)
Sets the custom animation.

Parameters:

  • name Name of anim
  • anim Anim object
MovieClip:setAnimData (name, data)
Sets the animation data. The frame is interpolated from the data.

Parameters:

  • name Name of anim
  • data Animation data
MovieClip:setAnimDatas (datas)
Sets multiple animation data up at the same time (convenience function).

Parameters:

  • datas Multiple data
MovieClip:playAnim (name)
Start the animation.

Parameters:

  • name Name of anim
MovieClip:stopAnim ()
Stop the animation.
MovieClip:isCurrentAnim (name)
Check the current animation with the specified name.

Parameters:

  • name Animation name.

Returns:

    If the current animation is true.
MovieClip:isBusy ()
Returns whether the running.

Returns:

    True if busy
generated by LDoc 1.3