Katton

简体中文

English

简体中文

English
On this page
通用

KattonClientApi

top.katton.apicommon/src/main/kotlin/top/katton/api/KattonClientApi.kt
获取原始 Minecraft 客户端实例。

client ​

client通用函数
kotlin
fun client(): Minecraft

获取原始 Minecraft 客户端实例。

返回值 ​

Minecraft 客户端实例。

clientPlayer ​

clientPlayer通用函数
kotlin
fun clientPlayer(): LocalPlayer?

获取原始客户端玩家实体。

返回值 ​

客户端玩家实体；如果未进入世界或在服务端调用，则返回 null。

clientLevel ​

clientLevel通用函数
kotlin
fun clientLevel(): ClientLevel?

获取原始客户端世界。

返回值 ​

客户端世界实例；如果未进入世界或在服务端调用，则返回 null。

clientTell ​

clientTell通用函数
kotlin
fun clientTell(message: Any?, overlay: Boolean = true): Boolean

向客户端玩家聊天栏发送消息。

参数 ​

参数说明
message要显示的消息；如果不是 Component，会自动转换。

返回值 ​

如果消息发送成功则返回 true，否则返回 false。

runOnClient ​

runOnClient通用函数
kotlin
fun runOnClient(action: () -> Unit)

在客户端线程上执行一个动作。

当调用方位于其他线程上下文时，可用它确保代码切回客户端线程执行。

参数 ​

参数说明
action要执行的动作。

返回值 ​

如果动作成功排队或执行则返回 true。

isClientPaused ​

isClientPaused通用函数
kotlin
fun isClientPaused(): Boolean

检查客户端游戏是否暂停。

返回值 ​

如果游戏已暂停（例如打开暂停菜单）则返回 true，否则返回 false。

isInClientWorld ​

isInClientWorld通用函数
kotlin
fun isInClientWorld(): Boolean

检查客户端当前是否已经进入世界。

返回值 ​

如果客户端已加载世界则返回 true，否则返回 false。

clientX ​

clientX通用函数
kotlin
fun clientX(): Double?

获取客户端玩家的 X 坐标。

返回值 ​

X 坐标；如果不可用则返回 null。

clientY ​

clientY通用函数
kotlin
fun clientY(): Double?

获取客户端玩家的 Y 坐标。

返回值 ​

Y 坐标；如果不可用则返回 null。

clientZ ​

clientZ通用函数
kotlin
fun clientZ(): Double?

获取客户端玩家的 Z 坐标。

返回值 ​

Z 坐标；如果不可用则返回 null。

clientPos ​

clientPos通用函数
kotlin
fun clientPos(): Vec3?

以 Vec3 形式获取客户端玩家位置。

返回值 ​

位置向量；如果任一坐标不可用则返回 null。

clientYaw ​

clientYaw通用函数
kotlin
fun clientYaw(): Float?

获取客户端玩家的 yaw 旋转角。

返回值 ​

以度为单位的 yaw 角；如果不可用则返回 null。

clientPitch ​

clientPitch通用函数
kotlin
fun clientPitch(): Float?

获取客户端玩家的 pitch 旋转角。

返回值 ​

以度为单位的 pitch 角；如果不可用则返回 null。

clientDimensionId ​

clientDimensionId通用函数
kotlin
fun clientDimensionId(): String?

获取客户端玩家当前所在维度的标识符。

返回值 ​

维度 ID 字符串，例如 "minecraft:overworld"；如果不可用则返回 null。

clientGameTime ​

clientGameTime通用函数
kotlin
fun clientGameTime(): Long?

获取客户端世界当前游戏时间。

返回值 ​

以 tick 为单位的游戏时间；如果不可用则返回 null。

clientActionBar ​

clientActionBar通用函数
kotlin
fun clientActionBar(message: Any): Boolean

在客户端玩家的 action bar 中显示消息。

参数 ​

参数说明
message要显示的消息。

返回值 ​

如果显示成功则返回 true，否则返回 false。

clientOverlay ​

clientOverlay通用函数
kotlin
fun clientOverlay(message: Any?, tinted: Boolean = false)

