索引

---

• 通用
• 文字面板
• 序列帧
• 粒子
• 模型特效
• 微软粒子

通用

接口		描述
DestroyEntity	客户端	销毁特效

文字面板

接口		描述
CreateTextBoardInWorld	客户端	创建文字面板
RemoveTextBoard	客户端	删除文字面板
SetBoardBackgroundColor	客户端	修改背景颜色
SetBoardBindEntity	客户端	文字面板绑定实体对象
SetBoardDepthTest	客户端	设置是否开启深度测试, 默认状态下是开启
SetBoardFaceCamera	客户端	设置文字面板的朝向
SetBoardPos	客户端	修改位置
SetBoardRot	客户端	修改旋转角度, 若设置了文本朝向相机，则旋转角度的修改不会生效
SetBoardScale	客户端	内容整体缩放
SetBoardTextColor	客户端	修改字体颜色
SetText	客户端	修改文字面板内容

序列帧

接口		描述
Bind	客户端	绑定entity
Bind	客户端	绑定骨骼模型
CreateEngineSfx	客户端	创建序列帧特效
CreateEngineSfxFromEditor	客户端	指使用资源包中effects/xxx.json，按照编辑器中编辑好的参数创建序列帧。支持环状序列帧
GetPos	客户端	获取序列帧特效的位置
GetRot	客户端	获取序列帧特效的旋转角度
GetScale	客户端	获取序列帧特效的缩放值
Pause	客户端	暂停播放，序列帧定格在当前时刻，再次调用Play时继续播放
Play	客户端	播放序列帧
SetDeepTest	客户端	设置序列帧是否透视，默认为否
SetFaceCamera	客户端	设置序列帧是否始终朝向摄像机，默认为是
SetFadeDistance	客户端	设置序列帧开始自动调整透明度的距离。序列帧与摄像机之间的距离小于该值时会自动调整序列帧的透明度，距离摄像机越近，序列帧越透明
SetGlobal	客户端	设置序列帧是否是全局的，默认为否
SetLayer	客户端	设置序列帧渲染层级，默认层级为1，当层级不为1时表示该特效开启特效分层渲染功能。特效（粒子和帧动画）分层渲染时，层级越高渲染越靠后，层级大的会遮挡层级低的，且同一层级的特效会根据特效的相对位置产生正确的相互遮挡关系。
SetLoop	客户端	设置序列帧是否循环播放，默认为否
SetMixColor	客户端	设置序列帧混合颜色
SetPos	客户端	设置序列帧的位置
SetRot	客户端	设置序列帧的旋转
SetRotUseZXY	客户端	设置序列帧的旋转，旋转顺序按照绕z,x,y轴旋转
SetScale	客户端	设置序列帧的缩放
SetUsePointFiltering	客户端	设置序列帧是否使用点滤波
Stop	客户端	停止序列帧（不是暂停）

粒子

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

模型特效

接口		描述
CreateEngineEffectBind	客户端	指用编辑器保存资源包中models/bind/xxx_bind.json生成编辑好的所有挂点的所有特效。生成的特效会自动进行挂接及播放，编辑器中设为不可见的特效也会进行播放。并且使用这种方式创建的特效，开发者不用维护entity进出视野导致的挂接特效被移除，引擎会在entity每次进入视野时自动创建所有特效。
Pause	客户端	暂停模型特效（即使用CreateEngineEffectBind创建的特效）
Resume	客户端	继续播放模型特效（即使用CreateEngineEffectBind创建的特效）

微软粒子

接口		描述
BindEntity	客户端	绑定粒子发射器到指定实体的指定骨骼上
BindModel	客户端	绑定粒子发射器到指定骨骼模型的指定骨骼上
Create	客户端	创建粒子发射器, 创建后立即播放
CreateBindEntityNew	客户端	创建粒子发射器并绑定到指定实体的指定骨骼上, 创建后立即播放
EmitManually	客户端	手动发射粒子一次
Exist	客户端	判断指定粒子发射器是否存在
GetActiveDuration	客户端	获取粒子发射器的激活周期
GetBindingID	客户端	返回粒子绑定的实体id，没有则返回"0"
GetBindingModelID	客户端	返回绑定的骨骼模型id 没有则返回-1
GetDuration	客户端	获取粒子发射器的播放周期(激活+休眠时间)
GetFacingMode	客户端	返回粒子发射器的粒子朝向模式
GetLoopAge	客户端	获取粒子发射器当前播放周期内已播放的时间
GetPos	客户端	获取粒子发射器位置
GetRot	客户端	获取粒子发射器局部旋转
GetSleepDuration	客户端	获取粒子发射器的休眠周期
GetTimeScale	客户端	获取粒子发射器的播放速度
GetVariable	客户端	获取粒子发射器的Molang变量值
Hide	客户端	隐藏粒子发射器(不渲染)
IsHiding	客户端	返回粒子发射器是否正在被隐藏(不渲染)
IsPausing	客户端	返回粒子发射器的逻辑是否正在被暂停
Pause	客户端	暂停粒子发射器的逻辑更新，但保持渲染状态
Play	客户端	播放粒子发射器
PlayAt	客户端	设置粒子发射器播放时间点
Remove	客户端	销毁指定粒子发射器
RemoveByName	客户端	销毁场景中指定名称(粒子发射器json中的identifier)的所有粒子发射器
Replay	客户端	重播粒子发射器
Resume	客户端	恢复粒子发射器的逻辑更新，不影响渲染状态
SetPos	客户端	设置粒子发射器位置
SetRelative	客户端	设置粒子是否在局部空间进行计算
SetRot	客户端	设置粒子发射器局部旋转
SetRotUseZXY	客户端	设置粒子发射器局部旋转，旋转顺序按照绕z,x,y轴旋转
SetTimeScale	客户端	设置粒子发射器的播放速度
SetVariable	客户端	设置粒子发射器的Molang变量值
Show	客户端	显示粒子发射器(开启渲染)
Stop	客户端	停止粒子发射器播放(不渲染且不更新逻辑)
Unbind	客户端	解除指定粒子发射器的绑定状态