Skip to content
On this page
通用

KattonItemModificationApi

top.katton.api.modcommon/src/main/kotlin/top/katton/api/mod/KattonItemModificationApi.kt
用于修改现有物品属性的配置对象。 这个类提供一个流式 API,用于修改已经注册到 Minecraft 物品注册表中的物品属性。 风格上类似 KubeJS 的物品修改系统。

ItemModificationConfig ​

ItemModificationConfig通用类
kotlin
class ItemModificationConfig( val itemId: Identifier )

用于修改现有物品属性的配置对象。 这个类提供一个流式 API,用于修改已经注册到 Minecraft 物品注册表中的物品属性。 风格上类似 KubeJS 的物品修改系统。

属性 ​

属性说明
itemId要修改的物品标识符。

modifyItem ​

modifyItem通用函数
kotlin
@ApiStatus.Experimental
@ApiStatus.Experimental fun modifyItem(itemId: String, configure: ItemModificationConfig.() -> Unit): Item

修改已有物品的属性。 这个函数允许你修改已经注册到 Minecraft 物品注册表中的物品属性。 变更会作用到物品的默认组件,并影响该类型的所有 ItemStack。

参数 ​

参数说明
itemId要修改的物品标识符(例如 "minecraft:diamond")。
configure物品修改配置 lambda。

返回值 ​

返回修改后的 Item 实例。

modifyItem ​

modifyItem通用函数
kotlin
@ApiStatus.Experimental
@ApiStatus.Experimental fun modifyItem(itemId: Identifier, configure: ItemModificationConfig.() -> Unit): Item

修改已有物品的属性。

参数 ​

参数说明
itemId要修改的物品标识符。
configure物品修改配置 lambda。

返回值 ​

返回修改后的 Item 实例。

snapshotItemComponents ​

snapshotItemComponents通用函数
kotlin
internal fun snapshotItemComponents(): Map<Item, DataComponentMap>

Immutable component snapshot used by transactional script reload rollback.

getItem ​

getItem通用函数
kotlin
fun getItem(itemId: String): Item?

根据标识符获取物品。

参数 ​

参数说明
itemId物品标识符。

返回值 ​

找到时返回 Item 实例,未找到时返回 null。

getItem ​

getItem通用函数
kotlin
fun getItem(itemId: Identifier): Item?

根据标识符获取物品。

参数 ​

参数说明
itemId物品标识符。

返回值 ​

找到时返回 Item 实例,未找到时返回 null。

itemStack ​

itemStack通用函数
kotlin
fun itemStack(itemId: String, count: Int = 1): ItemStack

为指定物品创建一个 ItemStack。

参数 ​

参数说明
itemId物品标识符。
count堆叠数量。

返回值 ​

返回创建好的 ItemStack。

itemStack ​

itemStack通用函数
kotlin
fun itemStack(itemId: Identifier, count: Int = 1): ItemStack

为指定物品创建一个 ItemStack。

参数 ​

参数说明
itemId物品标识符。
count堆叠数量。

返回值 ​

返回创建好的 ItemStack。