---
sidebarDepth: 1
---
# 索引

---

- [通用](#通用)
- [文字面板](#文字面板)
- [序列帧](#序列帧)
- [粒子](#粒子)
- [模型特效](#模型特效)
- [微软粒子](#微软粒子)

### 通用

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [DestroyEntity](通用.md#destroyentity) | <span style="display:inline;color:#7575f9">客户端</span> | 销毁特效 |

### 文字面板

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [CreateTextBoardInWorld](文字面板.md#createtextboardinworld) | <span style="display:inline;color:#7575f9">客户端</span> | 创建文字面板 |
| [RemoveTextBoard](文字面板.md#removetextboard) | <span style="display:inline;color:#7575f9">客户端</span> | 删除文字面板 |
| [SetBoardBackgroundColor](文字面板.md#setboardbackgroundcolor) | <span style="display:inline;color:#7575f9">客户端</span> | 修改背景颜色 |
| [SetBoardBindEntity](文字面板.md#setboardbindentity) | <span style="display:inline;color:#7575f9">客户端</span> | 文字面板绑定实体对象 |
| [SetBoardDepthTest](文字面板.md#setboarddepthtest) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否开启深度测试, 默认状态下是开启 |
| [SetBoardFaceCamera](文字面板.md#setboardfacecamera) | <span style="display:inline;color:#7575f9">客户端</span> | 设置文字面板的朝向 |
| [SetBoardPos](文字面板.md#setboardpos) | <span style="display:inline;color:#7575f9">客户端</span> | 修改位置 |
| [SetBoardRot](文字面板.md#setboardrot) | <span style="display:inline;color:#7575f9">客户端</span> | 修改旋转角度, 若设置了文本朝向相机，则旋转角度的修改不会生效 |
| [SetBoardScale](文字面板.md#setboardscale) | <span style="display:inline;color:#7575f9">客户端</span> | 内容整体缩放 |
| [SetBoardTextColor](文字面板.md#setboardtextcolor) | <span style="display:inline;color:#7575f9">客户端</span> | 修改字体颜色 |
| [SetText](文字面板.md#settext) | <span style="display:inline;color:#7575f9">客户端</span> | 修改文字面板内容 |

### 序列帧

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [Bind](序列帧.md#bind) | <span style="display:inline;color:#7575f9">客户端</span> | 绑定entity |
| [Bind](序列帧.md#bind) | <span style="display:inline;color:#7575f9">客户端</span> | 绑定骨骼模型 |
| [CreateEngineSfx](序列帧.md#createenginesfx) | <span style="display:inline;color:#7575f9">客户端</span> | 创建序列帧特效 |
| [CreateEngineSfxFromEditor](序列帧.md#createenginesfxfromeditor) | <span style="display:inline;color:#7575f9">客户端</span> | 指使用资源包中effects/xxx.json，按照编辑器中编辑好的参数创建序列帧。支持环状序列帧 |
| [GetPos](序列帧.md#getpos) | <span style="display:inline;color:#7575f9">客户端</span> | 获取序列帧特效的位置 |
| [GetRot](序列帧.md#getrot) | <span style="display:inline;color:#7575f9">客户端</span> | 获取序列帧特效的旋转角度 |
| [GetScale](序列帧.md#getscale) | <span style="display:inline;color:#7575f9">客户端</span> | 获取序列帧特效的缩放值 |
| [Pause](序列帧.md#pause) | <span style="display:inline;color:#7575f9">客户端</span> | 暂停播放，序列帧定格在当前时刻，再次调用Play时继续播放 |
| [Play](序列帧.md#play) | <span style="display:inline;color:#7575f9">客户端</span> | 播放序列帧 |
| [SetDeepTest](序列帧.md#setdeeptest) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧是否透视，默认为否 |
| [SetFaceCamera](序列帧.md#setfacecamera) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧是否始终朝向摄像机，默认为是 |
| [SetFadeDistance](序列帧.md#setfadedistance) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧开始自动调整透明度的距离。序列帧与摄像机之间的距离小于该值时会自动调整序列帧的透明度，距离摄像机越近，序列帧越透明 |
| [SetLayer](序列帧.md#setlayer) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧渲染层级，默认层级为1，当层级不为1时表示该特效开启特效分层渲染功能。特效（粒子和帧动画）分层渲染时，层级越高渲染越靠后，层级大的会遮挡层级低的，且同一层级的特效会根据特效的相对位置产生正确的相互遮挡关系。 |
| [SetLoop](序列帧.md#setloop) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧是否循环播放，默认为否 |
| [SetMixColor](序列帧.md#setmixcolor) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧混合颜色 |
| [SetPos](序列帧.md#setpos) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧的位置 |
| [SetRot](序列帧.md#setrot) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧的旋转 |
| [SetRotUseZXY](序列帧.md#setrotusezxy) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧的旋转，旋转顺序按照绕z,x,y轴旋转 |
| [SetScale](序列帧.md#setscale) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧的缩放 |
| [SetUsePointFiltering](序列帧.md#setusepointfiltering) | <span style="display:inline;color:#7575f9">客户端</span> | 设置序列帧是否使用点滤波 |
| [Stop](序列帧.md#stop) | <span style="display:inline;color:#7575f9">客户端</span> | 停止序列帧（不是暂停） |

### 粒子

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [Bind](粒子.md#bind) | <span style="display:inline;color:#7575f9">客户端</span> | 绑定entity |
| [Bind](粒子.md#bind) | <span style="display:inline;color:#7575f9">客户端</span> | 绑定骨骼模型 |
| [CreateEngineParticle](粒子.md#createengineparticle) | <span style="display:inline;color:#7575f9">客户端</span> | 用于创建粒子特效 |
| [GetParticleEmissionRate](粒子.md#getparticleemissionrate) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器每帧发射粒子的频率。 |
| [GetParticleMaxNum](粒子.md#getparticlemaxnum) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器包含的最大粒子数量。 |
| [GetParticleMaxSize](粒子.md#getparticlemaxsize) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子特效中粒子大小的最大值。 |
| [GetParticleMinSize](粒子.md#getparticleminsize) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子特效中粒子大小的最小值。 |
| [GetParticleVolumeSize](粒子.md#getparticlevolumesize) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器的体积大小缩放值。 |
| [GetPos](粒子.md#getpos) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器的世界坐标位置 |
| [GetRot](粒子.md#getrot) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器的旋转角度 |
| [Pause](粒子.md#pause) | <span style="display:inline;color:#7575f9">客户端</span> | 暂停播放，粒子定格在当前时刻，再次调用Play时继续播放 |
| [Play](粒子.md#play) | <span style="display:inline;color:#7575f9">客户端</span> | 播放粒子特效 |
| [SetFadeDistance](粒子.md#setfadedistance) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子开始自动调整透明度的距离。粒子与摄像机之间的距离小于该值时会自动调整粒子的透明度，距离摄像机越近，粒子越透明 |
| [SetLayer](粒子.md#setlayer) | <span style="display:inline;color:#7575f9">客户端</span> | 粒子默认层级为1，当层级不为1时表示该特效开启特效分层渲染功能。特效（粒子和帧动画）分层渲染时，层级越高渲染越靠后，层级大的会遮挡层级低的，且同一层级的特效会根据特效的相对位置产生正确的相互遮挡关系。 |
| [SetParticleEmissionRate](粒子.md#setparticleemissionrate) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器每帧发射粒子的频率，频率越大则每帧发射的粒子数量越多，但粒子数量不会超过粒子发射器的粒子容量，同时由于性能考虑，每帧发射的粒子数量也不会超过100个。 |
| [SetParticleMaxNum](粒子.md#setparticlemaxnum) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器的粒子容量，即粒子发射器所包含的最大粒子数量。该数量并不代表目前粒子发射器所发射的粒子数量，如需要增加发射的粒子数量，需同时改变粒子的发射频率。 |
| [SetParticleSize](粒子.md#setparticlesize) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子特效中粒子大小的最小值及最大值。 |
| [SetParticleVolumeSize](粒子.md#setparticlevolumesize) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器的体积大小缩放，不影响单个粒子的尺寸。粒子发射器的体积越大，则粒子的发射范围越大。 |
| [SetPos](粒子.md#setpos) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器的世界坐标位置 |
| [SetRelative](粒子.md#setrelative) | <span style="display:inline;color:#7575f9">客户端</span> | 当粒子绑定了entity或骨骼模型时，发射出的粒子使用entity坐标系还是世界坐标系。与mcstudio特效编辑器中粒子的“相对挂点运动”选项功能相同。 |
| [SetRotUseZXY](粒子.md#setrotusezxy) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器的旋转，旋转顺序按照绕z,x,y轴旋转 |
| [SetUsePointFiltering](粒子.md#setusepointfiltering) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子材质的纹理滤波是否使用点滤波方法。默认为使用双线性滤波 |
| [Stop](粒子.md#stop) | <span style="display:inline;color:#7575f9">客户端</span> | 停止粒子播放 |

### 模型特效

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [CreateEngineEffectBind](模型特效.md#createengineeffectbind) | <span style="display:inline;color:#7575f9">客户端</span> | 指用编辑器保存资源包中models/bind/xxx_bind.json生成编辑好的所有挂点的所有特效。生成的特效会自动进行挂接及播放，编辑器中设为不可见的特效也会进行播放。并且使用这种方式创建的特效，开发者不用维护entity进出视野导致的挂接特效被移除，引擎会在entity每次进入视野时自动创建所有特效。 |
| [Pause](模型特效.md#pause) | <span style="display:inline;color:#7575f9">客户端</span> | 暂停模型特效（即使用CreateEngineEffectBind创建的特效） |
| [Resume](模型特效.md#resume) | <span style="display:inline;color:#7575f9">客户端</span> | 继续播放模型特效（即使用CreateEngineEffectBind创建的特效） |

### 微软粒子

| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [BindEntity](微软粒子.md#bindentity) | <span style="display:inline;color:#7575f9">客户端</span> | 绑定粒子发射器到指定实体的指定骨骼上 |
| [BindModel](微软粒子.md#bindmodel) | <span style="display:inline;color:#7575f9">客户端</span> | 绑定粒子发射器到指定骨骼模型的指定骨骼上 |
| [Create](微软粒子.md#create) | <span style="display:inline;color:#7575f9">客户端</span> | 创建粒子发射器, 创建后立即播放 |
| [CreateBindEntity](微软粒子.md#createbindentity) | <span style="display:inline;color:#7575f9">客户端</span> | 创建粒子发射器并绑定到指定实体的指定骨骼上, 创建后立即播放 |
| [EmitManually](微软粒子.md#emitmanually) | <span style="display:inline;color:#7575f9">客户端</span> | 手动发射粒子一次 |
| [Exist](微软粒子.md#exist) | <span style="display:inline;color:#7575f9">客户端</span> | 判断指定粒子发射器是否存在 |
| [GetActiveDuration](微软粒子.md#getactiveduration) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器的激活周期 |
| [GetBindingID](微软粒子.md#getbindingid) | <span style="display:inline;color:#7575f9">客户端</span> | 返回绑定的目标id 没有则返回"0" |
| [GetBindingModleID](微软粒子.md#getbindingmodleid) | <span style="display:inline;color:#7575f9">客户端</span> | 返回绑定的骨骼模型id 没有则返回-1 |
| [GetDuration](微软粒子.md#getduration) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器的播放周期(激活+休眠时间) |
| [GetFacingMode](微软粒子.md#getfacingmode) | <span style="display:inline;color:#7575f9">客户端</span> | 返回粒子发射器的粒子朝向模式 |
| [GetLoopAge](微软粒子.md#getloopage) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器当前播放周期内已播放的时间 |
| [GetPos](微软粒子.md#getpos) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器位置 |
| [GetRot](微软粒子.md#getrot) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器局部旋转 |
| [GetSleepDuration](微软粒子.md#getsleepduration) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器的休眠周期 |
| [GetTimeScale](微软粒子.md#gettimescale) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器的播放速度 |
| [GetVariable](微软粒子.md#getvariable) | <span style="display:inline;color:#7575f9">客户端</span> | 获取粒子发射器的Molang变量值 |
| [Hide](微软粒子.md#hide) | <span style="display:inline;color:#7575f9">客户端</span> | 隐藏粒子发射器(不渲染) |
| [IsHiding](微软粒子.md#ishiding) | <span style="display:inline;color:#7575f9">客户端</span> | 返回粒子发射器是否正在被隐藏(不渲染) |
| [IsPausing](微软粒子.md#ispausing) | <span style="display:inline;color:#7575f9">客户端</span> | 返回粒子发射器的逻辑是否正在被暂停 |
| [Pause](微软粒子.md#pause) | <span style="display:inline;color:#7575f9">客户端</span> | 暂停粒子发射器的逻辑更新，但保持渲染状态 |
| [Play](微软粒子.md#play) | <span style="display:inline;color:#7575f9">客户端</span> | 播放粒子发射器 |
| [PlayAt](微软粒子.md#playat) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器播放时间点 |
| [Remove](微软粒子.md#remove) | <span style="display:inline;color:#7575f9">客户端</span> | 销毁指定粒子发射器 |
| [RemoveByName](微软粒子.md#removebyname) | <span style="display:inline;color:#7575f9">客户端</span> | 销毁场景中指定名称(粒子发射器json中的identifier)的所有粒子发射器 |
| [Replay](微软粒子.md#replay) | <span style="display:inline;color:#7575f9">客户端</span> | 重播粒子发射器 |
| [Resume](微软粒子.md#resume) | <span style="display:inline;color:#7575f9">客户端</span> | 恢复粒子发射器的逻辑更新，不影响渲染状态 |
| [SetPos](微软粒子.md#setpos) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器位置 |
| [SetRelative](微软粒子.md#setrelative) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子是否在局部空间进行计算 |
| [SetRot](微软粒子.md#setrot) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器局部旋转 |
| [SetTimeScale](微软粒子.md#settimescale) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器的播放速度 |
| [SetVariable](微软粒子.md#setvariable) | <span style="display:inline;color:#7575f9">客户端</span> | 设置粒子发射器的Molang变量值 |
| [Show](微软粒子.md#show) | <span style="display:inline;color:#7575f9">客户端</span> | 显示粒子发射器(开启渲染) |
| [Stop](微软粒子.md#stop) | <span style="display:inline;color:#7575f9">客户端</span> | 停止粒子发射器播放(不渲染且不更新逻辑) |
| [Unbind](微软粒子.md#unbind) | <span style="display:inline;color:#7575f9">客户端</span> | 解除指定粒子发射器的绑定状态 |