PackagedragonBones.events
Classpublic class FrameEvent
InheritanceFrameEvent Inheritance flash.events.Event

The FrameEvent class provides and defines all events dispatched by an Animation or Bone instance entering a new frame.

See also

dragonBones.animation.Animation


Public Properties
 PropertyDefined By
  armature : Armature
[read-only] The armature that is the target of this event.
FrameEvent
  bone : Bone
[read-only] The bone that is the target of this event.
FrameEvent
  frameLabel : String
The entered frame label.
FrameEvent
  movementID : String
The id of the MovementData instance.
FrameEvent
Public Methods
 MethodDefined By
  
FrameEvent(type:String, cancelable:Boolean = false, bone:Bone = null)
Creates a new FrameEvent instance.
FrameEvent
Public Constants
 ConstantDefined By
  BONE_FRAME_EVENT : String = boneFrameEvent
[static] Dispatched when a bone of the armature enter a frame.
FrameEvent
  MOVEMENT_FRAME_EVENT : String = movementFrameEvent
[static] Dispatched when the animation of the armatrue enter a frame.
FrameEvent
Property Detail
armatureproperty
armature:Armature  [read-only]

The armature that is the target of this event.


Implementation
    public function get armature():Armature
boneproperty 
bone:Bone  [read-only]

The bone that is the target of this event.


Implementation
    public function get bone():Bone
frameLabelproperty 
public var frameLabel:String

The entered frame label.

movementIDproperty 
public var movementID:String

The id of the MovementData instance.

Constructor Detail
FrameEvent()Constructor
public function FrameEvent(type:String, cancelable:Boolean = false, bone:Bone = null)

Creates a new FrameEvent instance.

Parameters
type:String
 
cancelable:Boolean (default = false)
 
bone:Bone (default = null)
Constant Detail
BONE_FRAME_EVENTConstant
public static const BONE_FRAME_EVENT:String = boneFrameEvent

Dispatched when a bone of the armature enter a frame.

MOVEMENT_FRAME_EVENTConstant 
public static const MOVEMENT_FRAME_EVENT:String = movementFrameEvent

Dispatched when the animation of the armatrue enter a frame.