View source

class SpriteMessages

package defold

import defold.Sprite

@:publicFields
  • Messages related to the Sprite module.

Static variables

@:value(new Message<SpriteMessageAnimationDone>("animation_done"))staticread onlyanimation_done:Message<SpriteMessageAnimationDone> = new Message<SpriteMessageAnimationDone>("animation_done")

  • Reports that an animation has completed.

This message is sent to the sender of a play_animation message when the animation has completed.

Note that this message is sent only for animations that play with the following playback modes:

	* Once Forward
	* Once Backward
	* Once Ping Pong

See play_animation for more information and examples of how to use this message.

@:value(new Message<SpriteMessagePlayAnimation>("play_animation"))staticread onlyplay_animation:Message<SpriteMessagePlayAnimation> = new Message<SpriteMessagePlayAnimation>("play_animation")

  • Plays a sprite animation.

Post this message to a sprite-component to make it play an animation from its tile set.