Common

ClientDataApi

top.katton.apicommon/src/main/kotlin/top/katton/api/ClientDataApi.kt

Sync a key-value pair to all connected players. A value of `null` removes the key on the client side.

Members

Jump directly to declarations on this page.

• syncClientDataFunction
• syncClientDataFunction
• syncClientDataFunction
• syncClientDataFunction
• KattonClientDataObject
• KattonClientData.getFunction
• KattonClientData.getStringFunction
• KattonClientData.getNumberFunction
• KattonClientData.getBoolFunction
• KattonClientData.allFunction
• clientDataProperty

syncClientData

syncClientDataCommonFunction

fun syncClientData(key: String, value: Any?)

Sync a key-value pair to all connected players. A value of null removes the key on the client side.

syncClientData

syncClientDataCommonFunction

fun syncClientData(player: ServerPlayer, key: String, value: Any?)

Sync a key-value pair to a specific player. A value of null removes the key on the client side.

syncClientData

syncClientDataCommonFunction

fun syncClientData(entries: Map<String, Any?>)

Sync multiple key-value pairs to all connected players. Entries with null values remove the key on the client side.

syncClientData

syncClientDataCommonFunction

fun syncClientData(player: ServerPlayer, entries: Map<String, Any?>)

Sync multiple key-value pairs to a specific player. Entries with null values remove the key on the client side.

KattonClientData

KattonClientDataCommonObject

object KattonClientData

Client-side accessor for server-synced data.

KattonClientData.get

KattonClientData.getCommonFunction

operator fun get(key: String): Any?

Get the raw value by key. Returns null if key not found.

KattonClientData.getString

KattonClientData.getStringCommonFunction

fun getString(key: String, default: String = ""): String

Get a string value with an optional default.

KattonClientData.getNumber

KattonClientData.getNumberCommonFunction

fun getNumber(key: String, default: Number = 0): Number

Get a numeric value with an optional default.

KattonClientData.getBool

KattonClientData.getBoolCommonFunction

fun getBool(key: String, default: Boolean = false): Boolean

Get a boolean value with an optional default.

KattonClientData.all

KattonClientData.allCommonFunction

fun all(): Map<String, Any?>

Returns all synced data entries (read-only snapshot).

clientData

clientDataCommonProperty

val clientData: KattonClientData

Shorthand accessor — use clientData["key"] in client scripts.