Common

KattonNbtApi

common/src/main/kotlin/top/katton/api/dpcaller/KattonNbtApi.kt

Create a numeric Tag from a Number value.

Members

Jump directly to declarations on this page.

• numericTagOfFunction
• getValueFunction
• invokeFunction
• getOrValueFunction
• invokeFunction
• toBooleanFunction
• parseNbtFunction
• getEntityNbtFunction
• setEntityNbtFunction
• getBlockNbtFunction
• setBlockNbtFunction
• getBlockNbtFunction
• setBlockNbtFunction
• getStorageNbtFunction
• setStorageNbtFunction

numericTagOf

numericTagOfCommonFunction

fun <T : Number> numericTagOf(value: T)

Create a numeric Tag from a Number value.

Parameters

Parameter	Description
value	The numeric value to convert

Returns

appropriate NumericTag subtype

getValue

getValueCommonFunction

fun <T : Tag> Tag?.getValue(tagType: TagType<T>): T?

Safely cast a Tag to a specific TagType.

Performs automatic type conversion where possible:

• Numeric tags can be converted between numeric types
• String tags can be parsed into other types
• Collection tags can be converted between array types

Parameters

Parameter	Description
tagType	The target TagType

Returns

casted Tag or null if conversion is not possible

invoke

invokeCommonFunction

@Suppress("UNCHECKED_CAST")
@Suppress("UNCHECKED_CAST") operator fun <T : Tag> Tag?.invoke(tagType: TagType<T>): T?

Safely cast a Tag to a specific TagType.

Performs automatic type conversion where possible:

• Numeric tags can be converted between numeric types
• String tags can be parsed into other types
• Collection tags can be converted between array types

Parameters

Parameter	Description
tagType	The target TagType

Returns

casted Tag or null if conversion is not possible

getOrValue

getOrValueCommonFunction

fun <V> Tag?.getOrValue(default: V): V

Safely get a value from a Tag with a default fallback.

Performs automatic type conversion where possible:

• Numeric tags return numeric values
• String tags return string values
• Collection tags return lists

Parameters

Parameter	Description
default	The default value to return if conversion fails

Returns

converted value or the default

invoke

invokeCommonFunction

@Suppress("UNCHECKED_CAST")
@Suppress("UNCHECKED_CAST") operator fun <V> Tag?.invoke(default: V): V

Safely get a value from a Tag with a default fallback.

Performs automatic type conversion where possible:

• Numeric tags return numeric values
• String tags return string values
• Collection tags return lists

Parameters

Parameter	Description
default	The default value to return if conversion fails

Returns

converted value or the default

toBoolean

toBooleanCommonFunction

fun ByteTag?.toBoolean(): Boolean

Convert a ByteTag to a Boolean value.

parseNbt

parseNbtCommonFunction

fun parseNbt(nbt: String): CompoundTag

Parse an NBT string into a CompoundTag.

Parameters

Parameter	Description
nbt	NBT string to parse

Returns

CompoundTag

getEntityNbt

getEntityNbtCommonFunction

fun getEntityNbt(entity: Entity): CompoundTag

Get the full NBT data of an entity.

Parameters

Parameter	Description
entity	the target entity

Returns

representing the entity's data

setEntityNbt

setEntityNbtCommonFunction

fun setEntityNbt(entity: Entity, tag: CompoundTag)

Replace the NBT data of an entity.

Parameters

Parameter	Description
entity	the target entity
tag	the CompoundTag to set on the entity

getBlockNbt

getBlockNbtCommonFunction

fun getBlockNbt(block: BlockEntity): CompoundTag

Get the NBT data of a block entity.

Parameters

Parameter	Description
block	the target BlockEntity

Returns

representing the block entity's data

setBlockNbt

setBlockNbtCommonFunction

fun setBlockNbt(block: BlockEntity, tag: CompoundTag)

Replace the NBT data of a block entity.

Parameters

Parameter	Description
block	the target BlockEntity
tag	the CompoundTag to set on the block entity

getBlockNbt

getBlockNbtCommonFunction

fun getBlockNbt(level: Level, pos: BlockPos): CompoundTag?

Get the NBT data of a block at a position if it has a block entity.

Parameters

Parameter	Description
level	level to query
pos	position of the block

Returns

or null if no block entity exists

setBlockNbt

setBlockNbtCommonFunction

fun setBlockNbt(level: Level, pos: BlockPos, tag: CompoundTag): Boolean

Set the NBT of a block entity at the given position.

Parameters

Parameter	Description
level	level to modify
pos	block position
tag	CompoundTag to set

Returns

if set succeeded, false if no block entity present

getStorageNbt

getStorageNbtCommonFunction

fun getStorageNbt(id: Identifier): CompoundTag

Get stored command storage NBT by identifier.

Parameters

Parameter	Description
id	storage identifier

Returns

stored at id

setStorageNbt

setStorageNbtCommonFunction

fun setStorageNbt(id: Identifier, tag: CompoundTag)

Set stored command storage NBT by identifier.

Parameters

Parameter	Description
id	storage identifier
tag	CompoundTag to store