玩家API

玩家通用模块（PlayerUtils）

通用常量

常量	类型	值	描述
PlayerUtils.GRAVITY	double	0.40625	玩家默认重力加速度。
PlayerUtils.MAX_SPEED	double	3.0	玩家默认最大速度。
PlayerUtils.MAX_FALL_SPEED	double	12.0	玩家默认最大下落速度。
PlayerUtils.JUMP_TIME	int	19	玩家默认跳跃上升持续时间。
PlayerUtils.JUMP_SPEED	double	5.3	玩家默认跳跃上升速度。
PlayerUtils.DEFAULT_MAX_HEALTH	int	100	玩家默认最大生命值。
PlayerUtils.DEFAULT_MAX_MANA	int	100	玩家默认最大魔法值。

通用函数

函数	返回值	描述
PlayerUtils.SearchByRect(double x, double y, int width, int height)	ArrayList<Player>	返回包含于指定矩形区域内部的所有玩家列表。
PlayerUtils.SearchByCircle(double centerX, double centerY, int radius)	ArrayList<Player>	返回包含于指定圆形区域内部的所有玩家列表。
PlayerUtils.SearchNearestPlayer(double centerX, double centerY, int radius, bool noCrossTiles = false)	Player/nil	搜索在指定圆形区域内部距离圆心最近的玩家，返回该玩家。若结果不存在，返回nil。noCrossTiles表示是否排除中心到圆心的连线被图格遮挡的玩家。

玩家类（Player Class，继承自Entity Class）

玩家（Player）类表示玩家实际控制的角色实体类。

父类

该类的父类为Entity类。可直接使用该父类的类成员属性与类成员函数。

由于玩家类的特殊性，该父类的所有【类成员属性全部只读】。

类成员属性

控制器属性

属性	类型	描述
Player.defaultMaxSpeed	double	【只读】玩家默认最大运动速度。
Player.speedRate	double	玩家最大运动速度与默认最大运动速度比率。每帧重置为1.0。
Player.defaultJumpTime	int	【只读】玩家默认跳跃持续上升时间。
Player.jumpRate	double	玩家跳跃持续上升时间与默认跳跃持续上升时间比率。每帧重置为1.0。
Player.defaultJumpSpeed	double	【只读】玩家默认跳跃上升速度。
Player.jumpSpeedRate	double	玩家跳跃上升速度与默认跳跃上升速度比率。每帧重置为1.0。
Player.defaultFallSpeed	double	【只读】玩家默认最大下落速度。
Player.fallSpeedRate	double	玩家最大下落速度与默认最大下落速度比率。每帧重置为1.0。
Player.digSpeedRate	double	玩家挖掘速度与原始挖掘速度比率。每帧重置为1.0。
Player.isCurrentClientPlayer	bool	【只读】玩家是否为当前客户端所操作的玩家。若当前运行环境为服务端总是表示false。

数值属性

属性	类型	描述
Player.name	string	【只读】玩家名称。（UTF8格式）
Player.ip	string	【只读】玩家连接会话的IP地址。（UTF8格式） 在客户端中该值总是表示为空字符串。
Player.portNumber	int	【只读】玩家连接会话的端口号。 在客户端中该值总是表示为0。
Player.health	int	【只读】玩家生命值。
Player.maxHealth	int	【只读】玩家生命值上限。
Player.maxMaxHealth	int	【只读】玩家最高能达到的生命值上限。
Player.mana	int	【只读】玩家魔法值。
Player.maxMana	int	【只读】玩家魔法值上限。
Player.maxMaxMana	int	【只读】玩家最高能达到的魔法值上限。
Player.expLevel	int	【只读】玩家经验等级。
Player.isNoBreathing	bool	【只读】玩家当前是否不能呼吸。
Player.breath	double	【只读】玩家呼吸值。有效范围为[0.0, 1.0]。当呼吸值为0.0时会产生窒息伤害。
Player.foodLevel	int	【只读】玩家饥饿值。有效范围为[1, 100]。当饥饿值为0时会产生饥饿伤害。
Player.foodSaturationLevel	int	【只读】玩家食物饱和度。有效范围为[1, 100]。当前食物饱和度不会超过当前饥饿值。
Player.baseAttack	Attack	玩家的基础攻击属性。
Player.baseDefence	Defence	玩家的基础防御属性。
Player.inLiquid	bool	【只读】当前玩家是否处在流体环境中。
Player.oldInLiquid	bool	【只读】上一帧的玩家是否处在流体环境中。
Player.touchLiquidID	int	【只读】当前玩家所处流体环境的ID。如果不在任何流体内，则ID总是为0。
Player.isInvisibility	bool	玩家是否隐身。（每帧重置为false）

