Katton

简体中文

English

简体中文

English
On this page
通用

KattonPlayerApi

common/src/main/kotlin/top/katton/api/dpcaller/KattonPlayerApi.kt
以类似 List 的方式访问所有在线玩家。

KattonPlayerList ​

KattonPlayerList通用类
kotlin
class KattonPlayerList( val playerList: PlayerList ) : List<ServerPlayer> by playerList.players

以类似 List 的方式访问所有在线玩家。

属性 ​

属性说明
playerList底层 PlayerList。

KattonPlayerList.get ​

KattonPlayerList.get通用函数
kotlin
operator fun get(name: String): ServerPlayer?

按名称查找玩家。

KattonPlayerList.get ​

KattonPlayerList.get通用函数
kotlin
operator fun get(uuid: UUID): ServerPlayer?

按 UUID 查找玩家。

KattonLevelPlayerCollection ​

KattonLevelPlayerCollection通用类
kotlin
class KattonLevelPlayerCollection( val level: ServerLevel ) : List<ServerPlayer> by level.players

指定关卡中的玩家集合。

属性 ​

属性说明
level包含这些玩家的 ServerLevel。

KattonLevelPlayerCollection.get ​

KattonLevelPlayerCollection.get通用函数
kotlin
operator fun get(uuid: UUID): Player?

在当前关卡中按 UUID 查找玩家。

addItem ​

addItem通用函数
kotlin
fun Player.addItem(item: Item, amount: Int)

向玩家背包添加物品。

参数 ​

参数说明
player接收物品的玩家。
item要添加的物品类型。
amount要添加的数量。

clearInventory ​

clearInventory通用函数
kotlin
fun clearInventory(player: Player)

清空玩家背包。

参数 ​

参数说明
player背包将被清空的玩家。

setItem ​

setItem通用函数
kotlin
fun setItem(player: Player, slot: Int, itemStack: ItemStack)

将物品设置到玩家背包槽位中。

参数 ​

参数说明
player要修改的玩家。
slot背包槽位索引。
itemStack要设置的物品堆栈。

getItem ​

getItem通用函数
kotlin
fun getItem(player: Player, slot: Int): ItemStack

从玩家背包槽位中获取物品。

参数 ​

参数说明
player要查询的玩家。
slot背包槽位索引。

返回值 ​

返回该槽位中的物品堆。

giveItem ​

giveItem通用函数
kotlin
fun giveItem(player: Player, itemStack: ItemStack): Boolean

尝试给予玩家一个 ItemStack。

参数 ​

参数说明
player接收物品的玩家。
itemStack要给予的 ItemStack。

返回值 ​

如果已添加到背包，则返回 true；如果背包已满，则返回 false。

hasItem ​

hasItem通用函数
kotlin
fun hasItem(player: Player, item: Item): Boolean

检查玩家背包中是否有指定物品类型。

参数 ​

参数说明
player要检查的玩家。
item要查找的物品类型。

返回值 ​

如果玩家持有该物品，则返回 true；否则返回 false。

findItem ​

findItem通用函数
kotlin
fun findItem(player: Player, item: Item): Int

在玩家背包中查找某种物品所在的槽位索引。

参数 ​

参数说明
player要搜索的玩家。
item要查找的物品类型。

返回值 ​

返回槽位索引；未找到时返回 -1。

removeItem ​

removeItem通用函数
kotlin
fun removeItem(player: Player, item: Item, count: Int): Boolean

从玩家背包中移除指定数量的物品。

参数 ​

参数说明
player要修改的玩家。
item要移除的物品类型。
count要移除的数量。

返回值 ​

如果移除成功则返回 true，否则返回 false。

enchant ​

enchant通用函数
kotlin
fun enchant(itemStack: ItemStack, enchantment: Holder<Enchantment>, level: Int)

使用附魔为 ItemStack 添加魔咒。

参数 ​

参数说明
itemStack目标 ItemStack。
enchantment要应用的附魔 Holder。
level附魔等级。

enchantMainHand ​

enchantMainHand通用函数
kotlin
fun enchantMainHand(entity: LivingEntity, enchantment: Holder<Enchantment>, level: Int)

如果实体主手有物品，则为该物品添加魔咒。

参数 ​

参数说明
entity目标 LivingEntity。
enchantment要应用的附魔 Holder。
level附魔等级。

addXpPoints ​

addXpPoints通用函数
kotlin
fun addXpPoints(player: Player, points: Int)

给予玩家经验点数。

参数 ​

参数说明
player目标 Player。
points要增加的经验点数。

addXpLevels ​

addXpLevels通用函数
kotlin
fun addXpLevels(player: Player, levels: Int)

给予玩家经验等级。

参数 ​

参数说明
player目标 Player。
levels要增加的等级数。

setXpLevel ​

setXpLevel通用函数
kotlin
fun setXpLevel(player: Player, level: Int)

设置玩家的经验等级。

参数 ​

参数说明
player目标 Player。
level要设置的等级值。

getXpLevel ​

getXpLevel通用函数
kotlin
fun getXpLevel(player: Player): Int

获取玩家的经验等级。

参数 ​

参数说明
player目标 Player。

返回值 ​

返回经验等级。

getXpProgress ​

getXpProgress通用函数
kotlin
fun getXpProgress(player: Player): Float

获取玩家经验进度（小数）。

参数 ​

参数说明
player目标 Player。

返回值 ​

返回经验进度，范围为 0 到 1。

spawnPoint ​

spawnPoint通用函数
kotlin
fun spawnPoint(player: MutableCollection<ServerPlayer>, level: ServerLevel, pos: BlockPos, rot: Vec2)

为一组玩家设置重生点。

参数 ​

参数说明
player要设置的 ServerPlayer 集合。
level提供维度信息的服务端关卡。
pos重生位置。
rot旋转向量（x 为 pitch，y 为 yaw）。

setWorldSpawn ​

setWorldSpawn通用函数
kotlin
fun setWorldSpawn(level: ServerLevel, blockPos: BlockPos, rot: Vec2)

设置关卡的世界出生点和重生朝向。

参数 ​

参数说明
level服务端关卡。
blockPos生成位置。
rot旋转向量（x 为 pitch，y 为 yaw）。

spectate ​

spectate通用函数
kotlin
fun spectate(player: ServerPlayer, target: Entity?): Boolean

让玩家观战目标实体。

参数 ​

参数说明
player作为观战者的 ServerPlayer。
target要观战的实体；传入 null 表示停止观战。

返回值 ​

如果观战成功则返回 true，否则返回 false。