Packagecom.pblabs.rendering2D
Classpublic final class AnimationControllerInfo
InheritanceAnimationControllerInfo Inheritance Object

Information describing an animation, for use in an AnimationController.

See also

AnimationController.


Public Properties
 PropertyDefined By
  completeEvent : String
Name of event to fire on the entity when this animation starts.
AnimationControllerInfo
  frameRate : Number = 32
The desired framerate for this animation.
AnimationControllerInfo
  loop : Boolean = true
If true, then the animation loops.
AnimationControllerInfo
  maxFrameDelay : Number = 50
The animation playback speed may be affected by many factors; this sets a maximum time period in ms for a frame to be displayed.
AnimationControllerInfo
  priority : Number = 0.0
Used when setting animation states; a higher priority animation will override a lower priority animation.
AnimationControllerInfo
  spriteSheet : SpriteContainerComponent
Sprite sheet containing this animation.
AnimationControllerInfo
  startEvent : String
Name of event to fire on the entity when this animation starts.
AnimationControllerInfo
Property Detail
completeEventproperty
public var completeEvent:String

Name of event to fire on the entity when this animation starts.

frameRateproperty 
public var frameRate:Number = 32

The desired framerate for this animation. It is overidden by the duration properties on the controller, and maxFrameDelay may interfere with it.

loopproperty 
public var loop:Boolean = true

If true, then the animation loops.

maxFrameDelayproperty 
public var maxFrameDelay:Number = 50

The animation playback speed may be affected by many factors; this sets a maximum time period in ms for a frame to be displayed.

priorityproperty 
public var priority:Number = 0.0

Used when setting animation states; a higher priority animation will override a lower priority animation.

spriteSheetproperty 
public var spriteSheet:SpriteContainerComponent

Sprite sheet containing this animation.

startEventproperty 
public var startEvent:String

Name of event to fire on the entity when this animation starts.