Skip to content
On this page
通用

DataComponentType

top.katton.api.registrycommon/src/main/kotlin/top/katton/api/registry/DataComponentType.kt
注册持久化(保存到磁盘)的 DataComponentType,并支持热重载。 持久化组件会使用其 codec 进行序列化,并随物品一并保存。 适用于必须跨存档读写周期保留的数据。

registerNativePersistentDataComponentType

registerNativePersistentDataComponentType通用函数
kotlin
fun <T : Any> registerNativePersistentDataComponentType(id: String, registerMode: RegisterMode = RegisterMode.WORLD, codec: Codec<T>): KattonRegistry.KattonDataComponentTypeEntry

注册持久化(保存到磁盘)的 DataComponentType,并支持热重载。 持久化组件会使用其 codec 进行序列化,并随物品一并保存。 适用于必须跨存档读写周期保留的数据。

参数

参数说明
id组件标识符,例如 "mymod:custom_data"。
registerMode注册模式(GLOBAL、WORLD 或 RELOADABLE)。
codec用于序列化和反序列化组件值的 codec。

返回值

已注册的 KattonDataComponentTypeEntry。

registerNativePersistentDataComponentType

registerNativePersistentDataComponentType通用函数
kotlin
fun <T : Any> registerNativePersistentDataComponentType(id: Identifier, registerMode: RegisterMode = RegisterMode.WORLD, codec: Codec<T>): KattonRegistry.KattonDataComponentTypeEntry

注册持久化(保存到磁盘)的 DataComponentType,并支持热重载。

参数

参数说明
id组件标识符。
registerMode注册模式。
codec用于序列化和反序列化组件值的 codec。

返回值

已注册的 KattonDataComponentTypeEntry。

registerNativeNetworkDataComponentType

registerNativeNetworkDataComponentType通用函数
kotlin
fun <T : Any> registerNativeNetworkDataComponentType(id: String, registerMode: RegisterMode = RegisterMode.WORLD, streamCodec: StreamCodec<*, T>): KattonRegistry.KattonDataComponentTypeEntry

注册网络同步的 DataComponentType,并支持热重载。 这种组件会发送到客户端,但不会保存到磁盘。 适用于运行时计算的数据,例如仅供渲染使用的状态。

参数

参数说明
id组件标识符,例如 "mymod:sync_data"。
registerMode注册模式(GLOBAL、WORLD 或 RELOADABLE)。
streamCodec用于网络同步的 stream codec。

返回值

已注册的 KattonDataComponentTypeEntry。

registerNativeNetworkDataComponentType

registerNativeNetworkDataComponentType通用函数
kotlin
fun <T : Any> registerNativeNetworkDataComponentType(id: Identifier, registerMode: RegisterMode = RegisterMode.WORLD, streamCodec: StreamCodec<*, T>): KattonRegistry.KattonDataComponentTypeEntry

注册网络同步的 DataComponentType,并支持热重载。

参数

参数说明
id组件标识符。
registerMode注册模式。
streamCodec用于网络同步的 stream codec。

返回值

已注册的 KattonDataComponentTypeEntry。