Common

KattonPlayerApi

common/src/main/kotlin/top/katton/api/dpcaller/KattonPlayerApi.kt

List-like access to all online players.

Members

Jump directly to declarations on this page.

• KattonPlayerListClass
• KattonPlayerList.getFunction
• KattonPlayerList.getFunction
• KattonLevelPlayerCollectionClass
• KattonLevelPlayerCollection.getFunction
• addItemFunction
• clearInventoryFunction
• setItemFunction
• getItemFunction
• giveItemFunction
• hasItemFunction
• findItemFunction
• removeItemFunction
• enchantFunction
• enchantMainHandFunction
• addXpPointsFunction
• addXpLevelsFunction
• setXpLevelFunction
• getXpLevelFunction
• getXpProgressFunction
• spawnPointFunction
• setWorldSpawnFunction
• spectateFunction

KattonPlayerList

KattonPlayerListCommonClass

class KattonPlayerList( val playerList: PlayerList ) : List<ServerPlayer> by playerList.players

List-like access to all online players.

Properties

Property	Description
playerList	The underlying PlayerList

KattonPlayerList.get

KattonPlayerList.getCommonFunction

operator fun get(name: String): ServerPlayer?

Find a player by name.

KattonPlayerList.get

KattonPlayerList.getCommonFunction

operator fun get(uuid: UUID): ServerPlayer?

Find a player by UUID.

KattonLevelPlayerCollection

KattonLevelPlayerCollectionCommonClass

class KattonLevelPlayerCollection( val level: ServerLevel ) : List<ServerPlayer> by level.players

Collection of players within a specific level.

Properties

Property	Description
level	The ServerLevel containing the players

KattonLevelPlayerCollection.get

KattonLevelPlayerCollection.getCommonFunction

operator fun get(uuid: UUID): Player?

Find a player by UUID in this level.

addItem

addItemCommonFunction

fun Player.addItem(item: Item, amount: Int)

Add an item to a player's inventory.

Parameters

Parameter	Description
player	the Player to receive the item
item	the Item type to add
amount	the quantity to add

clearInventory

clearInventoryCommonFunction

fun clearInventory(player: Player)

Clear a player's inventory.

Parameters

Parameter	Description
player	the Player whose inventory will be cleared

setItem

setItemCommonFunction

fun setItem(player: Player, slot: Int, itemStack: ItemStack)

Set an item into a player's inventory slot.

Parameters

Parameter	Description
player	the Player to modify
slot	inventory slot index
itemStack	item stack to set

getItem

getItemCommonFunction

fun getItem(player: Player, slot: Int): ItemStack

Get the item from a player's inventory slot.

Parameters

Parameter	Description
player	the Player to query
slot	inventory slot index

Returns

in the slot

giveItem

giveItemCommonFunction

fun giveItem(player: Player, itemStack: ItemStack): Boolean

Try to give an item stack to a player.

Parameters

Parameter	Description
player	the Player to receive the item
itemStack	the ItemStack to give

Returns

if added to inventory, false if full

hasItem

hasItemCommonFunction

fun hasItem(player: Player, item: Item): Boolean

Check if a player has a specific item type in their inventory.

Parameters

Parameter	Description
player	the Player to check
item	the Item type to search for

Returns

true if the player has the item, false otherwise

findItem

findItemCommonFunction

fun findItem(player: Player, item: Item): Int

Find the slot index of an item in player's inventory.

Parameters

Parameter	Description
player	the Player to search
item	item type to find

Returns

index or -1 if not found

removeItem

removeItemCommonFunction

fun removeItem(player: Player, item: Item, count: Int): Boolean

Remove a count of items from player's inventory.

Parameters

Parameter	Description
player	the Player to modify
item	item type to remove
count	amount to remove

Returns

true if removal succeeded, false otherwise

enchant

enchantCommonFunction

fun enchant(itemStack: ItemStack, enchantment: Holder<Enchantment>, level: Int)

Enchant an ItemStack with an enchantment.

Parameters

Parameter	Description
itemStack	target ItemStack
enchantment	enchantment holder to apply
level	enchantment level

enchantMainHand

enchantMainHandCommonFunction

fun enchantMainHand(entity: LivingEntity, enchantment: Holder<Enchantment>, level: Int)

Enchant the item in an entity's main hand if present.

Parameters

Parameter	Description
entity	target LivingEntity
enchantment	enchantment holder to apply
level	enchantment level

addXpPoints

addXpPointsCommonFunction

fun addXpPoints(player: Player, points: Int)

Give experience points to a player.

Parameters

Parameter	Description
player	target Player
points	experience points to add

addXpLevels

addXpLevelsCommonFunction

fun addXpLevels(player: Player, levels: Int)

Give experience levels to a player.

Parameters

Parameter	Description
player	target Player
levels	levels to add

setXpLevel

setXpLevelCommonFunction

fun setXpLevel(player: Player, level: Int)

Set a player's experience level.

Parameters

Parameter	Description
player	target Player
level	level value to set

getXpLevel

getXpLevelCommonFunction

fun getXpLevel(player: Player): Int

Get a player's experience level.

Parameters

Parameter	Description
player	target Player

Returns

experience level

getXpProgress

getXpProgressCommonFunction

fun getXpProgress(player: Player): Float

Get a player's experience progress (fraction).

Parameters

Parameter	Description
player	target Player

Returns

progress as float (0..1)

spawnPoint

spawnPointCommonFunction

fun spawnPoint(player: MutableCollection<ServerPlayer>, level: ServerLevel, pos: BlockPos, rot: Vec2)

Set spawn point for a collection of players.

Parameters

Parameter	Description
player	collection of ServerPlayer to set
level	server level providing the dimension
pos	respawn position
rot	rotation vector (pitch,x / yaw,y)

setWorldSpawn

setWorldSpawnCommonFunction

fun setWorldSpawn(level: ServerLevel, blockPos: BlockPos, rot: Vec2)

Set the world spawn and respawn orientation for a level.

Parameters

Parameter	Description
level	server level
blockPos	spawn position
rot	rotation vector (pitch,x / yaw,y)

spectate

spectateCommonFunction

fun spectate(player: ServerPlayer, target: Entity?): Boolean

Make a player spectate a target entity.

Parameters

Parameter	Description
player	spectator ServerPlayer
target	entity to spectate, or null to stop

Returns

true if spectating succeeded, false otherwise