dragonBones.Animation

包 dragonBones

类 public class Animation

继承 dragonBones.Animation → dragonBones.BaseObject

动画播放器用来播放动画数据和管理动画状态。

公共属性

属性
animationConfig : dragonBones.AnimationConfig - 一个可以快速使用的动画配置实例
animationNames : ReadonlyArray<string> - 所有动画数据的名称
animations : Map<dragonBones.AnimationData> - 所有的动画数据
isCompleted : boolean - 检查是否所有的动画状态均已播放完毕
isPlaying : boolean - 检查是否有动画状态正在播放
lastAnimationName : string - 上一个播放的动画状态名称
lastAnimationState : dragonBones.AnimationState
timeScale : number - 所有动画的播放速度

公共方法

方法
fadeIn(animationName:string,fadeInTime:number,playTimes:number,layer:number,group:string
getState(animationName:string,layer:number):dragonBones.AnimationState
getStates():ReadonlyArray<dragonBones.AnimationState> - 获取所有的动画状态
gotoAndPlayByFrame(animationName:string,frame:number,playTimes:number):dragonBones.AnimationState
gotoAndPlayByProgress(animationName:string,progress:number,playTimes:number):dragonBones.AnimationState
gotoAndPlayByTime(animationName:string,time:number,playTimes:number):dragonBones.AnimationState
gotoAndStopByFrame(animationName:string,frame:number):dragonBones.AnimationState
gotoAndStopByProgress(animationName:string,progress:number):dragonBones.AnimationState
gotoAndStopByTime(animationName:string,time:number):dragonBones.AnimationState
hasAnimation(animationName:string):boolean - 检查是否包含指定的动画数据
play(animationName:string
playConfig(animationConfig:dragonBones.AnimationConfig):dragonBones.AnimationState
reset():void - 清除所有的动画状态
stop(animationName:string
toString():string [静态]

属性详细信息

animationConfig

animationConfig : dragonBones.AnimationConfig

支持版本:DragonBones 5.0
运行平台:Web,Native
一个可以快速使用的动画配置实例。

animationNames

animationNames : ReadonlyArray<string>

支持版本:DragonBones 4.5
运行平台:Web,Native
所有动画数据的名称

animations

animations : Map<dragonBones.AnimationData>

支持版本:DragonBones 4.5
运行平台:Web,Native
所有的动画数据。

isCompleted

isCompleted : boolean

支持版本:DragonBones 3.0
运行平台:Web,Native
检查是否所有的动画状态均已播放完毕。

isPlaying

isPlaying : boolean

支持版本:DragonBones 3.0
运行平台:Web,Native
检查是否有动画状态正在播放

lastAnimationName

lastAnimationName : string

支持版本:DragonBones 3.0
运行平台:Web,Native
上一个播放的动画状态名称

lastAnimationState

lastAnimationState : dragonBones.AnimationState|null

支持版本:DragonBones 3.0
运行平台:Web,Native
上一个播放的动画状态

timeScale

timeScale : number = 1.0

支持版本:DragonBones 3.0
运行平台:Web,Native
所有动画的播放速度。 [0: 停止播放, (0~1): 慢速播放, 1: 正常播放, (1~N): 快速播放]

方法详细信息

fadeIn()

public fadeIn(animationName:string,fadeInTime:number,playTimes:number,layer:number,group:string|null,fadeOutMode:dragonBones.AnimationFadeOutMode):dragonBones.AnimationState|null

淡入播放指定的动画。
支持版本:DragonBones 4.5
运行平台:Web,Native
参数
- animationName:string - - 动画数据名称。
- fadeInTime:number - - 淡入时间。 [-1: 使用动画数据默认值, [0~N]: 淡入时间 (以秒为单位)] （默认: -1）
- playTimes:number - - 播放次数。 [-1: 使用动画数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次] （默认: -1）
- layer:number - - 混合图层，图层高的动画状态会优先获取混合权重，当混合权重分配总和超过 1.0 时，剩余的动画状态将不能再获得权重分配。（默认: 0）
- group:string|null - - 混合组名称，该属性通常用来指定多个动画状态混合时的相互替换关系。（默认: null）
- fadeOutMode:dragonBones.AnimationFadeOutMode - - 淡出模式，该属性通常用来指定多个动画状态混合时的相互替换模式。（默认: AnimationFadeOutMode.SameLayerAndGroup）
返回:播放的动画状态。

//Example:
 armature.animation.fadeIn("walk",  0.3,  0,  0,  "normalGroup").resetToPose  =  false;
 armature.animation.fadeIn("attack",  0.3,  1,  0,  "attackGroup").resetToPose  =  false;

getState()

public getState(animationName:string,layer:number):dragonBones.AnimationState|null

获取指定的动画状态。
支持版本:DragonBones 3.0
运行平台:Web,Native
参数
- animationName:string - - 动画状态名称。
- layer:number - - 查找动画状态的层级。 [-1: 查找所有层级, [0~N]: 指定层级] （默认: -1）

    //Example:
    armature.animation.play("walk");
    let walkState = armature.animation.getState("walk");
    walkState.timeScale  =  0.5;

getStates()

public getStates():ReadonlyArray<dragonBones.AnimationState>

获取所有的动画状态
支持版本:DragonBones 5.1
运行平台:Web,Native

gotoAndPlayByFrame()

public gotoAndPlayByFrame(animationName:string,frame:number,playTimes:number):dragonBones.AnimationState|null

从指定帧开始播放指定的动画。
支持版本:DragonBones 4.5
运行平台:Web,Native
参数
- animationName:string - - 动画数据名称。
- frame:number - - 播放开始的帧数。
- playTimes:number - - 播放次数。 [-1: 使用动画数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次] （默认: -1）
返回:播放的动画状态。

gotoAndPlayByProgress()

public gotoAndPlayByProgress(animationName:string,progress:number,playTimes:number):dragonBones.AnimationState|null

从指定进度开始播放指定的动画。
支持版本:DragonBones 4.5
运行平台:Web,Native
参数
- animationName:string - - 动画数据名称。
- progress:number - - 开始播放的进度。
- playTimes:number - - 播放次数。 [-1: 使用动画数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次] （默认: -1）
返回:播放的动画状态。

gotoAndPlayByTime()

public gotoAndPlayByTime(animationName:string,time:number,playTimes:number):dragonBones.AnimationState|null

从指定时间开始播放指定的动画。
支持版本:DragonBones 4.5
运行平台:Web,Native
参数
- animationName:string - - 动画数据名称。
- time:number - - 播放开始的时间。 (以秒为单位)
- playTimes:number - - 循环播放次数。 [-1: 使用动画数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次] （默认: -1）
返回:播放的动画状态。

gotoAndStopByFrame()

public gotoAndStopByFrame(animationName:string,frame:number):dragonBones.AnimationState|null

在指定帧停止指定动画的播放
支持版本:DragonBones 4.5
运行平台:Web,Native
参数
- animationName:string - - 动画数据名称。
- frame:number - - 停止的帧数。
返回:播放的动画状态。

gotoAndStopByProgress()

public gotoAndStopByProgress(animationName:string,progress:number):dragonBones.AnimationState|null

在指定的进度停止指定的动画播放。
支持版本:DragonBones 4.5
运行平台:Web,Native
参数
- animationName:string - - 动画数据名称。
- progress:number - - 停止进度。
返回:播放的动画状态。

gotoAndStopByTime()

public gotoAndStopByTime(animationName:string,time:number):dragonBones.AnimationState|null

在指定时间停止指定动画播放
支持版本:DragonBones 4.5
运行平台:Web,Native
参数
- animationName:string - - 动画数据名称。
- time:number - - 停止的时间。 (以秒为单位)
返回:播放的动画状态。

hasAnimation()

public hasAnimation(animationName:string):boolean

检查是否包含指定的动画数据
支持版本:DragonBones 3.0
运行平台:Web,Native
参数
- animationName:string - - 动画数据名称。

play()

public play(animationName:string|null,playTimes:number):dragonBones.AnimationState|null

播放指定动画。
支持版本:DragonBones 3.0
运行平台:Web,Native
参数
- animationName:string|null - - 动画数据名称。（如果未设置，则播放默认动画，或将暂停状态切换为播放状态，或重新播放之前播放的动画）
- playTimes:number - - 循环播放次数。 [-1: 使用动画数据默认值, 0: 无限循环播放, [1~N]: 循环播放 N 次] （默认: -1）
返回:播放的动画状态。

//Example:
 armature.animation.play("walk");

playConfig()

public playConfig(animationConfig:dragonBones.AnimationConfig):dragonBones.AnimationState|null

通过指定的动画配置来播放动画。该 API 仍在实验阶段，使用时可能遭遇 bug 或稳定性或兼容性问题。
支持版本:DragonBones 5.0
运行平台:Web,Native
参数
- animationConfig:dragonBones.AnimationConfig - - 动画配置。
返回:播放的动画状态。

reset()

public reset():void

清除所有的动画状态。
支持版本:DragonBones 4.5
运行平台:Web,Native

stop()

public stop(animationName:string|null):void

暂停指定动画状态的播放。
支持版本:DragonBones 3.0
运行平台:Web,Native
参数
- animationName:string|null - - 动画状态名称。（如果未设置，则暂停所有动画）

toString()

public toString():string

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

dragonBones.Animation

公共属性​

公共方法​

属性详细信息​

animationConfig​

animationNames​

animations​

isCompleted​

isPlaying​

lastAnimationName​

lastAnimationState​

timeScale​

方法详细信息​

fadeIn()​

getState()​

getStates()​

gotoAndPlayByFrame()​

gotoAndPlayByProgress()​

gotoAndPlayByTime()​

gotoAndStopByFrame()​

gotoAndStopByProgress()​

gotoAndStopByTime()​

hasAnimation()​

play()​

playConfig()​

reset()​

stop()​

toString()​