---
sidebarDepth: 1
---
# 索引
包括实体属性与行为的接口，实体的获取、生成和销毁见[世界/实体管理](../世界/索引.md#实体管理)
---
- [实体类型](#实体类型)
- [附加值](#附加值)
- [属性](#属性)
- [行为](#行为)
- [状态效果](#状态效果)
- [渲染](#渲染)
- [背包](#背包)
- [自定义属性](#自定义属性)
- [自定义数据](#自定义数据)
- [molang](#molang)
- [抛射物](#抛射物)
- [经验球](#经验球)
- [官方伙伴](#官方伙伴)
- [标签](#标签)
### 实体类型
| 接口 | | 描述 |
| --- | --- | --- |
| [GetEngineType](实体类型.md#getenginetype) | 服务端 | 获取实体类型，主要用于判断实体是否属于某一类型的生物。 |
| [GetEngineType](实体类型.md#getenginetype) | 客户端 | 获取实体类型，主要用于判断实体是否属于某一类型的生物。 |
| [GetEngineTypeStr](实体类型.md#getenginetypestr) | 服务端 | 获取实体的类型名称 |
| [GetEngineTypeStr](实体类型.md#getenginetypestr) | 客户端 | 获取实体的类型名称 |
### 附加值
| 接口 | | 描述 |
| --- | --- | --- |
| [GetAuxValue](附加值.md#getauxvalue) | 服务端 | 获取射出的弓箭或投掷出的药水的附加值 |
| [GetAuxValue](附加值.md#getauxvalue) | 客户端 | 获取射出的弓箭或投掷出的药水的附加值 |
### 属性
| 接口 | | 描述 |
| --- | --- | --- |
| [ChangeEntityDimension](属性.md#changeentitydimension) | 服务端 | 传送实体 |
| [GetAttrMaxValue](属性.md#getattrmaxvalue) | 服务端 | 获取实体的引擎属性的最大值 |
| [GetAttrMaxValue](属性.md#getattrmaxvalue) | 客户端 | 获取属性最大值，包括生命值，饥饿度，移速等 |
| [GetAttrValue](属性.md#getattrvalue) | 服务端 | 获取实体的引擎属性 |
| [GetAttrValue](属性.md#getattrvalue) | 客户端 | 获取属性值，包括生命值，饥饿度，移速 |
| [GetBodyRot](属性.md#getbodyrot) | 客户端 | 获取实体的身体的角度 |
| [GetCurrentAirSupply](属性.md#getcurrentairsupply) | 服务端 | 生物当前氧气储备值 |
| [GetEntityDimensionId](属性.md#getentitydimensionid) | 服务端 | 获取实体所在维度 |
| [GetEntityOwner](属性.md#getentityowner) | 服务端 | 获取实体的属主 |
| [GetFootPos](属性.md#getfootpos) | 服务端 | 获取实体脚所在的位置 |
| [GetFootPos](属性.md#getfootpos) | 客户端 | 获取实体脚所在的位置 |
| [GetGravity](属性.md#getgravity) | 服务端 | 获取实体的重力因子，当生物重力因子为0时则应用世界的重力因子 |
| [GetMaxAirSupply](属性.md#getmaxairsupply) | 服务端 | 获取生物最大氧气储备值 |
| [GetName](属性.md#getname) | 服务端 | 获取生物的自定义名称，即使用命名牌或者SetName接口设置的名称 |
| [GetPos](属性.md#getpos) | 服务端 | 获取实体位置 |
| [GetPos](属性.md#getpos) | 客户端 | 获取实体位置 |
| [GetRot](属性.md#getrot) | 服务端 | 获取实体头与水平方向的俯仰角度和竖直方向的旋转角度，获得角度后可用GetDirFromRot接口转换为朝向的单位向量 MC坐标系说明 |
| [GetRot](属性.md#getrot) | 客户端 | 获取实体头与水平方向的俯仰角度和竖直方向的旋转角度，获得角度后可用GetDirFromRot接口转换为朝向的单位向量 MC坐标系说明 |
| [GetSize](属性.md#getsize) | 服务端 | 获取实体的包围盒 |
| [GetTypeFamily](属性.md#gettypefamily) | 服务端 | 获取生物行为包字段 type_family |
| [GetUnitBubbleAirSupply](属性.md#getunitbubbleairsupply) | 服务端 | 单位气泡数对应的氧气储备值 |
| [IsConsumingAirSupply](属性.md#isconsumingairsupply) | 服务端 | 获取生物当前是否在消耗氧气 |
| [LockLocalPlayerRot](属性.md#locklocalplayerrot) | 客户端 | 在分离摄像机时，锁定本地玩家的头部角度 |
| [SetAttrMaxValue](属性.md#setattrmaxvalue) | 服务端 | 设置实体的引擎属性的最大值 |
| [SetAttrValue](属性.md#setattrvalue) | 服务端 | 设置实体的引擎属性 |
| [SetCurrentAirSupply](属性.md#setcurrentairsupply) | 服务端 | 设置生物氧气储备值 |
| [SetEntityLookAtPos](属性.md#setentitylookatpos) | 服务端 | 设置非玩家的实体看向某个位置 |
| [SetEntityOwner](属性.md#setentityowner) | 服务端 | 设置实体的属主 |
| [SetFootPos](属性.md#setfootpos) | 服务端 | 设置实体脚底所在的位置 |
| [SetGravity](属性.md#setgravity) | 服务端 | 设置实体的重力因子，当生物重力因子为0时则应用世界的重力因子 |
| [SetMaxAirSupply](属性.md#setmaxairsupply) | 服务端 | 设置生物最大氧气储备值 |
| [SetName](属性.md#setname) | 服务端 | 用于设置生物的自定义名称，跟原版命名牌作用相同，玩家和新版流浪商人暂不支持 |
| [SetPersistent](属性.md#setpersistent) | 服务端 | 设置实体不会因为离玩家太远而被[清除](https://minecraft.fandom.com/zh/wiki/%E7%94%9F%E6%88%90#.E5.9F.BA.E5.B2.A9.E7.89.88_2) |
| [SetPlayerLookAtPos](属性.md#setplayerlookatpos) | 客户端 | 设置本地玩家看向某个位置 |
| [SetPos](属性.md#setpos) | 服务端 | 设置实体位置 |
| [SetRecoverTotalAirSupplyTime](属性.md#setrecovertotalairsupplytime) | 服务端 | 设置恢复最大氧气量的时间，单位秒 |
| [SetRot](属性.md#setrot) | 服务端 | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 MC坐标系说明 |
| [SetRot](属性.md#setrot) | 客户端 | 设置实体头与水平方向的俯仰角度和竖直方向的旋转角度 MC坐标系说明 |
| [SetSize](属性.md#setsize) | 服务端 | 设置实体的包围盒 |
| [isEntityInLava](属性.md#isentityinlava) | 客户端 | 实体是否在岩浆中 |
| [isEntityOnGround](属性.md#isentityonground) | 客户端 | 实体是否触地 |
### 行为
| 接口 | | 描述 |
| --- | --- | --- |
| [AddEntityAroundEntityMotion](行为.md#addentityaroundentitymotion) | 服务端 | 给实体（不含玩家）添加对实体环绕运动器 |
| [AddEntityAroundPointMotion](行为.md#addentityaroundpointmotion) | 服务端 | 给实体（不含玩家）添加对点环绕运动器 |
| [AddEntityTrackMotion](行为.md#addentitytrackmotion) | 服务端 | 给实体（不含玩家）添加轨迹运动器 |
| [AddEntityVelocityMotion](行为.md#addentityvelocitymotion) | 服务端 | 给实体（不含玩家）添加速度运动器 |
| [GetAttackTarget](行为.md#getattacktarget) | 服务端 | 获取仇恨目标 |
| [GetBlockControlAi](行为.md#getblockcontrolai) | 服务端 | 获取生物原生AI是否被屏蔽 |
| [GetCustomGoalCls](行为.md#getcustomgoalcls) | 服务端 | 用于获取服务器自定义行为节点的基类。实现新的行为节点时，需要继承该接口返回的类 |
| [GetEntityMotions](行为.md#getentitymotions) | 服务端 | 获取实体（不含玩家）身上的所有运动器 |
| [GetMotion](行为.md#getmotion) | 服务端 | 获取生物（含玩家）的瞬时移动方向向量 |
| [GetMotion](行为.md#getmotion) | 客户端 | 获取生物的瞬时移动方向向量 |
| [GetOwnerId](行为.md#getownerid) | 服务端 | 获取驯服生物的主人id |
| [GetStepHeight](行为.md#getstepheight) | 服务端 | 返回玩家前进非跳跃状态下能上的最大台阶高度 |
| [Hurt](行为.md#hurt) | 服务端 | 设置实体伤害 |
| [ImmuneDamage](行为.md#immunedamage) | 服务端 | 设置实体是否免疫伤害（该属性存档） |
| [IsEntityOnFire](行为.md#isentityonfire) | 服务端 | 获取实体是否着火 |
| [RemoveEntityMotion](行为.md#removeentitymotion) | 服务端 | 移除实体（不含玩家）身上的运动器 |
| [ResetAttackTarget](行为.md#resetattacktarget) | 服务端 | 清除仇恨目标 |
| [ResetMotion](行为.md#resetmotion) | 服务端 | 重置生物（不含玩家）的瞬时移动方向向量 |
| [ResetStepHeight](行为.md#resetstepheight) | 服务端 | 恢复引擎默认玩家前进非跳跃状态下能上的最大台阶高度 |
| [SetActorCollidable](行为.md#setactorcollidable) | 客户端 | 设置实体是否可碰撞 |
| [SetActorPushable](行为.md#setactorpushable) | 服务端 | 设置实体是否可推动 |
| [SetAttackTarget](行为.md#setattacktarget) | 服务端 | 设置仇恨目标 |
| [SetBlockControlAi](行为.md#setblockcontrolai) | 服务端 | 设置屏蔽生物原生AI |
| [SetCanOtherPlayerRide](行为.md#setcanotherplayerride) | 服务端 | 设置其他玩家是否有权限骑乘，True表示每个玩家都能骑乘，False只有驯服者才能骑乘 |
| [SetControl](行为.md#setcontrol) | 服务端 | 设置该生物无需装备鞍就可以控制行走跳跃 |
| [SetEntityInteractFilter](行为.md#setentityinteractfilter) | 服务端 | 设置与生物可交互的条件 |
| [SetEntityOnFire](行为.md#setentityonfire) | 服务端 | 设置实体着火 |
| [SetEntityRide](行为.md#setentityride) | 服务端 | 驯服可骑乘生物 |
| [SetEntityShareablesItems](行为.md#setentityshareablesitems) | 服务端 | 设置生物可分享/可拾取的物品列表 |
| [SetEntityTamed](行为.md#setentitytamed) | 服务端 | 设置生物驯服，需要配合 entityEvent组件使用。该类驯服不包含骑乘功能。 |
| [SetJumpPower](行为.md#setjumppower) | 服务端 | 设置生物跳跃力度，0.42表示正常水平 |
| [SetMobKnockback](行为.md#setmobknockback) | 服务端 | 设置击退的初始速度，需要考虑阻力的影响 |
| [SetMotion](行为.md#setmotion) | 服务端 | 设置生物（不含玩家）的瞬时移动方向向量 |
| [SetMotion](行为.md#setmotion) | 客户端 | 设置瞬时的移动方向向量，用于本地玩家 |
| [SetMoveSetting](行为.md#setmovesetting) | 服务端 | 寻路组件 |
| [SetPersistence](行为.md#setpersistence) | 服务端 | 设置实体是否持久化。 |
| [SetRidePos](行为.md#setridepos) | 服务端 | 设置生物骑乘位置 |
| [SetRiderRideEntity](行为.md#setriderrideentity) | 服务端 | 设置实体骑乘生物（或者船与矿车） |
| [SetStepHeight](行为.md#setstepheight) | 服务端 | 设置玩家前进非跳跃状态下能上的最大台阶高度, 默认值为0.5625，1的话表示能上一个台阶 |
| [StartEntityMotion](行为.md#startentitymotion) | 服务端 | 启动实体（不含玩家）身上的某个运动器 |
| [StopEntityMotion](行为.md#stopentitymotion) | 服务端 | 停止实体（不含玩家）身上的某个运动器 |
| [TriggerCustomEvent](行为.md#triggercustomevent) | 服务端 | 触发生物自定义事件 |
### 状态效果
| 接口 | | 描述 |
| --- | --- | --- |
| [AddEffectToEntity](状态效果.md#addeffecttoentity) | 服务端 | 为实体添加指定状态效果，如果添加的状态已存在则有以下集中情况：1、等级大于已存在则更新状态等级及持续时间；2、状态等级相等且剩余时间duration大于已存在则刷新剩余时间；3、等级小于已存在则不做修改；4、粒子效果以新的为准 |
| [GetAllEffects](状态效果.md#getalleffects) | 服务端 | 获取实体当前所有状态效果 |
| [RemoveEffectFromEntity](状态效果.md#removeeffectfromentity) | 服务端 | 为实体删除指定状态效果 |
### 渲染
| 接口 | | 描述 |
| --- | --- | --- |
| [AddActorAnimation](渲染.md#addactoranimation) | 客户端 | 增加生物渲染动画 |
| [AddActorAnimationController](渲染.md#addactoranimationcontroller) | 客户端 | 增加生物渲染动画控制器 |
| [AddActorBlockGeometry](渲染.md#addactorblockgeometry) | 客户端 | 为实体添加方块几何体模型。 |
| [AddActorGeometry](渲染.md#addactorgeometry) | 客户端 | 增加生物渲染几何体 |
| [AddActorParticleEffect](渲染.md#addactorparticleeffect) | 客户端 | 增加生物特效资源 |
| [AddActorRenderController](渲染.md#addactorrendercontroller) | 客户端 | 增加生物渲染控制器 |
| [AddActorRenderControllerArray](渲染.md#addactorrendercontrollerarray) | 客户端 | 增加生物渲染控制器列表中字典arrays元素 |
| [AddActorRenderMaterial](渲染.md#addactorrendermaterial) | 客户端 | 增加生物渲染需要的材质 |
| [AddActorScriptAnimate](渲染.md#addactorscriptanimate) | 客户端 | 在生物的客户端实体定义（minecraft:client_entity）json中的scripts/animate节点添加动画/动画控制器 |
| [AddActorSoundEffect](渲染.md#addactorsoundeffect) | 客户端 | 增加生物音效资源 |
| [AddActorTexture](渲染.md#addactortexture) | 客户端 | 增加生物渲染贴图 |
| [BindEntityToEntity](渲染.md#bindentitytoentity) | 客户端 | 绑定骨骼模型跟随其他entity,摄像机也跟随其他entity |
| [ClearActorBlockGeometry](渲染.md#clearactorblockgeometry) | 客户端 | 删除实体中所有的方块几何体模型。 |
| [DeleteActorBlockGeometry](渲染.md#deleteactorblockgeometry) | 客户端 | 删除实体中指定方块几何体模型。 |
| [GetNotRenderAtAll](渲染.md#getnotrenderatall) | 客户端 | 获取实体是否不渲染 |
| [RebuildActorRender](渲染.md#rebuildactorrender) | 客户端 | 重建生物的数据渲染器（该接口不支持玩家，玩家请使用RebuildPlayerRender） |
| [RemoveActorAnimationController](渲染.md#removeactoranimationcontroller) | 客户端 | 移除生物渲染动画控制器 |
| [RemoveActorGeometry](渲染.md#removeactorgeometry) | 客户端 | 删除生物渲染几何体 |
| [RemoveActorRenderController](渲染.md#removeactorrendercontroller) | 客户端 | 删除生物渲染控制器 |
| [RemoveActorTexture](渲染.md#removeactortexture) | 客户端 | 删除生物渲染贴图 |
| [ResetBindEntity](渲染.md#resetbindentity) | 客户端 | 取消目标entity的绑定实体，取消后不再跟随任何其他entity |
| [SetActorAllBlockGeometryVisible](渲染.md#setactorallblockgeometryvisible) | 客户端 | 设置实体中所有的方块几何体模型是否显示。 |
| [SetActorBlockGeometryVisible](渲染.md#setactorblockgeometryvisible) | 客户端 | 设置实体中指定的方块几何体模型是否显示。 |
| [SetAlwaysShowName](渲染.md#setalwaysshowname) | 客户端 | 设置生物名字是否一直显示，瞄准点不指向生物时也能显示 |
| [SetColor](渲染.md#setcolor) | 客户端 | 设置血条的颜色及背景色 |
| [SetHealthBarDeviation](渲染.md#sethealthbardeviation) | 客户端 | 设置某个entity血条的相对高度 |
| [SetNameDeeptest](渲染.md#setnamedeeptest) | 客户端 | 设置名字是否透视 |
| [SetNotRenderAtAll](渲染.md#setnotrenderatall) | 客户端 | 设置是否关闭实体渲染 |
| [SetRenderLocalPlayer](渲染.md#setrenderlocalplayer) | 客户端 | 设置本地玩家是否渲染 |
| [SetShowName](渲染.md#setshowname) | 客户端 | 设置生物名字是否按照默认游戏逻辑显示 |
| [ShowHealth](渲染.md#showhealth) | 客户端 | 设置某个entity是否显示血条，默认为显示 |
| [ShowHealthBar](渲染.md#showhealthbar) | 客户端 | 设置是否显示血条 |
### 背包
| 接口 | | 描述 |
| --- | --- | --- |
| [GetEntityItem](背包.md#getentityitem) | 服务端 | 获取生物物品，支持获取背包，盔甲栏，副手以及主手物品 |
| [GetEquItemEnchant](背包.md#getequitemenchant) | 服务端 | 获取装备槽位中盔甲的附魔 |
| [GetEquItemModEnchant](背包.md#getequitemmodenchant) | 服务端 | 获取装备槽位中盔甲的自定义附魔 |
| [SetEntityItem](背包.md#setentityitem) | 服务端 | 设置生物物品，建议开发者根据生物特性来进行设置，部分生物设置装备后可能不显示但是死亡后仍然会掉落所设置的装备 |
### 自定义属性
| 接口 | | 描述 |
| --- | --- | --- |
| [GetAttr](自定义属性.md#getattr) | 服务端 | 获取属性值 |
| [GetAttr](自定义属性.md#getattr) | 客户端 | 获取属性值 |
| [RegisterUpdateFunc](自定义属性.md#registerupdatefunc) | 客户端 | 注册属性值变换时的回调函数，当属性变化时会调用该函数 |
| [SetAttr](自定义属性.md#setattr) | 服务端 | 设置属性值 |
| [SetAttr](自定义属性.md#setattr) | 客户端 | 设置客户端属性值 |
| [UnRegisterUpdateFunc](自定义属性.md#unregisterupdatefunc) | 客户端 | 反注册属性值变换时的回调函数 |
### 自定义数据
| 接口 | | 描述 |
| --- | --- | --- |
| [CleanExtraData](自定义数据.md#cleanextradata) | 服务端 | 清除实体的自定义数据或者世界的自定义数据，清除实体数据时使用对应实体id创建组件，清除世界数据时使用levelId创建组件 |
| [GetExtraData](自定义数据.md#getextradata) | 服务端 | 获取实体的自定义数据或者世界的自定义数据，某个键所对应的值。获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| [GetWholeExtraData](自定义数据.md#getwholeextradata) | 服务端 | 获取完整的实体的自定义数据或者世界的自定义数据，获取实体数据时使用对应实体id创建组件，获取世界数据时使用levelId创建组件 |
| [SaveExtraData](自定义数据.md#saveextradata) | 服务端 | 用于保存实体的自定义数据或者世界的自定义数据 |
| [SetExtraData](自定义数据.md#setextradata) | 服务端 | 用于设置实体的自定义数据或者世界的自定义数据，数据以键值对的形式保存。设置实体数据时使用对应实体id创建组件，设置世界数据时使用levelId创建组件 |
### molang
| 接口 | | 描述 |
| --- | --- | --- |
| [Get](molang.md#get) | 客户端 | 获取某一个实体计算节点的值，如果不存在返回注册时的默认值 |
| [GetMolangValue](molang.md#getmolangvalue) | 客户端 | 获取实体molang变量的值 |
| [GetStringHash64](molang.md#getstringhash64) | 客户端 | 返回字符串变量的hash64 |
| [Register](molang.md#register) | 客户端 | 注册实体计算节点 |
| [Set](molang.md#set) | 客户端 | 设置某一个实体计算节点的值 |
| [UnRegister](molang.md#unregister) | 客户端 | 注销实体计算节点 |
### 抛射物
| 接口 | | 描述 |
| --- | --- | --- |
| [GetSourceEntityId](抛射物.md#getsourceentityid) | 服务端 | 获取抛射物发射者实体id |
### 经验球
| 接口 | | 描述 |
| --- | --- | --- |
| [GetOrbExperience](经验球.md#getorbexperience) | 服务端 | 获取经验球的经验 |
| [SetOrbExperience](经验球.md#setorbexperience) | 服务端 | 设置经验球经验 |
### 官方伙伴
| 接口 | | 描述 |
| --- | --- | --- |
| [Disable](官方伙伴.md#disable) | 服务端 | 关闭官方伙伴功能，单人游戏以及本地联机不支持该接口 |
| [Enable](官方伙伴.md#enable) | 服务端 | 启用官方伙伴功能，单人游戏以及本地联机不支持该接口 |
### 标签
| 接口 | | 描述 |
| --- | --- | --- |
| [AddEntityTag](标签.md#addentitytag) | 服务端 | 增加实体标签 |
| [EntityHasTag](标签.md#entityhastag) | 服务端 | 判断实体是否存在某个指定的标签 |
| [GetEntityTags](标签.md#getentitytags) | 服务端 | 获取实体标签列表 |
| [RemoveEntityTag](标签.md#removeentitytag) | 服务端 | 移除实体某个指定的标签 |