类 Animator

En

The Animator class is used to create 3D animation components.

Zh

Animator 类用于创建3D动画组件。

层级 (查看层级一览)

Component
- Animator

属性

_extra

_extra: IComponentExtra

En

Extra data of the node.

Zh

组件的额外数据。IDE内部使用。

_id

_id: number

En

Unique identifier for the component.

Zh

组件的唯一标识。

_singleton

_singleton: boolean

En

Whether the component is a singleton, meaning only one instance of this type of script can be added to the same node.

Zh

是否为单例，即同一个节点只能添加此类型的脚本一次。

cullingMode

cullingMode: number = Animator.CULLINGMODE_CULLCOMPLETELY

En

Culling mode，By default, when set to invisible, the animation will not play at all.

Zh

裁剪模式,默认为不可见时完全不播放动画。

owner

owner: Node

En

Gets the owner Node to which the component belongs.

Zh

获取组件所属的 Node 节点。

runInEditor

runInEditor: boolean

En

Whether the script can run in the IDE environment.

Zh

是否可以在 IDE 环境中运行。

scriptPath

scriptPath: string

En

The path of the script file.

Zh

脚本文件的路径。

`静态`CULLINGMODE_ALWAYSANIMATE

CULLINGMODE_ALWAYSANIMATE: number = 0

En

Culling mode: Always animate.

Zh

裁剪模式：始终播放动画。

`静态`CULLINGMODE_CULLCOMPLETELY

CULLINGMODE_CULLCOMPLETELY: number = 2

En

Culling mode: Don't animate when not visible.

Zh

裁剪模式：不可见时完全不播放动画。

访问器

animatorParams

get animatorParams(): AnimatorParams
返回 AnimatorParams
En
The map of animator parameters.

Zh
状态机参数map。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:152
set animatorParams(values: AnimatorParams): void
参数
- values: AnimatorParams
返回 void
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:156

awaked

get awaked(): boolean
返回 boolean
En
whether the component has been awakened.

Zh
组件是否已经被唤醒。
继承自 Component.awaked
- 定义于 src/layaAir/laya/components/Component.ts:133

controller

get controller(): AnimatorController
返回 AnimatorController
En
The animation controller.

Zh
动画控制器。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:97
set controller(val: AnimatorController): void
参数
- val: AnimatorController
返回 void
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:100

controllerLayerCount

get controllerLayerCount(): number
返回 number
En
The number of layers in the state machine animation.

Zh
状态机动画层的数量。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:144

destroyed

get destroyed(): boolean
返回 boolean
En
whether the component has been destroyed.

Zh
组件是否已经被销毁。
继承自 Component.destroyed
- 定义于 src/layaAir/laya/components/Component.ts:141

enabled

get enabled(): boolean
返回 boolean
En
whether the component is enabled.

Zh
是否启用组件。
继承自 Component.enabled
- 定义于 src/layaAir/laya/components/Component.ts:117
set enabled(value: boolean): void
参数
- value: boolean
返回 void
继承自 Component.enabled
- 定义于 src/layaAir/laya/components/Component.ts:121

hideFlags

get hideFlags(): number
返回 number
En
The hide flags that determine the hiding behavior of the component.

Zh
确定组件隐藏行为的标志。
继承自 Component.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:67
set hideFlags(value: number): void
参数
- value: number
返回 void
继承自 Component.hideFlags
- 定义于 src/layaAir/laya/components/Component.ts:71

id

get id(): number
返回 number
En
The unique identifier for the component.

Zh
组件的唯一标识。
继承自 Component.id
- 定义于 src/layaAir/laya/components/Component.ts:109

lowUpdateDelty

set lowUpdateDelty(value: number): void
参数
- value: number
返回 void
En
Low update mode

Zh
低更新模式
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:136

sleep

get sleep(): boolean
返回 boolean
En
Whether to stop updating after the animation is completed.

Zh
动画完成后是否停止更新。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:165
set sleep(value: boolean): void
参数
- value: boolean
返回 void
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:169

speed

get speed(): number
返回 number
En
The playback speed of the animation. 1.0 is the normal playback speed.

Zh
动画的播放速度。1.0 为正常播放速度。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:115
set speed(value: number): void
参数
- value: number
返回 void
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:119

updateMode

set updateMode(value: AnimatorUpdateMode): void
参数
- value: AnimatorUpdateMode
返回 void
En
The update mode for the animator.

Zh
动画更新模式。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:128

方法

addControllerLayer

addControllerLayer(controllerLayer: AnimatorControllerLayer): void
参数
- controllerLayer: AnimatorControllerLayer
  The animation controller layer to add.
