api/GameMotionController/controller.md · 神岛实验室/神岛产品文档

```

## 方法

#### loadByName(configs:string | [GameMotionConfig](./controller#GameMotionConfig)[] | [GameMotionClipConfig](./controller#GameMotionClipConfig)): [GameMotionHandler](/GameMotionController/handler){#loadByName}

加载特定动作或动作序列，并返回对应的动作对象

**输入参数**

| **参数** | **必填** | **默认值** | **类型** | **说明** |
| --- | --- | --- | --- | --- |
| configs | 是 | | string &#124; GameMotionConfig[] &#124; GameMotionClipConfig | 动作名称或配置 |

> 定义于 [#L11093](https://github.com/box3lab/arena_dts/blob/main/GameAPI.d.ts#L11093)
---

#### pause(): void{#pause}
暂停实体上的动作播放

> 定义于 [#L11097](https://github.com/box3lab/arena_dts/blob/main/GameAPI.d.ts#L11097)
---

#### resume(): void{#resume}
恢复实体上的动作播放

> 定义于 [#L11101](https://github.com/box3lab/arena_dts/blob/main/GameAPI.d.ts#L11101)
---

#### setDefaultMotionByName(motionName:undefined | string): void{#setDefaultMotionByName}
设置默认动作

- 没有其他动作在播放的情况下，默认动作会在游戏运行时自动循环播放
- 调用此函数时，如当前处于默认动作执行状态，则将打断旧默认动作，播放新的默认动作
- 动作名不存在时，此方法不产生任何效果，并抛出包含实体、模型与动作信息的错误

**输入参数**

| **参数** | **必填** | **默认值** | **类型** | **说明** |
| --- | --- | --- | --- | --- |
| motionName |  | | undefined &#124; string | 动作名称 |

```javascript
const entity = world.querySelector('#npc')
entity.motion.setDefaultMotionByName('FirstMotion');
entity.motion.setDefaultMotionByName(''); // 报错，不存在对应动作
entity.motion.setDefaultMotionByName(); // 设置默认动作为空，即不播放默认动作
```
> 定义于 [#L11105](https://github.com/box3lab/arena_dts/blob/main/GameAPI.d.ts#L11105)

## 接口

#### GameMotionConfig{#GameMotionConfig}
动作配置

| **参数** | **类型** | **说明** |
| --- | --- | --- |
| iterations | number | 输入Infinity就是无限循环，此时会覆盖掉默认动作，能cancel或者播放新的动作覆盖。可选项，默认 1 次 |
|  name | string | 动作名字 |

> 定义于 [#L11081](https://github.com/box3lab/arena_dts/blob/main/GameAPI.d.ts#L11081)
---

#### GameMotionClipConfig{#GameMotionClipConfig}
动作序列配置

| **参数** | **类型** | **说明** |
| --- | --- | --- |
| iterations | number | 输入Infinity就是无限循环，此时会覆盖掉默认动作，能cancel或者播放新的动作覆盖。可选项，默认 1 次 |
| motions | (string &#124; [GameMotionConfig](./controller#GameMotionConfig))[]   | 可填写指定动作名或motion动作配置 |

> 定义于 [#L11085](https://github.com/box3lab/arena_dts/blob/main/GameAPI.d.ts#L11085)

神岛实验室/神岛产品文档

简介

发行版

贡献者

近期动态

神岛实验室/神岛产品文档 .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

神岛实验室/神岛产品文档