Skip to content
On this page
通用

ClientDataApi

top.katton.apicommon/src/main/kotlin/top/katton/api/ClientDataApi.kt
向所有已连接玩家同步一个键值对。 值为 `null` 时会在客户端删除该键。

syncClientData

syncClientData通用函数
kotlin
fun syncClientData(key: String, value: Any?)

向所有已连接玩家同步一个键值对。 值为 null 时会在客户端删除该键。

syncClientData

syncClientData通用函数
kotlin
fun syncClientData(player: ServerPlayer, key: String, value: Any?)

向指定玩家同步一个键值对。 值为 null 时会在客户端删除该键。

syncClientData

syncClientData通用函数
kotlin
fun syncClientData(entries: Map<String, Any?>)

向所有已连接玩家同步多个键值对。 值为 null 的条目会在客户端删除对应的键。

syncClientData

syncClientData通用函数
kotlin
fun syncClientData(player: ServerPlayer, entries: Map<String, Any?>)

向指定玩家同步多个键值对。 值为 null 的条目会在客户端删除对应的键。

KattonClientData

KattonClientData通用对象
kotlin
object KattonClientData

服务器同步数据的客户端访问入口。

KattonClientData.get

KattonClientData.get通用函数
kotlin
operator fun get(key: String): Any?

按键获取原始值。如果找不到该键,返回 null。

KattonClientData.getString

KattonClientData.getString通用函数
kotlin
fun getString(key: String, default: String = ""): String

获取字符串值,可指定默认值。

KattonClientData.getNumber

KattonClientData.getNumber通用函数
kotlin
fun getNumber(key: String, default: Number = 0): Number

获取数值,可指定默认值。

KattonClientData.getBool

KattonClientData.getBool通用函数
kotlin
fun getBool(key: String, default: Boolean = false): Boolean

获取布尔值,可指定默认值。

KattonClientData.all

KattonClientData.all通用函数
kotlin
fun all(): Map<String, Any?>

返回所有已同步的数据条目(只读快照)。

clientData

clientData通用属性
kotlin
val clientData: KattonClientData

简写访问器 - 在客户端脚本中使用 clientData["key"]