silk-persistence/net.silkmc.silk.persistence/PersistentCompound

PersistentCompound

abstract class PersistentCompound(source)

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.

Inheritors

EmptyPersistentCompound

Constructors

PersistentCompound

constructor()

Functions

clear

fun clear()

Clears all persistent data from this compound.

get

inline operator fun <T : Any> get(key: CompoundKey<T>): T?

Tries to get the value for the given key and convert it to the given type T.

getAndRemove

inline fun <T : Any> getAndRemove(key: CompoundKey<T>): T?

Removes the current value associated with the given key. Additionally, this function returns the value that was removed, if one was removed. Otherwise, the return value will be null.

getOrPut

inline fun <T : Any> getOrPut(key: CompoundKey<T>, defaultValue: () -> T): T

Executes the get function. If the result of the get function is null the defaultValue will be evaluated and put into the compound.

minusAssign

inline operator fun <T : Any> minusAssign(key: CompoundKey<T>)

Removes the current value associated with the given key.

remove

fun remove(key: CompoundKey<*>)

Removes the current value associated with the given key.

set

operator fun <T : Any> set(key: CompoundKey<T>, value: T)

Puts the given value into the persistent storage.