权限属性

属性	类型	描述
Player.gameMode	int	【只读】玩家游戏模式。
Player.op	int	【只读】玩家权限等级。

类成员函数

控制函数

函数	返回值	描述
Player:SetSpeedX(double speedX)	void	设定玩家的横向速度。（对所控制的玩家生效）
Player:SetSpeedY(double speedY)	void	设定玩家的纵向速度。（对所控制的玩家生效）

其他函数

函数	返回值	描述
Player:Strike(DeathReason reason, Attack attack, double hitAngle = 0, bool immune = false, bool hurtSound = true)	void	伤害当前玩家。reason表示死亡原因，attack表示当前伤害属性，hitAngle表示产生伤害的角度，immune表示产生当前伤害后是否让玩家处于无敌帧状态，hurtSound表示是否播放玩家受伤音效。
Player:StrikeFromNpcWeapon(Npc npc, ItemSlot weaponItemSlot, Attack attack, double hitAngle = 0, bool immune = false, bool hurtSound = true)	void	指定NPC使用武器伤害当前玩家。npc表示造成伤害的NPC，weaponItemSlot表示NPC所用的武器物品格子。
Player:StrikeFromPlayerWeapon(Player player, ItemSlot weaponItemSlot, Attack attack, double hitAngle = 0, bool immune = false, bool hurtSound = true)	void	指定玩家使用武器伤害当前玩家。player表示造成伤害的玩家，weaponItemSlot表示玩家所用的武器物品格子。
Player:Heal(int heal, bool showTip = true)	void	增加生命值。showTip表示是否显示数字提示。
Player:AddMagic(int heal, bool showTip = true)	void	增加魔法值。showTip表示是否显示数字提示。
Player:AddMaxHealth(int health)	void	增加生命值上限。
Player:AddMaxMagic(int magic)	void	增加魔法值上限。
Player:AddExperience(int amount)	void	增加经验值。
Player:RemoveExpLevel(int level)	void	减少经验等级。
Player:AddBreath(double breath)	void	增加呼吸值。
Player:DecBreath(double breath)	void	减少呼吸值。
Player:SetBreath(double breath)	void	设定呼吸值。
Player:AddFood(int foodLevel, int foodSaturationLevel)	void	增加饥饿值和食物饱和度。
Player:DecFood(int foodLevel, int foodSaturationLevel = 0)	void	减少饥饿值和食物饱和度。
Player:GetHeldItemSlot()	ItemSlot	返回玩家当前手持物品格子。
Player:AddBuff(int buffID, int buffTime)	void	为当前玩家添加一个状态效果。若原状态效果存在，以最长时间为新状态效果的持续时间。
Player:RemoveBuff(int buffID)	void	移除一个状态效果。
Player:RemoveAllBuff()	void	移除全部状态效果。
Player:RemoveAllBuffExceptHealthCold()	void	移除除“生命冷却”外的全部状态效果。
Player:HasBuff(int buffID)	bool	返回玩家是否拥有指定状态效果。
Player:HasAnyBuff()	bool	返回玩家是否存在状态效果。

服务端函数

函数	返回值	描述
Player:SetGameMode(GameMode gameMode, bool changeFromSelf = false)	void	为当前玩家设定游戏模式。changeFromSelf表示变更是否来自玩家自己，若为true且玩家先前为创造模式，则仍然拥有创造模式指令权限。
Player:SetOP(OP op)	void	为当前玩家设定权限等级。
Player:Teleport(double newCenterX, double newBottomY, bool playTeleportSound = false)	void	传送当前玩家到指定坐标。newCenterX表示玩家传送后中心横坐标，newBottomY表示玩家传送后的底部纵坐标，playTeleportSound表示是否播放传送音效。
Player:TeleportToSpawn()	void	传送当前玩家到出生点。
Player:GoHome()	bool	传送当前玩家到玩家设定重生点，传送成功返回true。如果玩家设定重生点不存在，不执行传送并返回false。
Player:AddBackpack(int itemID, int itemCount)	void	添加指定物品ID和数量的物品到玩家背包。如果玩家背包已满则会以掉落物的形式抛出。
Player:ClearBackpack()	void	清空玩家背包数据。