返回 void
En
Adds a controller layer.

Zh
添加控制器层。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1478

addState

addState(state: AnimatorState, layerIndex?: number): void
参数
- state: AnimatorState
  The animation state to add.
- layerIndex: number = 0
  The layer index.
返回 void
En
Adds an animation state.

Zh
添加动画状态。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1452

crossFade

crossFade(
    name: string,
    transitionDuration: number,
    layerIndex?: number,
    normalizedTime?: number,
): void
参数
- name: string
  The name of the target animation state.
- transitionDuration: number
  The transition duration, normalized to the current animation state's duration. Value should be between 0.0 and 1.0.
- layerIndex: number = 0
  The layer index. Defaults to 0.
- normalizedTime: number = Number.NEGATIVE_INFINITY
  The normalized start time of the animation. Defaults to Number.NEGATIVE_INFINITY.
返回 void
En
Performs a crossfade transition between the current animation state and the target animation state.

Zh
在当前动画状态和目标动画状态之间进行融合过渡播放。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1563

destroy

destroy(): void
返回 void
En
Destroy components

Zh
销毁组件
继承自 Component.destroy
- 定义于 src/layaAir/laya/components/Component.ts:289

getControllerLayer

getControllerLayer(layerIndex?: number): AnimatorControllerLayer
参数
- layerIndex: number = 0
  The layer index. Defaults to 0.
返回 AnimatorControllerLayer
The AnimatorControllerLayer at the specified index.

En
Gets the controller layer.

Zh
获取控制器层。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1495

getCurrentAnimatorPlayState

getCurrentAnimatorPlayState(layerIndex?: number): AnimatorPlayState
参数
- layerIndex: number = 0
  层索引。
返回 AnimatorPlayState
动画播放状态。

已被弃用
请使用animator.getControllerLayer(layerIndex).getCurrentPlayState()替换。use animator.getControllerLayer(layerIndex).getCurrentPlayState() instead 获取当前的播放状态。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1768

getDefaultState

getDefaultState(layerIndex?: number): AnimatorState
参数
- layerIndex: number = 0
  The layer index.
返回 AnimatorState
The default animation state.

En
Gets the default animation state.

Zh
获取默认动画状态。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1439

getParamsvalue

getParamsvalue(name: number): number | boolean
参数
- name: number
  The name or index of the parameter.
返回 number | boolean
The value of the parameter.

En
Gets the value of a parameter.

Zh
获取参数的值。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1750
getParamsvalue(name: string): number | boolean
参数
- name: string
  The name or index of the parameter.
返回 number | boolean
The value of the parameter.

En
Gets the value of a parameter.

Zh
获取参数的值。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1751

hasHideFlag

hasHideFlag(flag: number): boolean
参数
- flag: number
  The hide flag to check for.
返回 boolean
En
Checks if the component has a specific hide flag set.

Zh
检查组件是否设置了特定的隐藏标志。
继承自 Component.hasHideFlag
- 定义于 src/layaAir/laya/components/Component.ts:101

onAdded

onAdded(): void
返回 void
En
Called after the component is added to a node. Unlike Awake, onAdded is called even if the node is not active.

Zh
组件被添加到节点后调用，与 onAwake 不同的是，即使节点未激活也会调用 onAdded。
继承自 Component.onAdded
- 定义于 src/layaAir/laya/components/Component.ts:329

onAwake

onAwake(): void
返回 void
En
Executed after the component is activated. At this point, all nodes and components have been created. This method is executed only once.

Zh
组件被激活后执行，此时所有节点和组件均已创建完毕，此方法只执行一次。
继承自 Component.onAwake
- 定义于 src/layaAir/laya/components/Component.ts:344

onDestroy

onDestroy(): void
返回 void
En
Executed when the node is destroyed manually.

Zh
手动调用节点销毁时执行。
继承自 Component.onDestroy
- 定义于 src/layaAir/laya/components/Component.ts:395

onDisable

onDisable(): void
返回 void
En
Executed when the component is disabled, such as when the node is removed from the stage.

Zh
组件被禁用时执行，比如从节点从舞台移除后。
继承自 Component.onDisable
- 定义于 src/layaAir/laya/components/Component.ts:388

onEnable

onEnable(): void
返回 void
En
Executed after the component is enabled, such as when the node is added to the stage.

Zh
组件被启用后执行，比如节点被添加到舞台后。
继承自 Component.onEnable
- 定义于 src/layaAir/laya/components/Component.ts:351

`可选`onLateUpdate

onLateUpdate(): void
返回 void
En
Executed every frame during the late update phase, after the update phase.

