跳到主要内容

dragonBones.AnimationState

包    dragonBones

类    public class AnimationState

继承    dragonBones.AnimationState → dragonBones.BaseObject

  • 动画状态由播放动画数据时产生。

公共属性​

属性
animationData : dragonBones.AnimationData
- 动画数据
autoFadeOutTime : number
- 动画状态播放完成后的自动淡出时间
currentPlayTimes : number
- 已经循环播放的次数
currentTime : number
- 当前播放的时间
displayControl : boolean
- 动画状态是否对插槽的显示对象属性有控制权
group : string
- 混合组名称
isCompleted : boolean
- 是否播放完毕
isFadeComplete : boolean
- 是否淡入或淡出完毕
isFadeIn : boolean
- 是否正在淡入
isFadeOut : boolean
- 是否正在淡出
isPlaying : boolean
- 是否正在播放
layer : number
- 混合图层
name : string
- 动画状态名称
playTimes : number
- 播放次数
resetToPose : boolean
- 开始播放动画状态时是否将没有动画的对象重置为骨架初始值
timeScale : number
- 播放速度
totalTime : number
- 总播放时间
weight : number
- 混合权重

公共方法​

方法
addBoneMask(boneName:string,recursive:boolean):void
- 添加特定的骨骼遮罩
containsBoneMask(boneName:string):boolean
- 检查是否包含特定骨骼遮罩
fadeOut(fadeOutTime:number,pausePlayhead:boolean):void
- 淡出动画状态
play():void
- 继续播放
removeAllBoneMask():void
- 删除所有骨骼遮罩
removeBoneMask(boneName:string,recursive:boolean):void
- 删除特定骨骼的遮罩
stop():void
- 暂停播放
toString():string
[静态]

属性详细信息​

animationData​

animationData : dragonBones.AnimationData

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 动画数据。

autoFadeOutTime​

autoFadeOutTime : number = -1.0

  • 支持版本:DragonBones 5.0

  • 运行平台:Web,Native

  • 动画状态播放完成后的自动淡出时间。[-1: 不自动淡出, [0~N]: 淡出时间] （以秒为单位）

currentPlayTimes​

currentPlayTimes : number

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 已经循环播放的次数。

currentTime​

currentTime : number

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 当前播放的时间。 （以秒为单位）

displayControl​

displayControl : boolean = true

  • 支持版本:DragonBones 5.0

  • 运行平台:Web,Native

  • 动画状态是否对插槽的显示对象属性有控制权。有时混合一个动画状态并不希望其控制插槽的显示对象属性，尤其是其他动画状态正在控制这些插槽的显示对象属性时。

group​

group : string

  • 支持版本:DragonBones 5.0

  • 运行平台:Web,Native

  • 混合组名称。该属性通常用来指定多个动画状态混合时的相互替换关系。

isCompleted​

isCompleted : boolean

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 是否播放完毕。

isFadeComplete​

isFadeComplete : boolean

  • 支持版本:DragonBones 5.1

  • 运行平台:Web,Native

  • 是否淡入或淡出完毕。

isFadeIn​

isFadeIn : boolean

  • 支持版本:DragonBones 5.1

  • 运行平台:Web,Native

  • 是否正在淡入。

isFadeOut​

isFadeOut : boolean

  • 支持版本:DragonBones 5.1

  • 运行平台:Web,Native

  • 是否正在淡出。

isPlaying​

isPlaying : boolean

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 是否正在播放。

layer​

layer : number

  • 支持版本:DragonBones 5.0

  • 运行平台:Web,Native

  • 混合图层。图层高的动画状态会优先获取混合权重。当混合权重分配超过 1 时，剩余的动画状态将不再获得权重分配。

name​

name : string

  • 支持版本:DragonBones 5.0

  • 运行平台:Web,Native

  • 动画状态名称。 （可以不同于动画数据）

playTimes​

playTimes : number

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 播放次数。 [0: 无限循环播放, [1~N]: 循环播放 N 次]

resetToPose​

resetToPose : boolean = true

  • 支持版本:DragonBones 5.1

  • 运行平台:Web,Native

  • 开始播放动画状态时是否将没有动画的对象重置为骨架初始值。通常在混合多个动画状态时应该将该属性设置为 false。

timeScale​

timeScale : number = 1.0

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 播放速度。该值与 {@link dragonBones.Animation#timeScale} 是叠加关系。[(-N~0): 倒转播放, 0: 停止播放, (0~1): 慢速播放, 1: 正常播放, (1~N): 快速播放]

totalTime​

totalTime : number

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 总播放时间。 （以秒为单位）

weight​

weight : number = 1.0

  • 支持版本:DragonBones 5.0

  • 运行平台:Web,Native

  • 混合权重。

方法详细信息​

addBoneMask()​

public addBoneMask(boneName:string,recursive:boolean):void

  • 添加特定的骨骼遮罩。

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 参数

    • boneName:string - - 骨骼名称。
    • recursive:boolean - - 是否为该骨骼的子骨骼添加遮罩。

containsBoneMask()​

public containsBoneMask(boneName:string):boolean

  • 检查是否包含特定骨骼遮罩。

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 参数

    • boneName:string - - 骨骼名称。

fadeOut()​

public fadeOut(fadeOutTime:number,pausePlayhead:boolean):void

  • 淡出动画状态。

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 参数

    • fadeOutTime:number - - 淡出时间。 （以秒为单位）
    • pausePlayhead:boolean - - 淡出时是否暂停播放。

play()​

public play():void

  • 继续播放。

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

removeAllBoneMask()​

public removeAllBoneMask():void

  • 删除所有骨骼遮罩。

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

removeBoneMask()​

public removeBoneMask(boneName:string,recursive:boolean):void

  • 删除特定骨骼的遮罩。

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

  • 参数

    • boneName:string - - 骨骼名称。
    • recursive:boolean - - 是否删除该骨骼的子骨骼遮罩。

stop()​

public stop():void

  • 暂停播放。

  • 支持版本:DragonBones 3.0

  • 运行平台:Web,Native

toString()​

public toString():string

  • 支持版本:all
  • 运行平台:Web,Native