Common

KattonServerApi

top.katton.api.dpcallercommon/src/main/kotlin/top/katton/api/dpcaller/KattonServerApi.kt

Access to all online players.

Members

Jump directly to declarations on this page.

• playersProperty
• entitiesProperty
• storageProperty
• scoreboardProperty
• difficultyProperty
• executeFunction
• executeCommandFunction
• executeCommandAsServerFunction
• findPlayerFunction
• findPlayerFunction
• findEntitiesFunction
• findEntityFunction
• banFunction
• banIpFunction
• deopFunction
• opFunction
• setDifficultyFunction
• runFunctionFunction
• setGameModeFunction
• getGameModeFunction
• setGameRuleFunction
• getGameRuleFunction
• kickFunction

players

CommonProperty

val players: KattonPlayerList

Access to all online players.

entities

CommonProperty

val entities: KattonServerEntityCollection

Access to all entities across all levels.

storage

CommonProperty

val storage: CommandStorage

Server command storage for persistent data.

scoreboard

CommonProperty

val scoreboard: Scoreboard

Server scoreboard instance.

difficulty

CommonProperty

var difficulty: Difficulty

Current server difficulty setting.

execute

CommonFunction

fun execute(command: String)

Execute a command string.

Parameters

Parameter	Description
command	the command string to execute

executeCommand

CommonFunction

fun executeCommand(source: CommandSourceStack, command: String)

Execute a command as the provided command source.

Parameters

Parameter	Description
source	the command source to run the command as
command	the command string to execute

executeCommandAsServer

CommonFunction

fun executeCommandAsServer(command: String)

Execute a command as the server console.

Parameters

Parameter	Description
command	the command string to execute

findPlayer

CommonFunction

fun findPlayer(player: String): ServerPlayer?

Find a player by name.

Parameters

Parameter	Description
player	the player name to search for

Returns

the ServerPlayer if found, null otherwise

findPlayer

CommonFunction

fun findPlayer(uuid: UUID): ServerPlayer?

Find a player by UUID.

Parameters

Parameter	Description
uuid	the player UUID to search for

Returns

the ServerPlayer if found, null otherwise

findEntities

CommonFunction

fun findEntities(level: ServerLevel, selector: EntitySelector): List<Entity>

Find entities using an entity selector in a level.

Parameters

Parameter	Description
level	the ServerLevel to search in
selector	the EntitySelector to use

Returns

list of matching entities

findEntity

CommonFunction

fun findEntity(uuid: UUID): Entity?

Find an entity by UUID across all levels.

Parameters

Parameter	Description
uuid	the entity UUID to search for

Returns

the Entity if found, null otherwise

ban

CommonFunction

fun ban(player: ServerPlayer)

Ban a player by adding them to the server ban list and disconnecting them.

Parameters

Parameter	Description
player	the ServerPlayer to ban

banIp

CommonFunction

fun banIp(ip: String)

Ban an IP address and disconnect matching players.

Parameters

Parameter	Description
ip	IP address string to ban

deop

CommonFunction

fun deop(player: ServerPlayer)

De-op a player (remove operator status).

Parameters

Parameter	Description
player	ServerPlayer to de-op

op

CommonFunction

fun op(player: ServerPlayer)

Op a player (grant operator status).

Parameters

Parameter	Description
player	ServerPlayer to op

setDifficulty

CommonFunction

fun setDifficulty(difficulty: Difficulty, ignoreLock: Boolean = true)

Set server difficulty.

Parameters

Parameter	Description
difficulty	new Difficulty
ignoreLock	whether to ignore difficulty lock

runFunction

CommonFunction

fun runFunction(id: Identifier, source: CommandSourceStack = requireServer().createCommandSourceStack())

Run a function (data pack function) with an optional command source.

Parameters

Parameter	Description
id	function identifier
source	command source to use (defaults to server)

setGameMode

CommonFunction

fun setGameMode(player: ServerPlayer, gameMode: GameType)

Set a player's game mode.

Parameters

Parameter	Description
player	target ServerPlayer
gameMode	target GameType

getGameMode

CommonFunction

fun getGameMode(player: ServerPlayer): GameType

Get a player's current GameType.

Parameters

Parameter	Description
player	target ServerPlayer

Returns

current GameType

setGameRule

CommonFunction

fun <T : Any> setGameRule(key: GameRule<T>, value: T)

Set a game rule value on the server overworld.

Parameters

Parameter	Description
key	GameRule key
value	value to set

getGameRule

CommonFunction

fun <T : Any> getGameRule(key: GameRule<T>): T

Get a game rule value from the server overworld.

Parameters

Parameter	Description
key	GameRule key

Returns

value of the game rule

kick

CommonFunction

fun kick(player: Player, reason: Component = Component.translatable("multiplayer.disconnect.kicked"))

Kick a player with an optional reason component.

Parameters

Parameter	Description
player	target Player (ServerPlayer required to disconnect)
reason	disconnect reason component