Zh
每帧更新时执行，在 late update 阶段，update 阶段之后。
继承自 Component.onLateUpdate
- 定义于 src/layaAir/laya/components/Component.ts:370

`可选`onPostRender

onPostRender(): void
返回 void
En
Executed after rendering.

Zh
渲染之后执行。
继承自 Component.onPostRender
- 定义于 src/layaAir/laya/components/Component.ts:382

`可选`onPreRender

onPreRender(): void
返回 void
En
Executed before rendering.

Zh
渲染之前执行。
继承自 Component.onPreRender
- 定义于 src/layaAir/laya/components/Component.ts:376

`可选`onReset

onReset(): void
返回 void
En
Resets the component's parameters to their default values. If this function is implemented, the component will be reset and automatically recycled for future use. If not reset, it will not be recycled for reuse.

Zh
将组件的参数重置为默认值。如果实现了这个函数，组件将被重置并自动回收到对象池，方便下次复用。如果没有重置，则不会进行回收复用。
继承自 Component.onReset
- 定义于 src/layaAir/laya/components/Component.ts:338

`可选`onStart

onStart(): void
返回 void
En
Executed once, before the first update.

Zh
在第一次执行 update 之前执行，只会执行一次。
继承自 Component.onStart
- 定义于 src/layaAir/laya/components/Component.ts:358

play

play(name?: string, layerIndex?: number, normalizedTime?: number): void
参数
- name: string = null
  If null, plays the default animation; otherwise, plays the animation clip with the specified name.
- layerIndex: number = 0
  The layer index. Defaults to 0.
- normalizedTime: number = Number.NEGATIVE_INFINITY
  The normalized start time of the animation. Defaults to Number.NEGATIVE_INFINITY.
返回 void
En
Plays an animation.

Zh
播放动画。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1509

removeState

removeState(state: AnimatorState, layerIndex?: number): void
参数
- state: AnimatorState
  The animation state to remove.
- layerIndex: number = 0
  The layer index.
返回 void
En
Removes an animation state.

Zh
移除动画状态。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1466

setParamsBool

setParamsBool(name: number, value: boolean): void
参数
- name: number
  The name or index of the parameter.
- value: boolean
  The value to set.
返回 void
En
Sets the value of a boolean parameter.

Zh
设置布尔类型参数的值。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1731
setParamsBool(name: string, value: boolean): void
参数
- name: string
  The name or index of the parameter.
- value: boolean
  The value to set.
返回 void
En
Sets the value of a boolean parameter.

Zh
设置布尔类型参数的值。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1732

setParamsNumber

setParamsNumber(name: number, value: number): void
参数
- name: number
  The name or index of the parameter.
- value: number
  The value to set.
返回 void
En
Sets the value of a number parameter.

Zh
设置数值类型参数的值。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1712
setParamsNumber(name: string, value: number): void
参数
- name: string
  The name or index of the parameter.
- value: number
  The value to set.
返回 void
En
Sets the value of a number parameter.

Zh
设置数值类型参数的值。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1713

setParamsTrigger

setParamsTrigger(name: number): void
参数
- name: number
  The name or index of the trigger parameter.
返回 void
En
Enables a trigger parameter.

Zh
启用触发条件参数。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1693
setParamsTrigger(name: string): void
参数
- name: string
  The name or index of the trigger parameter.
返回 void
En
Enables a trigger parameter.

Zh
启用触发条件参数。
- 定义于 src/layaAir/laya/d3/component/Animator/Animator.ts:1694

类 Animator

En

Zh

层级 (查看层级一览)

索引

属性

访问器

方法

属性

_extra

En

Zh

_id

En

Zh

_singleton

En

Zh

cullingMode

En

Zh

owner

En

Zh

runInEditor

En

Zh

scriptPath

En

Zh

静态CULLINGMODE_ALWAYSANIMATE

En

Zh

静态CULLINGMODE_CULLCOMPLETELY

En

Zh

访问器

animatorParams

返回 AnimatorParams

En

Zh

参数

返回 void

awaked

返回 boolean

En

Zh

controller

返回 AnimatorController

En

Zh

参数

返回 void

controllerLayerCount

返回 number

En

Zh

destroyed

返回 boolean

En

Zh

enabled

返回 boolean

En

Zh

参数

返回 void

hideFlags

返回 number

En

Zh

参数

返回 void

id

返回 number

En

Zh

lowUpdateDelty

参数

返回 void

`静态`CULLINGMODE_ALWAYSANIMATE

`静态`CULLINGMODE_CULLCOMPLETELY