silk-persistence/net.silkmc.silk.persistence

Package-level declarations

Contains compound key creation and access to persistent compounds

Types

abstract class CompoundKey<T : Any>(val name: String)

This class provides a PersistentCompound. Providers are classes like net.minecraft.world.level.chunk.ChunkAccess, net.minecraft.world.entity.Entity and more.

EmptyPersistentCompound

object EmptyPersistentCompound : PersistentCompound

A PersistentCompound which does nothing. Needed for empty holders such as net.minecraft.world.chunk.EmptyChunk for example.

PersistentCompound

abstract class PersistentCompound

Holds data which can be accessed fast because it is stored in memory. Additionally, the data will be stored persistently to the disk, if the game decides to do so.

Properties

persistentCompound

val ServerLevel.persistentCompound: PersistentCompound

val Entity.persistentCompound: PersistentCompound

val ChunkAccess.persistentCompound: PersistentCompound

Returns a persistent PersistentCompound.

Functions

compoundKey

inline fun <T : Any> compoundKey(id: ResourceLocation): CompoundKey<T>

Creates a CompoundKey which can be used to read and write data to a PersistentCompound in a typesafe way.

customCompoundKey

inline fun <T : Any, NbtType : Tag> customCompoundKey(id: ResourceLocation, crossinline valueToNbt: (value: T) -> NbtType, crossinline nbtToValue: (nbtElement: NbtType) -> T): CompoundKey<T>

@JvmName(name = "customCompoundKeyNbtElement")

inline fun <T : Any> customCompoundKey(id: ResourceLocation, crossinline convertValueToNbtElement: (value: T) -> Tag, crossinline convertNbtElementToValue: (nbtElement: Tag) -> T): CompoundKey<T>

Creates a CompoundKey which can be used to read and write data to a PersistentCompound in a typesafe way.

nbtElementCompoundKey

inline fun <T : Tag> nbtElementCompoundKey(id: ResourceLocation): CompoundKey<T>

Creates a CompoundKey which can be used to read and write data to a PersistentCompound in a typesafe way.