API / AnimationConfig

类: AnimationConfig

定义于: model/AnimationConfig.ts:37

Beta

动画配置用来描述播放一个动画状态所需要的全部信息。 该 API 仍在实验阶段，使用时可能遭遇 bug 或稳定性或兼容性问题。

继承

• BaseObject

构造函数

构造函数

new AnimationConfig(): AnimationConfig;

Beta

返回

AnimationConfig

继承自

BaseObject.constructor

属性

animation

animation: string;

定义于: model/AnimationConfig.ts:204

Beta

动画数据名称。

---

autoFadeOutTime

autoFadeOutTime: number;

定义于: model/AnimationConfig.ts:188

Beta

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

默认值

-1.0

---

displayControl

displayControl: boolean;

定义于: model/AnimationConfig.ts:88

Beta

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

默认值

true

---

duration

duration: number;

定义于: model/AnimationConfig.ts:144

Beta

播放的持续时间。 [-1: 使用动画数据默认值, 0: 动画停止, (0~N]: 持续时间] （以秒为单位）

默认值

-1.0

---

fadeInTime

fadeInTime: number;

定义于: model/AnimationConfig.ts:177

Beta

淡入时间。 [-1: 使用动画数据默认值, [0~N]: 淡入时间] （以秒为单位）

默认值

-1.0

---

fadeOutMode

fadeOutMode: AnimationFadeOutMode;

定义于: model/AnimationConfig.ts:55

Beta

淡入动画状态时淡出其他动画状态的模式。 该属性通常用来指定多个动画状态混合时的相互替换关系。

默认值

AnimationFadeOutMode.All

---

group

readonly group: string;

定义于: model/AnimationConfig.ts:215

Beta

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

---

hashCode

readonly hashCode: number;

定义于: core/BaseObject.ts:156

Beta

分配给此实例的唯一标识号。

继承自

BaseObject.hashCode

---

layer

readonly layer: number;

定义于: model/AnimationConfig.ts:124

Beta

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

---

name

name: string;

定义于: model/AnimationConfig.ts:196

Beta

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

---

playTimes

playTimes: number;

定义于: model/AnimationConfig.ts:111

Beta

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

---

position

position: number;

定义于: model/AnimationConfig.ts:133

Beta

播放的开始时间。 （以秒为单位）

默认值

0.0

---

resetToPose

resetToPose: boolean;

定义于: model/AnimationConfig.ts:99

Beta

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

默认值

true

---

timeScale

timeScale: number;

定义于: model/AnimationConfig.ts:157

Beta

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

默认值

1.0

---

weight

weight: number;

定义于: model/AnimationConfig.ts:166

Beta

混合权重。

默认值

1.0

方法

returnToPool()

returnToPool(): void;

定义于: core/BaseObject.ts:167

Beta

返回

void

继承自

BaseObject.returnToPool

---

borrowObject()

static borrowObject<T>(objectConstructor: () => T): T;

定义于: core/BaseObject.ts:136

Beta

类型参数

类型参数
T extends BaseObject

参数

参数	类型	描述
objectConstructor	() => T	特定的类。

返回

T

继承自

BaseObject.borrowObject

---

clearPool()

static clearPool(objectConstructor: typeof BaseObject): void;

定义于: core/BaseObject.ts:111

Beta

参数

参数	类型	默认值	描述
objectConstructor	typeof BaseObject	null	特定的类。 (不设置则清除所有缓存的实例)

返回

void

继承自

BaseObject.clearPool

---

setMaxCount()

static setMaxCount(objectConstructor: typeof BaseObject, maxCount: number): void;

定义于: core/BaseObject.ts:72

Beta

参数

参数	类型	描述
objectConstructor	typeof BaseObject	特定的类。 (不设置则设置所有对象池的最大缓存数量)
maxCount	number	最大缓存数量。

返回

void

继承自

BaseObject.setMaxCount

---

toString()

static toString(): string;

定义于: model/AnimationConfig.ts:38

Beta

返回

string

重写了

BaseObject.toString