MutableNBTCompound

class MutableNBTCompound @JvmOverloads() constructor(tags: MutableMap<String, NBT>) : NBTCompoundLike

Constructors

MutableNBTCompound

fun MutableNBTCompound(nbt: NBTCompound)

Functions

asMapView

open override fun asMapView(): Map<String, NBT>

Returns a Map representing this compound.

clear

fun clear()

Removes all elements from this compound.

contains

open operator fun contains(key: String): Boolean

Checks if the compound contains the given key.

containsKey

open fun containsKey(key: String): Boolean

Returns true if the compound contains the specified key.

containsValue

open fun containsValue(value: NBT): Boolean

Returns true if the compound maps one or more keys to the specified value.

copyFrom

fun copyFrom(from: Map<String, NBT>): MutableNBTCompound

Replaces all the contents of the compound with the given tags

fun copyFrom(from: NBTCompoundLike): MutableNBTCompound

Replaces all the contents of the compound with the given tags

equals

open operator override fun equals(other: Any?): Boolean

forEach

open fun forEach(p0: Consumer<in Map.Entry<String, NBT>>)

open fun forEach(action: BiConsumer<String, NBT>)

Performs the given action on each entry.

open fun forEach(action: (CompoundEntry) -> Unit)

Performs the given action on each entry.

get

open operator override fun get(key: String): NBT?

Returns the value corresponding to the given key, or null if such a key is not present in the compound.

getAsByte

open fun getAsByte(key: String): Byte?

Calls getNumber and cast to the desired type.

getAsDouble

open fun getAsDouble(key: String): Double?

Calls getNumber and cast to the desired type.

getAsFloat

open fun getAsFloat(key: String): Float?

Calls getNumber and cast to the desired type.

getAsInt

open fun getAsInt(key: String): Int?

Calls getNumber and cast to the desired type.

getAsLong

open fun getAsLong(key: String): Long?

Calls getNumber and cast to the desired type.

getAsShort

open fun getAsShort(key: String): Short?

Calls getNumber and cast to the desired type.

getBoolean

open fun getBoolean(key: String): Boolean?

Returns the value associated to the given key, if any.

getByte

open fun getByte(key: String): Byte?

Returns the value associated to the given key, if any.

getByteArray

open fun getByteArray(key: String): ImmutableByteArray?

Returns the value associated to the given key, if any.

getCompound

open fun getCompound(key: String): NBTCompound?

Returns the value associated to the given key, if any.

getDouble

open fun getDouble(key: String): Double?

Returns the value associated to the given key, if any.

getFloat

open fun getFloat(key: String): Float?

Returns the value associated to the given key, if any.

getInt

open fun getInt(key: String): Int?

Returns the value associated to the given key, if any.

getIntArray

open fun getIntArray(key: String): ImmutableIntArray?

Returns the value associated to the given key, if any.

getList

open fun <T : NBT> getList(key: String): NBTList<T>?

Returns the value associated to the given key, if any.

getLong

open fun getLong(key: String): Long?

Returns the value associated to the given key, if any.

getLongArray

open fun getLongArray(key: String): ImmutableLongArray?

Returns the value associated to the given key, if any.

getNumber

open fun getNumber(key: String): Number?

Returns the value associated to the given key, if any.

getOrElse

open fun getOrElse(key: String, defaultValue: NBT): NBT

Returns the value associated to the given key, if any.

getOrPut

fun getOrPut(key: String, defaultValue: () -> NBT): NBT

Returns the value for the given key.

getShort

open fun getShort(key: String): Short?

Returns the value associated to the given key, if any.

getString

open fun getString(key: String): String?

Returns the value associated to the given key, if any.

hashCode

open override fun hashCode(): Int

isEmpty

open fun isEmpty(): Boolean

Returns true if the compound is empty (contains no elements), false otherwise.

iterator

open operator override fun iterator(): MutableIterator<MutableCompoundEntry>

Returns a MutableIterator over the mutable entries in the MutableNBTCompound.

plus

open operator override fun plus(other: NBTCompoundLike): MutableNBTCompound

Creates a new mutable compound by replacing or adding entries to this compound from another compound.

plusAssign

operator fun plusAssign(p: Pair<String, NBT>)

Updates this compound with the given key/value pair.

operator fun plusAssign(other: Map<String, NBT>)

Updates this compound with key/value pairs from the specified compound other.

operator fun plusAssign(other: NBTCompoundLike)

Updates this compound with key/value pairs from the specified compound other.

put

fun put(key: String, value: NBT): NBT?

Associates the specified value with the specified key in the compound.

putAll

fun putAll(from: Map<String, NBT>): MutableNBTCompound

Updates this compound with key/value pairs from the specified compound from.

fun putAll(from: NBTCompoundLike): MutableNBTCompound

Updates this compound with key/value pairs from the specified compound from.

remove

fun remove(key: String): NBT?

Removes the specified key and its corresponding value from this compound.

fun remove(key: String, value: NBT): Boolean

Removes the entry for the specified key only if it is mapped to the specified value.

set

operator fun set(key: String, value: NBT): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls put)

setAll

fun setAll(from: Map<String, NBT>): MutableNBTCompound

Updates this compound with key/value pairs from the specified compound from.

fun setAll(from: NBTCompoundLike): MutableNBTCompound

Updates this compound with key/value pairs from the specified compound from.

setByte

fun setByte(key: String, value: Byte): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

setByteArray

fun setByteArray(key: String, value: ByteArray): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

fun setByteArray(key: String, value: ImmutableByteArray): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

setDouble

fun setDouble(key: String, value: Double): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

setFloat

fun setFloat(key: String, value: Float): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

setInt

fun setInt(key: String, value: Int): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

setIntArray

fun setIntArray(key: String, value: IntArray): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

fun setIntArray(key: String, value: ImmutableIntArray): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

setLong

fun setLong(key: String, value: Long): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

setLongArray

fun setLongArray(key: String, value: LongArray): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

fun setLongArray(key: String, value: ImmutableLongArray): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

setShort

fun setShort(key: String, value: Short): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

setString

fun setString(key: String, value: String): MutableNBTCompound

Sets (and overwrites previous) tag associated to the given key (shorthand method that in turn calls set)

spliterator

open fun spliterator(): Spliterator<CompoundEntry>

toCompound

open override fun toCompound(): NBTCompound

Creates a NBTCompound.

toMutableCompound

open override fun toMutableCompound(): MutableNBTCompound

Returns a new mutable map containing all key-value pairs from the original compound.

toSNBT

open fun toSNBT(): String

Same semantics than NBT#toSNBT

toString

open override fun toString(): String

Properties

entries

open val entries: Set<CompoundEntry>

Returns a read-only Set of all key/value pairs in this compound.

keys

open val keys: Set<String>

Returns a read-only Set of all keys in this compound.

size

open val size: Int

Returns the number of key/value pairs in the compound.

values

open val values: Collection<NBT>

Returns a read-only Collection of all values in this compound.