类 Animator2D

En

2D animation components

Zh

2D动画组件

层级 (查看层级一览)

Component
- Animator2D

构造函数

constructor

new Animator2D(): Animator2D
返回 Animator2D
En
Constructor method of Animator2D Component.

Zh
2D动画组件构造方法。
重写了 Component.constructor
- 定义于 src/layaAir/laya/components/Animator2D.ts:46

属性

_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

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

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

脚本文件的路径。

访问器

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(): AnimatorController2D
返回 AnimatorController2D
En
The 2D animation controller.

Zh
2D动画控制器。
- 定义于 src/layaAir/laya/components/Animator2D.ts:56
set controller(val: AnimatorController2D): void
参数
- val: AnimatorController2D
返回 void
- 定义于 src/layaAir/laya/components/Animator2D.ts:60

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

isPlaying

get isPlaying(): boolean
返回 boolean
En
If the animation is currently playing.

Zh
动画是否正在播放。
- 定义于 src/layaAir/laya/components/Animator2D.ts:98

parameters

get parameters(): Record<string, Animation2DParm>
返回 Record<string, Animation2DParm>
En
The current 2D animation controller.

Zh
动画参数
- 定义于 src/layaAir/laya/components/Animator2D.ts:74
set parameters(val: Record<string, Animation2DParm>): void
参数
- val: Record<string, Animation2DParm>
返回 void
- 定义于 src/layaAir/laya/components/Animator2D.ts:78

speed

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

Zh
播放速度
- 定义于 src/layaAir/laya/components/Animator2D.ts:86
set speed(num: number): void
参数
- num: number
返回 void
- 定义于 src/layaAir/laya/components/Animator2D.ts:90

方法

addControllerLayer

addControllerLayer(controllerLayer: AnimatorControllerLayer2D): void
参数
- controllerLayer: AnimatorControllerLayer2D
  The animator controller layer to be added.
返回 void
En
Adds an animator controller layer.

Zh
增加一个动画控制器层。
- 定义于 src/layaAir/laya/components/Animator2D.ts:731

crossFade

crossFade(
    name: string,
    layerIndex: number,
    normalizedTime: number,
    transitionDuration: number,
): boolean
参数
- name: string
  The name of the target animation state.
- layerIndex: number
  The index of the layer.
- normalizedTime: number
  The normalized start time for playback.
- transitionDuration: number
  The duration of the transition in normalized time (between 0.0 and 1.0).
返回 boolean
En
Cross-fades between the current and target animation states.

Zh
在当前动画状态和目标动画状态之间进行融合过渡播放。
- 定义于 src/layaAir/laya/components/Animator2D.ts:747
crossFade(name: string, layerIndex: number, normalizedTime: number): boolean
参数
- name: string
  The name of the target animation state.
- layerIndex: number
  The index of the layer.
- normalizedTime: number
  The normalized start time for playback.
返回 boolean
En
Cross-fades between the current and target animation states with an optional transition duration.

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

destroy

destroy(): void
返回 void
En
Destroy components

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

getControllerLayer

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

En
Gets the controller layer.

Zh
获取控制器层。
- 定义于 src/layaAir/laya/components/Animator2D.ts:541

getDefaultState

getDefaultState(layerIndex?: number): AnimatorState2D
参数
- layerIndex: number = 0
  The index of the layer.
返回 AnimatorState2D
En
Get the default State Machine

Zh
获取默认状态机
- 定义于 src/layaAir/laya/components/Animator2D.ts:825

getParamsvalue

getParamsvalue(name: number): number | boolean
参数
- name: number
  The name of the parameter.
返回 number | boolean
En
Get a parameter's trigger value.

Zh
得到参数值
- 定义于 src/layaAir/laya/components/Animator2D.ts:870

gotoAndStop

gotoAndStop(name: string, layerIndex: number, normalizedTime: number): void
参数
- name: string
  The name of the animation.
- layerIndex: number
  The index of the layer.
- normalizedTime: number
  The normalized playback time of the animation.
返回 void
En
Jump to the specified time and stop playing the animation.

Zh
跳转到指定时间并停止播放动画。
- 定义于 src/layaAir/laya/components/Animator2D.ts:555

gotoAndStopByFrame

gotoAndStopByFrame(name: string, layerIndex: number, frame: number): void
参数
- name: string
  The name of the animation.
- layerIndex: number
  The index of the animation layer.
- frame: number
  The specified frame to jump to.
返回 void
En
Jump to the specified frame and stop playing the animation.

Zh
跳转到指定帧并停止播放动画。
- 定义于 src/layaAir/laya/components/Animator2D.ts:521

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

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

`可选`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

onUpdate

onUpdate(): void
返回 void
En
Frame Loop

Zh
帧循环
重写了 Component.onUpdate
- 定义于 src/layaAir/laya/components/Animator2D.ts:658

play

play(name?: string, layerIndex?: number, normalizedTime?: number): void
参数
- 可选name: string
  The name of the animation.
- layerIndex: number = 0
  The index of the layer.
- normalizedTime: number = Number.NEGATIVE_INFINITY
  The normalized time.
返回 void
En
Play animation

Zh
播放动画
- 定义于 src/layaAir/laya/components/Animator2D.ts:592

setParamsBool

setParamsBool(name: string, value: boolean): void
参数
- name: string
  The name of the parameter.
- value: boolean
  The value of the parameter.
返回 void
En
Set a parameter's bool value.

Zh
设置参数Bool值
- 定义于 src/layaAir/laya/components/Animator2D.ts:860

setParamsNumber

setParamsNumber(name: string, value: number): void
参数
- name: string
  The name of the parameter.
- value: number
  The value of the parameter.
返回 void
En
Set a parameter's float value.

Zh
设置参数Number值
- 定义于 src/layaAir/laya/components/Animator2D.ts:848

setParamsTrigger

setParamsTrigger(name: string): void
参数
- name: string
  The name of the parameter.
返回 void
En
Set a parameter's trigger value.

Zh
设置参数Trigger值
- 定义于 src/layaAir/laya/components/Animator2D.ts:836

stop

stop(): void
返回 void
En
Stop playing animation.

Zh
停止播放动画
- 定义于 src/layaAir/laya/components/Animator2D.ts:650

类 Animator2D

En

Zh

层级 (查看层级一览)

索引

构造函数

属性

访问器

方法

构造函数

constructor

返回 Animator2D

En

Zh

属性

_extra

En

Zh

_id

En

Zh

_singleton

En

Zh

owner

En

Zh

runInEditor

En

Zh

scriptPath

En

Zh

访问器

awaked

返回 boolean

En

Zh

controller

返回 AnimatorController2D

En

Zh

参数

返回 void

destroyed

返回 boolean

En

Zh

enabled

返回 boolean

En

Zh

参数

返回 void

hideFlags

返回 number

En

Zh

参数

返回 void

id

返回 number

En

Zh

isPlaying

返回 boolean

En

Zh

parameters

返回 Record<string, Animation2DParm>

En

Zh

参数

返回 void

speed

返回 number

En

Zh

参数

返回 void

`可选`onLateUpdate

`可选`onPostRender

`可选`onPreRender