搜索
# 索引
包括实体属性与行为的接口，实体的获取、生成和销毁见世界/实体管理
# 实体类型
| 接口 | 描述 | |
|---|---|---|
| GetEngineType | 服务端 | 获取实体类型，主要用于判断实体是否属于某一类型的生物。 |
| GetEngineType | 客户端 | 获取实体类型，主要用于判断实体是否属于某一类型的生物。 |
| GetEngineTypeStr | 服务端 | 获取实体的类型名称 |
| GetEngineTypeStr | 客户端 | 获取实体的类型名称 |
| GetEntityDefinitions | 服务端 | 获取实体的命名空间ID及其当前和之前的定义组件群 |
| GetEntityNBTTags | 服务端 | 获取实体的NBT标签 |
# 附加值
| 接口 | 描述 | |
|---|---|---|
| GetAuxValue | 服务端 | 获取射出的弓箭或投掷出的药水的附加值 |
| GetAuxValue | 客户端 | 获取射出的弓箭或投掷出的药水的附加值 |
# 属性
| 接口 | 描述 | |
|---|---|---|
| ChangeEntityDimension | 服务端 | 传送实体 |
| GetAllComponentsName | 服务端 | 获取实体所拥有的原版组件list |
| GetAttrMaxValue | 服务端 | 获取实体的引擎属性的最大值 |
| GetAttrMaxValue | 客户端 | 获取属性最大值，包括生命值，饥饿度，移速等 |
| GetAttrValue | 服务端 | 获取实体的引擎属性 |
| GetAttrValue | 客户端 | 获取属性值，包括生命值，饥饿度，移速 |
| GetBodyRot | 客户端 | 获取实体的身体的角度 |
| GetCurrentAirSupply | 服务端 | 生物当前氧气储备值 |
| GetCurrentAirSupply | 客户端 | 玩家当前氧气储备值 |
| GetDeathTime | 服务端 | 获取生物死亡后持续的时间（刻，1秒20刻），用于控制死亡动画。0表示生物未死亡。 |
| GetEntityDamage | 服务端 | 获取生物(包括玩家)的攻击力 |
| GetEntityDimensionId | 服务端 | 获取实体所在维度 |
| GetEntityFallDistance | 服务端 | 获取实体的坠落高度，越大的值会给予实体更大的坠落伤害，建议在OnGroundServerEvent事件中调用 |
| GetEntityLinksTag | 服务端 | 获取实体相连接的实体，如获取entityId为马，会返回骑乘者的信息 |
| GetEntityOwner | 服务端 | 获取实体的属主（包括可驯服生物的主人，或者掉落物的丢弃者，弹射物的发射者等） |
| GetFootPos | 服务端 | 获取实体脚所在的位置 |
| GetFootPos | 客户端 | 获取实体脚所在的位置 |
| GetGravity | 服务端 | 获取实体的重力因子，当生物重力因子为0时则应用世界的重力因子 |
| GetLoadActors | 服务端 | 获取已加载的实体id |
| GetMarkVariant | 服务端 | 获取实体的标记变种属性值 |
| GetMaxAirSupply | 服务端 | 获取生物最大氧气储备值 |
| GetMaxAirSupply | 客户端 | 玩家最大氧气储备值 |
| GetMobColor | 服务端 | 获取生物的颜色，截止至网易2.9版本，只对羊和热带鱼有效 |
| GetMobStrength | 服务端 | 获取生物的强度，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多 |
| GetMobStrengthMax | 服务端 | 获取生物强度的最大值，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多，SetMobStrength无法超过SetMobStrengthMax的值 |
| GetName | 服务端 | 获取生物的自定义名称（即使用命名牌或者SetName接口设置的名称），或者玩家的名字。 |
| GetName | 客户端 | 获取生物的自定义名称（即使用命名牌或者SetName接口设置的名称），或者玩家的名字。 |
| GetPos | 服务端 | 获取实体位置 |
| GetPos | 客户端 | 获取实体位置 |
| GetRiderId | 客户端 | 获取玩家坐骑entityid |
| GetRot | 服务端 | 获取实体头与水平方向的俯仰角度和竖直方向的旋转角度，获得角度后可用GetDirFromRot接口转换为朝向的单位向量 MC坐标系说明 |
| GetRot | 客户端 | 获取实体头与水平方向的俯仰角度和竖直方向的旋转角度，获得角度后可用GetDirFromRot接口转换为朝向的单位向量 MC坐标系说明 |
| GetSize | 服务端 | 获取实体的包围盒 |
| GetSize | 客户端 | 获取实体的包围盒 |
| GetTradeLevel | 服务端 | 获取村民的交易等级 |
| GetTypeFamily | 服务端 | 获取生物行为包字段 type_family |
| GetUnitBubbleAirSupply | 服务端 | 单位气泡数对应的氧气储备值 |
| GetVariant | 服务端 | 获取实体的变种属性值 |
| HasChest | 服务端 | 判断生物是否背负了箱子，截止至网易2.9版本，只对羊驼、驴、骡生效 |
| HasComponent | 服务端 | 判断实体是否有原版组件 |
| HasSaddle | 服务端 | 判断实体是否装备了鞍 |
| IsAngry | 服务端 | 判断实体是否处于激怒状态 |
| IsBaby | 服务端 | 判断实体是否为幼年 |
| IsConsumingAirSupply | 服务端 | 获取生物当前是否在消耗氧气 |
| IsIllagerCaptain | 服务端 | 判断实体是否为袭击队长，截止至网易2.9版本，只对掠夺者和卫道士有效 |
| IsNaturallySpawned | 服务端 | 获取生物是否为自然生成的 |
| IsOutOfControl | 服务端 | 判断实体是否处于失控状态，截止至网易2.9版本，只对船有效 |
| IsPregnant | 服务端 | 获取生物是否怀孕，截止至网易2.9版本，只对海龟有效 |
| IsSheared | 服务端 | 判断实体是否被剃毛，截止至网易2.9版本，只对羊有效 |
| IsSitting | 服务端 | 判断实体是否处于坐下状态 |
| IsTamed | 服务端 | 判断实体是否被驯服 |
| LockLocalPlayerRot | 客户端 | 在分离摄像机时，锁定本地玩家的头部角度 |
| PromoteToIllagerCaptain | 服务端 | 晋升实体为袭击队长，截止至网易2.9版本，只对掠夺者和卫道士有效 |
| ResetToDefaultValue | 服务端 | 重置实体引擎属性到默认值 |
| ResetToMaxValue | 服务端 | 重置实体引擎属性到最大值 |
| SetAngry | 服务端 | 设置实体是否处于激怒状态 |
| SetAsAdult | 服务端 | 设置实体为成年体 |
| SetAttrMaxValue | 服务端 | 设置实体的引擎属性的最大值 |
| SetAttrValue | 服务端 | 设置实体的引擎属性 |
| SetChest | 服务端 | 设置生物是否背负了箱子，截止至网易2.9版本，只对羊驼、驴、骡生效 |
| SetCurrentAirSupply | 服务端 | 设置生物氧气储备值 |
| SetEntityLookAtPos | 服务端 | 设置非玩家的实体看向某个位置 |
| SetEntityOwner | 服务端 | 设置实体的属主（包括可驯服生物的主人，或者掉落物的丢弃者，弹射物的发射者等） |
| SetFootPos | 服务端 | 设置实体脚底所在的位置 |
| SetGravity | 服务端 | 设置实体的重力因子，当生物重力因子为0时则应用世界的重力因子 |
| SetMarkVariant | 服务端 | 设置实体的标记变种属性值 |
| SetMaxAirSupply | 服务端 | 设置生物最大氧气储备值 |
| SetMobColor | 服务端 | 设置生物的颜色，截止至网易2.9版本，只对羊和热带鱼有效 |
| SetMobStrength | 服务端 | 设置生物的强度，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多 |
| SetMobStrengthMax | 服务端 | 设置生物强度的最大值，截止至网易2.9版本，只对羊驼有效，强度越大羊驼驮运的箱子时格子数量越多，SetMobStrength无法超过SetMobStrengthMax的值。由于引擎限制，在羊驼被打时候会reload组件，strengthMax会恢复成llama.json中的配置值(minecraft:strength) |
| SetName | 服务端 | 用于设置生物的自定义名称，跟原版命名牌作用相同，玩家和新版流浪商人暂不支持 |
| SetOutOfControl | 服务端 | 设置实体是否处于失控状态，截止至网易2.9版本，只对船有效 |
| SetPersistent | 服务端 | 设置实体不会因为离玩家太远而被清除 (opens new window) |
| SetPlayerLookAtPos | 客户端 | 设置本地玩家看向某个位置 |
| SetPos | 服务端 | 设置实体位置 |
| SetRecoverTotalAirSupplyTime | 服务端 | 设置恢复最大氧气量的时间，单位秒 |
| SetRot | 服务端 | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 MC坐标系说明 |
| SetRot | 客户端 | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 MC坐标系说明 |
| SetSheared | 服务端 | 设置实体是否被剃毛，截止至网易2.9版本，只对羊有效 |
| SetSitting | 服务端 | 设置生物是否坐下 |
| SetSize | 服务端 | 设置实体的包围盒 |
| SetTradeLevel | 服务端 | 设置村民的交易等级 |
| SetVariant | 服务端 | 设置实体的变种属性值 |
| isEntityInLava | 客户端 | 实体是否在岩浆中 |
| isEntityOnGround | 客户端 | 实体是否触地 |
# 行为
| 接口 | 描述 | |
|---|---|---|
| AddActorComponentGroup | 服务端 | 给指定实体添加实体json中配置的ComponentGroup |
| AddEntityAroundEntityMotion | 服务端 | 给实体（不含玩家）添加对实体环绕运动器 |
| AddEntityAroundPointMotion | 服务端 | 给实体（不含玩家）添加对点环绕运动器 |
| AddEntitySeat | 服务端 | 增加坐骑座位 |
| AddEntityTrackMotion | 服务端 | 给实体（不含玩家）添加轨迹运动器 |
| AddEntityVelocityMotion | 服务端 | 给实体（不含玩家）添加速度运动器 |
| ChangeRiderSeat | 服务端 | 设置骑乘者在当前坐骑上的序号 |
| DeleteEntitySeat | 服务端 | 删除坐骑座位 |
| GetAttackTarget | 服务端 | 获取仇恨目标 |
| GetAttackTarget | 客户端 | 获取仇恨目标 |
| GetBlockControlAi | 服务端 | 获取生物原生AI是否被屏蔽 |
| GetCustomGoalCls | 服务端 | 用于获取服务器自定义行为节点的基类。实现新的行为节点时，需要继承该接口返回的类 |
| GetEntityMotions | 服务端 | 获取实体（不含玩家）身上的所有运动器 |
| GetJumpPower | 服务端 | 获取生物跳跃力度，0.42表示正常水平 |
| GetLeashHolder | 服务端 | 获取实体被使用拴绳牵引时牵引者的ID |
| GetMotion | 服务端 | 获取生物（含玩家）的瞬时移动方向向量 |
| GetMotion | 客户端 | 获取生物的瞬时移动方向向量。与服务端不同，客户端不会计算摩擦等因素，获取到的是上一帧的向量，与服务器获取到的值会不相等 |
| GetOwnerId | 服务端 | 获取驯服生物的主人id |
| GetOwnerId | 客户端 | 获取驯服生物的主人id |
| GetRiders | 服务端 | 获取坐骑上的骑乘者信息 |
| GetStepHeight | 服务端 | 返回玩家前进非跳跃状态下能上的最大台阶高度 |
| Hurt | 服务端 | 设置实体伤害 |
| ImmuneDamage | 服务端 | 设置实体是否免疫伤害（该属性存档） |
| IsEating | 服务端 | 判断非玩家实体是否在进食 |
| IsEntityOnFire | 服务端 | 获取实体是否着火 |
| IsLootDropped | 服务端 | 获取生物是否生成掉落物 |
| IsPersistent | 服务端 | 判断是否为持久性生物 |
| IsRoaring | 服务端 | 判断是否处于咆哮状态，截止至网易2.9版本，仅对劫掠兽有效 |
| IsStunned | 服务端 | 判断是否处于眩晕状态，截止至网易2.9版本，仅对劫掠兽有效 |
| RemoveActorComponentGroup | 服务端 | 移除指定实体在实体json中配置的ComponentGroup |
| RemoveEntityMotion | 服务端 | 移除实体（不含玩家）身上的运动器 |
| ResetAttackTarget | 服务端 | 清除仇恨目标 |
| ResetMotion | 服务端 | 重置生物（不含玩家）的瞬时移动方向向量 |
| ResetStepHeight | 服务端 | 恢复引擎默认玩家前进非跳跃状态下能上的最大台阶高度 |
| SetActorCollidable | 服务端 | 设置实体是否可碰撞 |
| SetActorPushable | 服务端 | 设置实体是否可推动 |
| SetAttackTarget | 服务端 | 设置仇恨目标 |
| SetBlockControlAi | 服务端 | 设置屏蔽生物原生AI |
| SetCanOtherPlayerRide | 服务端 | 设置其他玩家是否有权限骑乘，True表示每个玩家都能骑乘，False只有驯服者才能骑乘 |
| SetControl | 服务端 | 设置该生物无需装备鞍就可以控制行走跳跃 |
| SetEntityInteractFilter | 服务端 | 设置与生物可交互的条件 |
| SetEntityLockRider | 服务端 | 设置坐骑上的实体是否锁定序号 |
| SetEntityOnFire | 服务端 | 设置实体着火 |
| SetEntityRide | 服务端 | 驯服可骑乘生物 |
| SetEntitySeat | 服务端 | 设置坐骑座位的位置、旋转以及允许实体旋转范围 |
| SetEntityShareablesItems | 服务端 | 设置生物可分享/可拾取的物品列表 |
| SetEntityTamed | 服务端 | 设置生物驯服，需要配合 entityEvent组件使用。该类驯服不包含骑乘功能。 |
| SetJumpPower | 服务端 | 设置生物跳跃力度，0.42表示正常水平 |
| SetLeashHolder | 服务端 | 为实体添加牵引者，与原版拴绳的作用相同，详见基岩版栓绳介绍 |
| SetLootDropped | 服务端 | 设置生物是否生成掉落物 |
| SetMobKnockback | 服务端 | 设置击退的初始速度，需要考虑阻力的影响 |
| SetMotion | 服务端 | 设置生物（不含玩家）的瞬时移动方向向量 |
| SetMotion | 客户端 | 设置瞬时的移动方向向量，用于本地玩家 |
| SetMoveSetting | 服务端 | 寻路组件 |
| SetPersistence | 服务端 | 设置实体是否持久化。 |
| SetRidePos | 服务端 | 设置生物骑乘位置 |
| SetRiderRideEntity | 服务端 | 设置实体骑乘生物（或者船与矿车） |
| SetStepHeight | 服务端 | 设置玩家前进非跳跃状态下能上的最大台阶高度, 默认值为0.5625，1的话表示能上一个台阶 |
| StartEntityMotion | 服务端 | 启动实体（不含玩家）身上的某个运动器 |
| StopEntityMotion | 服务端 | 停止实体（不含玩家）身上的某个运动器 |
| TriggerCustomEvent | 服务端 | 触发生物自定义事件 |
# 状态效果
| 接口 | 描述 | |
|---|---|---|
| AddEffectToEntity | 服务端 | 为实体添加指定状态效果，如果添加的状态已存在则有以下集中情况：1、等级大于已存在则更新状态等级及持续时间；2、状态等级相等且剩余时间duration大于已存在则刷新剩余时间；3、等级小于已存在则不做修改；4、粒子效果以新的为准 |
| GetAllEffects | 服务端 | 获取实体当前所有状态效果 |
| GetAllEffects | 客户端 | 获取实体当前所有状态效果 |
| HasEffect | 服务端 | 获取实体是否存在当前状态效果 |
| HasEffect | 客户端 | 获取实体是否存在当前状态效果 |
| RemoveEffectFromEntity | 服务端 | 为实体删除指定状态效果 |
# 渲染
| 接口 | 描述 | |
|---|---|---|
| AddActorAnimation | 客户端 | 增加生物渲染动画 |
| AddActorAnimationController | 客户端 | 增加生物渲染动画控制器 |
| AddActorBlockGeometry | 客户端 | 为实体添加方块几何体模型。 |
| AddActorGeometry | 客户端 | 增加生物渲染几何体 |
| AddActorParticleEffect | 客户端 | 增加生物特效资源 |
| AddActorRenderController | 客户端 | 增加生物渲染控制器 |
| AddActorRenderControllerArray | 客户端 | 增加生物渲染控制器列表中字典arrays元素 |
| AddActorRenderMaterial | 客户端 | 增加生物渲染需要的材质 |
| AddActorScriptAnimate | 客户端 | 在生物的客户端实体定义（minecraft:client_entity）json中的scripts/animate节点添加动画/动画控制器 |
| AddActorSoundEffect | 客户端 | 增加生物音效资源 |
| AddActorTexture | 客户端 | 增加生物渲染贴图 |
| BindEntityToEntity | 客户端 | 绑定骨骼模型跟随其他entity,如果当前entity是本地玩家，摄像机也跟随其他entity |
| ClearActorBlockGeometry | 客户端 | 删除实体中所有的方块几何体模型。 |
| CopyActorGeometryFromPlayer | 客户端 | 将渲染几何体从某个玩家拷贝到某类生物identifier上 |
| CopyActorRenderMaterialFromPlayer | 客户端 | 将渲染材质从某个玩家拷贝到某类生物identifier上 |
| CopyActorTextureFromPlayer | 客户端 | 将贴图从某个玩家拷贝到某类生物identifier上 |
| CopyPlayerGeometryToOneActor | 客户端 | 将渲染几何体从某个玩家拷贝到某个生物上 |
| CopyPlayerRenderMaterialToOneActor | 客户端 | 将渲染材质从某个玩家拷贝到某个生物上 |
| CopyPlayerTextureToOneActor | 客户端 | 将贴图从某个玩家拷贝到某个生物上 |
| DeleteActorBlockGeometry | 客户端 | 删除实体中指定方块几何体模型。 |
| GetActorRenderParams | 客户端 | 获取实体（包括玩家）渲染参数 |
| GetEntityExtraUniforms | 客户端 | 获取在实体shader当中使用的自定义变量的值。该自定义变量包含EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量。 |
| GetEntityRenderDistance | 客户端 | 获取玩家的实体可渲染距离。玩家周围的实体指这个区块内的实体，也包含玩家自身。实体的渲染距离指，实体的位置到玩家相机位置的距离。可渲染距离指，如果实体的渲染距离在可渲染距离之内，则实体会被渲染出来，如果在距离以外，则实体不会被渲染出来。仅对本地玩家有效。 |
| GetEntityUIExtraUniforms | 客户端 | 获取在实体shader当中使用的UI自定义变量的值，该变量可在微软UI纸娃娃（paperdoll）及网易版纸娃娃（neteasepaperdoll)上使用identifier渲染某一类生物实体时使用。该自定义变量包含EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量。 |
| GetNotRenderAtAll | 客户端 | 获取实体是否不渲染 |
| IsShowName | 客户端 | 获取生物名字是否按照默认游戏逻辑显示（包括玩家） |
| RebuildActorRender | 客户端 | 重建生物的数据渲染器（该接口不支持玩家，玩家请使用RebuildPlayerRender） |
| RebuildRenderForOneActor | 客户端 | 使用完entity类渲染接口后，重建单个生物渲染控制器（该接口不支持玩家，玩家请使用RebuildPlayerRender） |
| RemoveActorAnimationController | 客户端 | 移除生物渲染动画控制器 |
| RemoveActorGeometry | 客户端 | 删除生物渲染几何体 |
| RemoveActorRenderController | 客户端 | 删除生物渲染控制器 |
| RemoveActorTexture | 客户端 | 删除生物渲染贴图 |
| ResetActorRender | 客户端 | 重置实体渲染接口，包括动画、动画控制器、渲染控制器、贴图、材质、特效资源、音效资源等。 |
| ResetBindEntity | 客户端 | 取消目标entity的绑定实体，取消后不再跟随任何其他entity |
| ResetRenderForOneActor | 客户端 | 将调用OneActor类渲染接口(CopyPlayerTextureToOneActor、CopyPlayerRenderMaterialToOneActor等)的生物重置回种群 |
| SetActorAllBlockGeometryVisible | 客户端 | 设置实体中所有的方块几何体模型是否显示。 |
| SetActorBlockGeometryVisible | 客户端 | 设置实体中指定的方块几何体模型是否显示。 |
| SetAlwaysShowName | 客户端 | 设置生物名字是否一直显示，瞄准点不指向生物时也能显示 |
| SetColor | 客户端 | 设置血条的颜色及背景色 |
| SetEntityExtraUniforms | 客户端 | 设置可在实体shader当中使用的自定义变量的值。该自定义变量总共可设置EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量，向量的默认值为(1.0,1.0,1.0,1.0)。 |
| SetEntityRenderDistance | 客户端 | 设置玩家周围的实体的可渲染距离。玩家周围的实体指这个区块内的实体，也包含玩家自身。实体的渲染距离指，实体的位置到玩家相机位置的距离。可渲染距离指，如果实体的渲染距离在可渲染距离之内，则实体会被渲染出来，如果在距离以外，则实体不会被渲染出来。仅对本地玩家有效。 |
| SetEntityUIExtraUniforms | 客户端 | 设置可在实体shader当中使用的UI自定义变量的值，可在微软UI纸娃娃（paperdoll）及网易版纸娃娃（neteasepaperdoll)上使用identifier渲染某一类生物实体时使用。该自定义变量总共可设置EXTRA_ACTOR_UNIFORM1,EXTRA_ACTOR_UNIFORM2,EXTRA_ACTOR_UNIFORM3,EXTRA_ACTOR_UNIFORM4，总共4组，每组为一个vec4(float, float, float ,float)类型的向量，向量的默认值为(1.0,1.0,1.0,1.0)。 |
| SetHealthBarDeviation | 客户端 | 设置某个entity血条的相对高度 |
| SetNameDeeptest | 客户端 | 设置名字是否透视 |
| SetNotRenderAtAll | 客户端 | 设置是否关闭实体渲染 |
| SetRenderLocalPlayer | 客户端 | 设置本地玩家是否渲染 |
| SetShowName | 客户端 | 设置生物名字是否按照默认游戏逻辑显示（包括玩家） |
| ShowHealth | 客户端 | 设置某个entity是否显示血条，默认为显示 |
| ShowHealthBar | 客户端 | 设置是否显示血条 |
# 背包
| 接口 | 描述 | |
|---|---|---|
| GetEntityItem | 服务端 | 获取生物物品，支持获取背包，盔甲栏，副手以及主手物品 |
| GetEquItemEnchant | 服务端 | 获取装备槽位中盔甲的附魔 |
| GetEquItemModEnchant | 服务端 | 获取装备槽位中盔甲的自定义附魔 |
| SetEntityItem | 服务端 | 设置生物物品，建议开发者根据生物特性来进行设置，部分生物设置装备后可能不显示但是死亡后仍然会掉落所设置的装备 |
# 自定义属性
| 接口 | 描述 | |
|---|---|---|
| GetAttr | 服务端 | 获取SetAttr设置的属性值 |
| GetAttr | 客户端 | 获取SetAttr设置的属性值 |
| RegisterUpdateFunc | 客户端 | 注册属性值变换时的回调函数，当属性变化时会调用该函数 |
| SaveAttr | 服务端 | 保存SetAttr设置的属性值 |
| SetAttr | 服务端 | 设置属性值。服务端设置后会自动同步到客户端，可以用客户端的GetAttr获取。默认不会存档，需要存档的话可以设置needRestore=True。 |
| SetAttr | 客户端 | 设置客户端属性值 |
| UnRegisterUpdateFunc | 客户端 | 反注册属性值变换时的回调函数 |
# 自定义数据
| 接口 | 描述 | |
|---|---|---|
| CleanExtraData | 服务端 | 清除实体的自定义数据或者世界的自定义数据，清除实体数据时使用对应实体id创建组件，清除世界数据时使用levelId创建组件 |
| GetExtraData | 服务端 | 获取实体的自定义数据或者世界的自定义数据，某个键所对应的值。获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| GetWholeExtraData | 服务端 | 获取完整的实体的自定义数据或者世界的自定义数据，获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| SaveExtraData | 服务端 | 用于保存实体的自定义数据或者世界的自定义数据 |
| SetExtraData | 服务端 | 用于设置实体的自定义数据或者世界的自定义数据，数据以键值对的形式保存。设置实体数据时使用对应实体id创建组件，设置世界数据时使用levelId创建组件 |
# molang
| 接口 | 描述 | |
|---|---|---|
| EvalMolangExpression | 服务端 | 在实体上下文上执行molang表达式 |
| EvalMolangExpression | 客户端 | 在实体上下文上执行molang表达式 |
| Get | 客户端 | 获取某一个实体计算节点的值，如果不存在返回注册时的默认值 |
| GetMolangValue | 客户端 | 获取实体molang变量的值 |
| GetStringHash64 | 客户端 | 返回字符串变量的hash64 |
| Register | 客户端 | 注册实体计算节点 |
| Set | 客户端 | 设置某一个实体计算节点的值 |
| UnRegister | 客户端 | 注销实体计算节点 |
# 标签
| 接口 | 描述 | |
|---|---|---|
| AddEntityTag | 服务端 | 增加实体标签 |
| EntityHasTag | 服务端 | 判断实体是否存在某个指定的标签 |
| GetEntityTags | 服务端 | 获取实体标签列表 |
| RemoveEntityTag | 服务端 | 移除实体某个指定的标签 |
# 抛射物
| 接口 | 描述 | |
|---|---|---|
| GetSourceEntityId | 服务端 | 获取抛射物发射者实体id |
# 经验球
| 接口 | 描述 | |
|---|---|---|
| GetOrbExperience | 服务端 | 获取经验球的经验 |
| SetOrbExperience | 服务端 | 设置经验球经验 |
# 官方伙伴
| 接口 | 描述 | |
|---|---|---|
| Disable | 服务端 | 关闭官方伙伴功能，单人游戏以及本地联机不支持该接口 |
| Enable | 服务端 | 启用官方伙伴功能，单人游戏以及本地联机不支持该接口 |
# 官方聊天扩展
| 接口 | 描述 | |
|---|---|---|
| AddCommonPhrases | 服务端 | 为官方聊天扩展功能添加常用短语。单人模式下单个模组最多添加12条，联机大厅和网络服无条数限制。 |
| Disable | 服务端 | 关闭官方聊天扩展功能。需要在ClientLoadAddonsFinishServerEvent事件中调用。仅在联机大厅和网络服中生效。 |
| Enable | 服务端 | 启用官方聊天扩展功能。需要在ClientLoadAddonsFinishServerEvent事件中调用。仅在联机大厅和网络服中生效。 |
| RegisterChatPrefix | 服务端 | 为游戏内指定玩家注册聊天前缀。仅在主界面消息框和聊天界面游戏频道生效。建议在AddServerPlayerEvent事件中调用，为新玩家添加前缀。 |
| RemoveCommonPhrases | 服务端 | 为官方聊天扩展功能移除常用短语。 |
| SetShowOfficialPhrases | 服务端 | 设置是否显示官方的常用聊天短语。仅在联机大厅和网络服中生效。 |
| SetShowSocialNearbyInfo | 服务端 | 设置是否显示官方聊天社交界面中同一游戏玩家是否在附近信息。 |