Common

KattonItemModificationApi

top.katton.api.modcommon/src/main/kotlin/top/katton/api/mod/KattonItemModificationApi.kt

Configuration for modifying existing item properties.

Members

Jump directly to declarations on this page.

• ItemModificationConfigClass
• modifyItemFunction
• modifyItemFunction
• getItemFunction
• getItemFunction
• itemStackFunction
• itemStackFunction

ItemModificationConfig

CommonClass

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

Property	Description
itemId	The identifier of the item to modify

modifyItem

CommonFunction

@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

Parameter	Description
itemId	The identifier of the item to modify (e.g., "minecraft:diamond")
configure	Configuration lambda for item modifications

Returns

The modified Item instance

modifyItem

CommonFunction

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

Modifies an existing item's properties.

Parameters

Parameter	Description
itemId	The identifier of the item to modify
configure	Configuration lambda for item modifications

Returns

The modified Item instance

getItem

CommonFunction

fun getItem(itemId: String): Item?

Gets an item by its identifier.

Parameters

Parameter	Description
itemId	The item identifier

Returns

The Item instance, or null if not found

getItem

CommonFunction

fun getItem(itemId: Identifier): Item?

Gets an item by its identifier.

Parameters

Parameter	Description
itemId	The item identifier

Returns

The Item instance, or null if not found

itemStack

CommonFunction

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

Creates an ItemStack for an item.

Parameters

Parameter	Description
itemId	The item identifier
count	The stack size

Returns

The created ItemStack

itemStack

CommonFunction

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

Creates an ItemStack for an item.

Parameters

Parameter	Description
itemId	The item identifier
count	The stack size

Returns

The created ItemStack