---
sidebarDepth: 1
---
# 索引
包括玩家属性与行为的接口,玩家的获取见[世界/实体管理](../世界/索引.md#实体管理)。玩家也属于实体,因此[实体](../实体/索引.md)分类下的接口同样适用于玩家
---
- [属性](#属性)
- [行为](#行为)
- [渲染](#渲染)
- [背包](#背包)
- [摄像机](#摄像机)
- [动画](#动画)
- [游戏模式](#游戏模式)
- [权限](#权限)
- [导航](#导航)
### 属性
| 接口 |
| 描述 |
| --- | --- | --- |
| [AddPlayerExperience](属性.md#addplayerexperience) | 服务端 | 增加玩家经验值 |
| [AddPlayerLevel](属性.md#addplayerlevel) | 服务端 | 修改玩家等级 |
| [CollectOnlineClientData](属性.md#collectonlineclientdata) | 服务端 | 收集在线玩家客户端数据,用于判断玩家是否作弊 |
| [GetPlayerExp](属性.md#getplayerexp) | 服务端 | 获取玩家当前等级下的经验值 |
| [GetPlayerHealthLevel](属性.md#getplayerhealthlevel) | 服务端 | 获取玩家健康临界值,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效。原版默认值为18 |
| [GetPlayerHealthTick](属性.md#getplayerhealthtick) | 服务端 | 获取玩家自然恢复速度,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效。原版默认值为80刻(即每4秒)恢复1点血量 |
| [GetPlayerHunger](属性.md#getplayerhunger) | 服务端 | 获取玩家饥饿度,展示在UI饥饿度进度条上,初始值为20,即每一个鸡腿代表2个饥饿度。 **饱和度(saturation)** :玩家当前饱和度,初始值为5,最大值始终为玩家当前饥饿度(hunger),该值直接影响玩家**饥饿度(hunger)**。
1)增加方法:吃食物。
2)减少方法:每触发一次**消耗事件**,该值减少1,如果该值不大于0,直接把玩家 **饥饿度(hunger)** 减少1。 |
| [GetPlayerLevel](属性.md#getplayerlevel) | 服务端 | 获取玩家等级 |
| [GetPlayerMaxExhaustionValue](属性.md#getplayermaxexhaustionvalue) | 服务端 | 获取玩家foodExhaustionLevel的归零值,常量值,默认为4。**消耗度(exhaustion)**是指玩家当前消耗度水平,初始值为0,该值会随着玩家一系列动作(如跳跃)的影响而增加,当该值大于最大消耗度(maxExhaustion)后归零,并且把饱和度(saturation)减少1(为了说明饥饿度机制,我们将此定义为**消耗事件**) |
| [GetPlayerStarveLevel](属性.md#getplayerstarvelevel) | 服务端 | 获取玩家饥饿临界值,当饥饿值小于饥饿临界值时会自动扣除血量,开启饥饿值且开启饥饿掉血时有效。原版默认值为1 |
| [GetPlayerStarveTick](属性.md#getplayerstarvetick) | 服务端 | 获取玩家饥饿掉血速度,当饥饿值小于饥饿临界值时会自动扣除血量,开启饥饿值且开启饥饿掉血时有效。原版默认值为80刻(即每4秒)扣除1点血量 |
| [GetPlayerTotalExp](属性.md#getplayertotalexp) | 服务端 | 获取玩家的总经验值 |
| [IsPlayerNaturalRegen](属性.md#isplayernaturalregen) | 服务端 | 是否开启玩家自然恢复,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效。原版默认开启 |
| [IsPlayerNaturalStarve](属性.md#isplayernaturalstarve) | 服务端 | 是否开启玩家饥饿掉血,当饥饿值小于饥饿临界值时会自动恢复血量,开启饥饿值且开启饥饿掉血时有效。原版默认开启 |
| [SetPlayerHealthLevel](属性.md#setplayerhealthlevel) | 服务端 | 设置玩家健康临界值,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效.原版默认值为18 |
| [SetPlayerHealthTick](属性.md#setplayerhealthtick) | 服务端 | 设置玩家自然恢复速度,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效.原版默认值为80刻(即每4秒)恢复1点血量 |
| [SetPlayerHunger](属性.md#setplayerhunger) | 服务端 | 设置玩家饥饿度。 |
| [SetPlayerMaxExhaustionValue](属性.md#setplayermaxexhaustionvalue) | 服务端 | 设置玩家**最大消耗度(maxExhaustion)**,通过调整 **最大消耗度(maxExhaustion)** 的大小,就可以调整 **饥饿度(hunger)** 的消耗速度,当 **最大消耗度(maxExhaustion)** 很大时,饥饿度可以看似一直不下降 |
| [SetPlayerNaturalRegen](属性.md#setplayernaturalregen) | 服务端 | 设置是否开启玩家自然恢复,当饥饿值大于等于健康临界值时会自动恢复血量,开启饥饿值且开启自然恢复时有效.原版默认开启 |
| [SetPlayerNaturalStarve](属性.md#setplayernaturalstarve) | 服务端 | 设置是否开启玩家饥饿掉血,当饥饿值小于饥饿临界值时会自动扣除血量,开启饥饿值且开启饥饿掉血时有效.原版默认开启 |
| [SetPlayerPrefixAndSuffixName](属性.md#setplayerprefixandsuffixname) | 服务端 | 设置玩家前缀和后缀名字 |
| [SetPlayerStarveLevel](属性.md#setplayerstarvelevel) | 服务端 | 设置玩家饥饿临界值,当饥饿值小于饥饿临界值时会自动扣除血量,开启饥饿值且开启饥饿掉血时有效。原版默认值为1 |
| [SetPlayerStarveTick](属性.md#setplayerstarvetick) | 服务端 | 设置玩家饥饿掉血速度,当饥饿值小于饥饿临界值时会自动扣除血量,开启饥饿值且开启饥饿掉血时有效.原版默认值为80刻(即每4秒)扣除1点血量 |
| [SetPlayerTotalExp](属性.md#setplayertotalexp) | 服务端 | 设置玩家的总经验值 |
| [Swing](属性.md#swing) | 客户端 | 本地玩家播放原版攻击动作 |
| [getUid](属性.md#getuid) | 客户端 | 获取本地玩家的uid |
### 行为
| 接口 | | 描述 |
| --- | --- | --- |
| [AddPlayerAroundEntityMotion](行为.md#addplayeraroundentitymotion) | 服务端 | 给玩家添加对实体环绕运动器 |
| [AddPlayerAroundPointMotion](行为.md#addplayeraroundpointmotion) | 服务端 | 给玩家添加对点环绕运动器 |
| [AddPlayerTrackMotion](行为.md#addplayertrackmotion) | 服务端 | 给玩家添加轨迹运动器 |
| [AddPlayerVelocityMotion](行为.md#addplayervelocitymotion) | 服务端 | 给玩家添加速度运动器 |
| [BeginSprinting](行为.md#beginsprinting) | 客户端 | 使本地玩家进入并保持向前冲刺状态 |
| [ChangePlayerDimension](行为.md#changeplayerdimension) | 服务端 | 传送玩家 |
| [ChangePlayerFlyState](行为.md#changeplayerflystate) | 服务端 | 给予/取消飞行能力,并且进入飞行/非飞行状态 |
| [EnableKeepInventory](行为.md#enablekeepinventory) | 服务端 | 设置玩家死亡不掉落物品 |
| [EndSprinting](行为.md#endsprinting) | 客户端 | 使本地玩家结束向前冲刺状态 |
| [GetEntityRider](行为.md#getentityrider) | 服务端 | 获取玩家正在骑乘的实体的id。 |
| [GetIsBlocking](行为.md#getisblocking) | 服务端 | 获取玩家激活盾牌状态 |
| [GetPlayerExhaustionRatioByType](行为.md#getplayerexhaustionratiobytype) | 服务端 | 获取玩家某行为饥饿度消耗倍率 |
| [GetPlayerMotions](行为.md#getplayermotions) | 服务端 | 获取玩家身上的所有运动器 |
| [GetPlayerRespawnPos](行为.md#getplayerrespawnpos) | 服务端 | 获取玩家复活点 |
| [GetRelevantPlayer](行为.md#getrelevantplayer) | 服务端 | 获取附近玩家id列表 |
| [IsEntityRiding](行为.md#isentityriding) | 服务端 | 检查玩家是否骑乘。 |
| [IsPlayerFlying](行为.md#isplayerflying) | 服务端 | 获取玩家是否在飞行 |
| [PickUpItemEntity](行为.md#pickupitementity) | 服务端 | 某个Player拾取物品ItemEntity |
| [PlayerDestoryBlock](行为.md#playerdestoryblock) | 服务端 | 使用手上工具破坏方块 |
| [PlayerUseItemToEntity](行为.md#playeruseitemtoentity) | 服务端 | 玩家使用手上物品对某个生物使用 |
| [PlayerUseItemToPos](行为.md#playeruseitemtopos) | 服务端 | 玩家对某个坐标使用物品 |
| [RemovePlayerMotion](行为.md#removeplayermotion) | 服务端 | 移除玩家身上的运动器 |
| [SetPickUpArea](行为.md#setpickuparea) | 服务端 | 设置玩家的拾取物品范围,设置后该玩家的拾取物品范围会在原版拾取范围的基础上进行改变。 |
| [SetPlayerAttackSpeedAmplifier](行为.md#setplayerattackspeedamplifier) | 服务端 | 设置玩家攻击速度倍数,1.0表示正常水平,1.2表示速度减益20%,0.8表示速度增益20% |
| [SetPlayerExhaustionRatioByType](行为.md#setplayerexhaustionratiobytype) | 服务端 | 设置玩家某行为饥饿度消耗倍率 |
| [SetPlayerJumpable](行为.md#setplayerjumpable) | 服务端 | 设置玩家是否可跳跃 |
| [SetPlayerMovable](行为.md#setplayermovable) | 服务端 | 设置玩家是否可移动 |
| [SetPlayerRespawnPos](行为.md#setplayerrespawnpos) | 服务端 | 设置玩家复活的位置与维度 |
| [SetPlayerRideEntity](行为.md#setplayerrideentity) | 服务端 | 设置玩家骑乘生物(或者船与矿车) |
| [StartPlayerMotion](行为.md#startplayermotion) | 服务端 | 启动玩家身上的某个运动器 |
| [StopEntityRiding](行为.md#stopentityriding) | 服务端 | 强制玩家下坐骑。 |
| [StopPlayerMotion](行为.md#stopplayermotion) | 服务端 | 停止玩家身上的某个运动器 |
| [isGliding](行为.md#isgliding) | 客户端 | 是否鞘翅飞行 |
| [isInWater](行为.md#isinwater) | 客户端 | 是否在水中 |
| [isMoving](行为.md#ismoving) | 客户端 | 是否在行走 |
| [isRiding](行为.md#isriding) | 客户端 | 是否骑乘 |
| [isSneaking](行为.md#issneaking) | 服务端 | 获取玩家是否处于潜行状态 |
| [isSneaking](行为.md#issneaking) | 客户端 | 是否潜行 |
| [isSprinting](行为.md#issprinting) | 客户端 | 是否在疾跑 |
| [isSwimming](行为.md#isswimming) | 服务端 | 获取玩家是否处于游泳状态。 |
| [isSwimming](行为.md#isswimming) | 客户端 | 是否游泳 |
| [setMoving](行为.md#setmoving) | 客户端 | 设置是否行走,只能设置本地玩家(只适用于移动端) |
| [setSneaking](行为.md#setsneaking) | 客户端 | 设置是否潜行,只能设置本地玩家(只适用于移动端) |
| [setSprinting](行为.md#setsprinting) | 客户端 | 设置是否疾跑,只能设置本地玩家(只适用于移动端) |
| [setUsingShield](行为.md#setusingshield) | 客户端 | 激活盾牌状态 |
### 渲染
| 接口 | | 描述 |
| --- | --- | --- |
| [AddPlayerAnimation](渲染.md#addplayeranimation) | 客户端 | 增加玩家渲染动画 |
| [AddPlayerAnimationController](渲染.md#addplayeranimationcontroller) | 客户端 | 增加玩家渲染动画控制器 |
| [AddPlayerAnimationIntoState](渲染.md#addplayeranimationintostate) | 客户端 | 在玩家的动画控制器中的状态添加动画 |
| [AddPlayerGeometry](渲染.md#addplayergeometry) | 客户端 | 增加玩家渲染几何体 |
| [AddPlayerParticleEffect](渲染.md#addplayerparticleeffect) | 客户端 | 增加玩家特效资源 |
| [AddPlayerRenderController](渲染.md#addplayerrendercontroller) | 客户端 | 增加玩家渲染控制器 |
| [AddPlayerRenderMaterial](渲染.md#addplayerrendermaterial) | 客户端 | 增加玩家渲染需要的材质 |
| [AddPlayerSoundEffect](渲染.md#addplayersoundeffect) | 客户端 | 增加玩家音效资源 |
| [AddPlayerTexture](渲染.md#addplayertexture) | 客户端 | 增加玩家渲染贴图 |
| [RebuildPlayerRender](渲染.md#rebuildplayerrender) | 客户端 | 重建玩家的数据渲染器 |
| [RemovePlayerAnimationController](渲染.md#removeplayeranimationcontroller) | 客户端 | 移除玩家渲染动画控制器 |
| [RemovePlayerGeometry](渲染.md#removeplayergeometry) | 客户端 | 删除玩家渲染几何体 |
| [RemovePlayerRenderController](渲染.md#removeplayerrendercontroller) | 客户端 | 删除玩家渲染控制器 |
| [SetPlayerItemInHandVisible](渲染.md#setplayeriteminhandvisible) | 客户端 | 设置是否隐藏玩家的手持物品模型显示 |
| [SetSkin](渲染.md#setskin) | 客户端 | 更换原版自定义皮肤 |
### 背包
| 接口 | | 描述 |
| --- | --- | --- |
| [AddEnchantToInvItem](背包.md#addenchanttoinvitem) | 服务端 | 给物品栏的物品添加附魔信息 |
| [AddModEnchantToInvItem](背包.md#addmodenchanttoinvitem) | 服务端 | 给物品栏中物品添加自定义附魔信息 |
| [ChangePlayerItemTipsAndExtraId](背包.md#changeplayeritemtipsandextraid) | 服务端 | 修改玩家物品的自定义tips和自定义标识符 |
| [ChangeSelectSlot](背包.md#changeselectslot) | 服务端 | 设置玩家当前选中快捷栏物品的index |
| [GetCarriedItem](背包.md#getcarrieditem) | 客户端 | 获取右手物品的信息 |
| [GetInvItemEnchantData](背包.md#getinvitemenchantdata) | 服务端 | 获取物品栏的物品附魔信息 |
| [GetInvItemModEnchantData](背包.md#getinvitemmodenchantdata) | 服务端 | 获取物品栏的物品自定义附魔信息 |
| [GetOffhandItem](背包.md#getoffhanditem) | 客户端 | 获取左手物品的信息 |
| [GetPlayerAllItems](背包.md#getplayerallitems) | 服务端 | 获取玩家指定的槽位的批量物品信息 |
| [GetPlayerItem](背包.md#getplayeritem) | 服务端 | 获取玩家物品,支持获取背包,盔甲栏,副手以及主手物品 |
| [GetSelectSlotId](背包.md#getselectslotid) | 服务端 | 获取玩家当前选中槽位 |
| [GetSlotId](背包.md#getslotid) | 客户端 | 获取当前手持的快捷栏的槽id |
| [RemoveEnchantToInvItem](背包.md#removeenchanttoinvitem) | 服务端 | 给物品栏的物品移除附魔信息 |
| [RemoveModEnchantToInvItem](背包.md#removemodenchanttoinvitem) | 服务端 | 给物品栏中物品移除自定义附魔信息 |
| [SetInvItemExchange](背包.md#setinvitemexchange) | 服务端 | 交换玩家背包物品 |
| [SetInvItemNum](背包.md#setinvitemnum) | 服务端 | 设置玩家背包物品数目 |
| [SetPlayerAllItems](背包.md#setplayerallitems) | 服务端 | 添加批量物品信息到指定槽位 |
| [SpawnItemToPlayerCarried](背包.md#spawnitemtoplayercarried) | 服务端 | 生成物品到玩家右手 |
| [SpawnItemToPlayerInv](背包.md#spawnitemtoplayerinv) | 服务端 | 生成物品到玩家背包 |
### 摄像机
| 接口 | | 描述 |
| --- | --- | --- |
| [DepartCamera](摄像机.md#departcamera) | 客户端 | 分离玩家与摄像机 |
| [GetCameraAnchor](摄像机.md#getcameraanchor) | 客户端 | 获取相机锚点 |
| [GetCameraOffset](摄像机.md#getcameraoffset) | 客户端 | 获取摄像机偏移量 |
| [GetCameraPitchLimit](摄像机.md#getcamerapitchlimit) | 客户端 | 获取摄像机上下角度限制值 |
| [GetCameraRot](摄像机.md#getcamerarot) | 客户端 | 获取相机转向 |
| [GetForward](摄像机.md#getforward) | 客户端 | 返回相机向前的方向 |
| [GetFov](摄像机.md#getfov) | 客户端 | 获取视野大小 |
| [GetFpHeight](摄像机.md#getfpheight) | 客户端 | 获取本地玩家当前状态下,第一人称视角时的摄像机高度偏移量。游泳时,滑翔时以及普通状态下会有所不同 |
| [GetPerspective](摄像机.md#getperspective) | 客户端 | 获取当前的视角模式 |
| [GetPosition](摄像机.md#getposition) | 客户端 | 返回相机中心 |
| [IsModCameraLockPitch](摄像机.md#ismodcameralockpitch) | 客户端 | 是否锁定摄像机上下角度 |
| [IsModCameraLockYaw](摄像机.md#ismodcameralockyaw) | 客户端 | 是否锁定摄像机左右角度 |
| [LockCamera](摄像机.md#lockcamera) | 客户端 | 锁定摄像机 |
| [LockModCameraPitch](摄像机.md#lockmodcamerapitch) | 客户端 | 锁定摄像机上下角度(第三人称下生效,锁定后不能上下调整视角) |
| [LockModCameraYaw](摄像机.md#lockmodcamerayaw) | 客户端 | 锁定摄像机左右角度(第三人称下生效,锁定后不能通过鼠标左右调整视角) |
| [LockPerspective](摄像机.md#lockperspective) | 客户端 | 锁定玩家的视角模式 |
| [ResetCameraBindActorId](摄像机.md#resetcamerabindactorid) | 客户端 | 将摄像机重新绑定回主角身上 |
| [SetCameraAnchor](摄像机.md#setcameraanchor) | 客户端 | 设置相机锚点,暂时只支持高度,其他维度无效 |
| [SetCameraBindActorId](摄像机.md#setcamerabindactorid) | 客户端 | 将摄像机绑定到目标实体身上(调用者与目标必须在同一个dimension,同时需要在加载范围之内,若绑定后目标离开了范围或者死亡,则会自动解除绑定) |
| [SetCameraOffset](摄像机.md#setcameraoffset) | 客户端 | 设置摄像机偏移量 |
| [SetCameraPitchLimit](摄像机.md#setcamerapitchlimit) | 客户端 | 设置摄像机上下角度限制值,默认是(-90,90) |
| [SetCameraPos](摄像机.md#setcamerapos) | 客户端 | 设置相机中心的位置 |
| [SetCameraRot](摄像机.md#setcamerarot) | 客户端 | 设定相机转向 |
| [SetFov](摄像机.md#setfov) | 客户端 | 设置视野大小 |
| [SetPerspective](摄像机.md#setperspective) | 客户端 | 设置视角模式 |
| [SetSpeedFovLock](摄像机.md#setspeedfovlock) | 客户端 | 是否锁定相机视野fov,锁定后不随速度变化而变化 |
| [UnDepartCamera](摄像机.md#undepartcamera) | 客户端 | 绑定玩家与摄像机 |
| [UnLockCamera](摄像机.md#unlockcamera) | 客户端 | 解除摄像机锁定 |
### 动画
| 接口 | | 描述 |
| --- | --- | --- |
| [PlayTpAnimation](动画.md#playtpanimation) | 客户端 | 第三人称视角播放玩家通用动作 |
| [StopAnimation](动画.md#stopanimation) | 客户端 | 停止播放玩家通用动作 |
### 游戏模式
| 接口 | | 描述 |
| --- | --- | --- |
| [GetPlayerGameType](游戏模式.md#getplayergametype) | 服务端 | 获取指定玩家的游戏模式 |
| [SetPlayerGameType](游戏模式.md#setplayergametype) | 服务端 | 设置玩家个人游戏模式 |
### 权限
| 接口 | | 描述 |
| --- | --- | --- |
| [GetPlayerAbilities](权限.md#getplayerabilities) | 服务端 | 获取玩家具体权限 |
| [GetPlayerOperation](权限.md#getplayeroperation) | 服务端 | 获取玩家权限类型信息 |
### 导航
| 接口 | | 描述 |
| --- | --- | --- |
| [GetNavPath](导航.md#getnavpath) | 客户端 | 获取本地玩家到目标点的寻路路径,开发者可以通过该接口定制自定义的导航系统。 |
| [StartNavTo](导航.md#startnavto) | 客户端 | 我们提供了一个基于GetNavPath的导航系统实现,做法是在路径上生成序列帧以引导玩家通向目标点,并且当玩家偏离路径会重新进行导航。 |
| [StopNav](导航.md#stopnav) | 客户端 | 终止当前的导航 |