在客户端屏幕上显示覆盖消息。

参数 ​

参数说明
message要显示的消息。
tinted是否应用背景着色。

返回值 ​

如果显示成功则返回 true，否则返回 false。

clearClientOverlay ​

clearClientOverlay通用函数
kotlin
fun clearClientOverlay()

清除客户端当前活动的覆盖消息。

返回值 ​

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

clientNowPlaying ​

clientNowPlaying通用函数
kotlin
fun clientNowPlaying(message: Any?)

为音乐或声音显示 "Now Playing" 消息。

参数 ​

参数说明
message要显示的消息。

返回值 ​

如果显示成功则返回 true，否则返回 false。

playClientSound ​

playClientSound通用函数
kotlin
fun playClientSound(soundId: String, volume: Float = 1.0f, pitch: Float = 1.0f): Boolean

在客户端播放声音。

参数 ​

参数说明
soundId声音标识符，例如 "minecraft:block.note_block.pling"。
volume音量，范围通常为 0.0 到 1.0 以上。
pitch音高倍率，通常为 0.5 到 2.0。

返回值 ​

如果声音播放成功则返回 true；如果声音 ID 无效则返回 false。

playClientSound ​

playClientSound通用函数
kotlin
fun playClientSound(soundId: Identifier, volume: Float = 1.0f, pitch: Float = 1.0f): Boolean

在客户端播放声音。

参数 ​

参数说明
soundId声音标识符，例如 "minecraft:block.note_block.pling"。
volume音量，范围通常为 0.0 到 1.0 以上。
pitch音高倍率，通常为 0.5 到 2.0。

返回值 ​

如果声音播放成功则返回 true；如果声音 ID 无效则返回 false。

clientTitle ​

clientTitle通用函数
kotlin
fun clientTitle(message: Any?)

在客户端屏幕上显示标题。

参数 ​

参数说明
message要显示的标题消息。

返回值 ​

如果显示成功则返回 true，否则返回 false。

clientSubtitle ​

clientSubtitle通用函数
kotlin
fun clientSubtitle(message: Any?)

在客户端屏幕上显示副标题。

参数 ​

参数说明
message要显示的副标题消息。

返回值 ​

如果显示成功则返回 true，否则返回 false。

clientTitleTimes ​

clientTitleTimes通用函数
kotlin
fun clientTitleTimes(fadeInTicks: Int = 10, stayTicks: Int = 70, fadeOutTicks: Int = 20)

设置标题显示的时间参数。

参数 ​

参数说明
fadeInTicks淡入动画持续的 tick 数。
stayTicks保持可见的 tick 数。
fadeOutTicks淡出动画持续的 tick 数。

返回值 ​

如果时间设置成功则返回 true，否则返回 false。

clearClientTitle ​

clearClientTitle通用函数
kotlin
fun clearClientTitle()

清除客户端当前活动的标题。

返回值 ​

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

clientFps ​

clientFps通用函数
kotlin
fun clientFps(): Int

获取客户端当前 FPS（每秒帧数）。

返回值 ​

当前 FPS。

isClientWindowFocused ​

isClientWindowFocused通用函数
kotlin
fun isClientWindowFocused(): Boolean

检查客户端窗口是否获得焦点。

返回值 ​

如果窗口获得焦点则返回 true，否则返回 false。

clientScreenName ​

clientScreenName通用函数
kotlin
fun clientScreenName(): String?

获取当前打开屏幕的名称。

返回值 ​

屏幕类名；如果没有打开屏幕则返回 null。

isClientInMenu ​

isClientInMenu通用函数
kotlin
fun isClientInMenu(): Boolean

检查客户端当前是否位于菜单中，而不是游戏内。

返回值 ​

如果打开了菜单屏幕则返回 true；如果在游戏内则返回 false。

isClientChatOpen ​

isClientChatOpen通用函数
kotlin
fun isClientChatOpen(): Boolean

检查聊天屏幕当前是否打开。

返回值 ​

如果聊天屏幕已打开则返回 true，否则返回 false。