kotlin
fun client(): MinecraftGets the raw Minecraft client instance.
Returns
The Minecraft client instance
Common
KattonClientApi
Gets the raw Minecraft client instance.
client
clientPlayer
kotlin
fun clientPlayer(): LocalPlayer?Gets the raw client player entity.
Returns
The client player entity, or null if not in a world or on server
clientLevel
kotlin
fun clientLevel(): ClientLevel?Gets the raw client level (world).
Returns
The client level instance, or null if not in a world or on server
clientTell
runOnClient
kotlin
fun runOnClient(action: () -> Unit)Executes an action on the client thread.
This is useful for ensuring code runs on the client thread when called from a different thread context.
Parameters
| Parameter | Description |
|---|---|
action | The action to execute |
Returns
true if the action was queued/executed successfully
isClientPaused
kotlin
fun isClientPaused(): BooleanChecks if the client game is paused.
Returns
true if the game is paused (e.g., pause menu open), false otherwise
isInClientWorld
kotlin
fun isInClientWorld(): BooleanChecks if the client is currently in a world.
Returns
true if the client has loaded a world, false otherwise
clientX
kotlin
fun clientX(): Double?Gets the client player's X coordinate.
Returns
The X coordinate, or null if not available
clientY
kotlin
fun clientY(): Double?Gets the client player's Y coordinate.
Returns
The Y coordinate, or null if not available
clientZ
kotlin
fun clientZ(): Double?Gets the client player's Z coordinate.
Returns
The Z coordinate, or null if not available
clientPos
kotlin
fun clientPos(): Vec3?Gets the client player's position as a Vec3.
Returns
The position vector, or null if any coordinate is unavailable
clientYaw
kotlin
fun clientYaw(): Float?Gets the client player's yaw rotation.
Returns
The yaw angle in degrees, or null if not available
clientPitch
kotlin
fun clientPitch(): Float?Gets the client player's pitch rotation.
Returns
The pitch angle in degrees, or null if not available
clientDimensionId
kotlin
fun clientDimensionId(): String?Gets the client player's current dimension identifier.
Returns
The dimension ID string (e.g., "minecraft:overworld"), or null if not available
clientGameTime
kotlin
fun clientGameTime(): Long?Gets the client world's current game time.
Returns
The game time in ticks, or null if not available
clientActionBar
clientOverlay
clearClientOverlay
kotlin
fun clearClientOverlay()Clears any active overlay message on the client.
Returns
true if cleared successfully, false otherwise
clientNowPlaying
playClientSound
kotlin
fun playClientSound(soundId: String, volume: Float = 1.0f, pitch: Float = 1.0f): BooleanPlays a sound on the client.
Parameters
| Parameter | Description |
|---|---|
soundId | The sound identifier (e.g., "minecraft:block.note_block.pling") |
volume | The volume (0.0 to 1.0+) |
pitch | The pitch multiplier (0.5 to 2.0) |
Returns
true if the sound was played successfully, false if the sound ID was invalid
playClientSound
kotlin
fun playClientSound(soundId: Identifier, volume: Float = 1.0f, pitch: Float = 1.0f): BooleanPlays a sound on the client.
Parameters
| Parameter | Description |
|---|---|
soundId | The sound identifier (e.g., "minecraft:block.note_block.pling") |
volume | The volume (0.0 to 1.0+) |
pitch | The pitch multiplier (0.5 to 2.0) |
Returns
true if the sound was played successfully, false if the sound ID was invalid
clientTitle
clientSubtitle
clientTitleTimes
kotlin
fun clientTitleTimes(fadeInTicks: Int = 10, stayTicks: Int = 70, fadeOutTicks: Int = 20)Sets the timing for title display.
Parameters
| Parameter | Description |
|---|---|
fadeInTicks | Ticks for fade-in animation |
stayTicks | Ticks to stay visible |
fadeOutTicks | Ticks for fade-out animation |
Returns
true if timing was set successfully, false otherwise
clearClientTitle
kotlin
fun clearClientTitle()Clears any active title on the client.
Returns
true if cleared successfully, false otherwise
clientFps
kotlin
fun clientFps(): IntGets the client's current FPS (frames per second).
Returns
The current FPS, or null if not available
isClientWindowFocused
kotlin
fun isClientWindowFocused(): BooleanChecks if the client window is focused.
Returns
true if the window has focus, false otherwise
clientScreenName
kotlin
fun clientScreenName(): String?Gets the name of the currently open screen.
Returns
The screen class name, or null if no screen is open
isClientInMenu
kotlin
fun isClientInMenu(): BooleanChecks if the client is currently in a menu (not in-game).
Returns
true if a menu screen is open, false if in-game
isClientChatOpen
kotlin
fun isClientChatOpen(): BooleanChecks if the chat screen is currently open.
Returns
true if chat is open, false otherwise