跳到主要内容

Playable

描述:

  用于动画模型系统的接口类。

类对象:Playable Class

继承自:Node

look

类型: 成员变量。

描述:

  动画模型的外观。

签名:

look: string

speed

类型: 成员变量。

描述:

  动画模型的播放速度。

签名:

speed: number

recovery

类型: 成员变量。

描述:

  动画模型恢复时间,以秒为单位。 用于从一个动画过渡到另一个动画。

签名:

recovery: number

fliped

类型: 成员变量。

描述:

  动画模型是否水平翻转。

签名:

fliped: boolean

current

类型: 只读成员变量。

描述:

  当前正在播放的动画名称。

签名:

const current: string

lastCompleted

类型: 只读成员变量。

描述:

  上一次播放完成的动画名称。

签名:

const lastCompleted: string

getKey

类型: 函数。

描述:

  获取模型上的关键点的坐标。 在 Model 动画系统中,关键点是模型上设置的特定点。在 DragonBone 中,关键点是骨骼的位置。在 Spine2D 中,关键点是顶点附件的位置。

签名:

getKey: function(self: Playable, name: string): Vec2

参数:

参数名类型描述
namestring要获取模型上的关键点的名称。

返回值:

返回类型描述
Vec2以二维向量形式返回的关键点的坐标。

play

类型: 函数。

描述:

  播放模型包含的动画。

签名:

play: function(
self: Playable,
name: string,
loop?: boolean --[[false]]
): number

参数:

参数名类型描述
namestring要播放的动画的名称。
loopboolean[可选] 是否循环播放动画(默认为 false)。

返回值:

返回类型描述
number动画的持续时间,以秒为单位。

stop

类型: 函数。

描述:

  停止当前正在播放的动画。

签名:

stop: function(self: Playable)

setSlot

类型: 函数。

描述:

  将一个子节点添加到动画模型上的插槽。

签名:

setSlot: function(self: Playable, name: string, item: Node)

参数:

参数名类型描述
namestring要设置的插槽的名称。
itemNode要在插槽上添加的节点。

getSlot

类型: 函数。

描述:

  获取添加到动画模型插槽上的子节点。

签名:

getSlot: function(self: Playable, name: string): Node | nil

参数:

参数名类型描述
namestring要获取的插槽的名称。

返回值:

返回类型描述
Node|nil插槽中的节点,如果插槽中没有节点,则返回 nil。

onAnimationEnd

类型: 函数。

描述:

  注册一个回调函数,当动画播放结束时触发。

签名:

onAnimationEnd: function(self: Playable, callback: function(animationName: string, target: Playable))

参数:

参数名类型描述
callbackfunction动画播放结束时的回调函数。