Skip to content
On this page
Common

KattonItemModificationApi

top.katton.api.modcommon/src/main/kotlin/top/katton/api/mod/KattonItemModificationApi.kt
Configuration for modifying existing item properties.

ItemModificationConfig ​

ItemModificationConfigCommonClass
kotlin
class ItemModificationConfig( val itemId: Identifier )

Configuration for modifying existing item properties.

This class provides a fluent API for modifying properties of existing items registered in Minecraft's item registry. Similar to KubeJS's item modification system.

Properties ​

PropertyDescription
itemIdThe identifier of the item to modify

modifyItem ​

modifyItemCommonFunction
kotlin
@ApiStatus.Experimental
@ApiStatus.Experimental fun modifyItem(itemId: String, configure: ItemModificationConfig.() -> Unit): Item

Modifies an existing item's properties.

This function allows you to modify properties of items already registered in Minecraft's item registry. Changes are applied to the item's default components and will affect all ItemStacks of that type.

Parameters ​

ParameterDescription
itemIdThe identifier of the item to modify (e.g., "minecraft:diamond")
configureConfiguration lambda for item modifications

Returns ​

modified Item instance

modifyItem ​

modifyItemCommonFunction
kotlin
@ApiStatus.Experimental
@ApiStatus.Experimental fun modifyItem(itemId: Identifier, configure: ItemModificationConfig.() -> Unit): Item

Modifies an existing item's properties.

Parameters ​

ParameterDescription
itemIdThe identifier of the item to modify
configureConfiguration lambda for item modifications

Returns ​

modified Item instance

snapshotItemComponents ​

snapshotItemComponentsCommonFunction
kotlin
internal fun snapshotItemComponents(): Map<Item, DataComponentMap>

Immutable component snapshot used by transactional script reload rollback.

getItem ​

getItemCommonFunction
kotlin
fun getItem(itemId: String): Item?

Gets an item by its identifier.

Parameters ​

ParameterDescription
itemIdThe item identifier

Returns ​

Item instance, or null if not found

getItem ​

getItemCommonFunction
kotlin
fun getItem(itemId: Identifier): Item?

Gets an item by its identifier.

Parameters ​

ParameterDescription
itemIdThe item identifier

Returns ​

Item instance, or null if not found

itemStack ​

itemStackCommonFunction
kotlin
fun itemStack(itemId: String, count: Int = 1): ItemStack

Creates an ItemStack for an item.

Parameters ​

ParameterDescription
itemIdThe item identifier
countThe stack size

Returns ​

created ItemStack

itemStack ​

itemStackCommonFunction
kotlin
fun itemStack(itemId: Identifier, count: Int = 1): ItemStack

Creates an ItemStack for an item.

Parameters ​

ParameterDescription
itemIdThe item identifier
countThe stack size

Returns ​

created ItemStack