Item

Module used to define items and their properties.

Index

Interfaces

• ArmorParams
• FoodParams
• ItemLegacyPrototype
• ItemParams
• NativeItem
• TextureData

Variables

• iconOverrideFunctions
• nameOverrideFunctions

Functions

• addCreativeGroup
• addRepairItem
• addRepairItemId
• addRepairItemIds
• addRepairItems
• addToCreative
• addToCreativeGroup
• createArmorItem
• createFoodItem
• createFuelItem
• createItem
• createThrowableItem
• describeItem
• getArmorValue
• getCategory
• getCreativeCategory
• getDynamicIconOverride
• getEnchantSlot
• getEnchantValue
• getItemById
• getMaxDamage
• getMaxStack
• getMaxStackSize
• getMaxUseDuration
• getName
• getNumericId
• getNutrition
• getUseAnimation
• invokeItemUseNoTarget
• invokeItemUseOn
• isAllowedInOffhand
• isArmor
• isArmorDamageable
• isExplodable
• isFireResistant
• isFood
• isGlint
• isHandEquipped
• isLiquidClip
• isMirroredSprite
• isNativeItem
• isRequiresIconOverride
• isShouldDespawn
• isStackedByData
• isThrowable
• isToolRender
• isValid
• registerDispenseFunction
• registerIconOverrideFunction
• registerNameOverrideFunction
• registerNoTargetUseFunction
• registerThrowableFunction
• registerThrowableFunctionForID
• registerUseFunction
• registerUseFunctionForID
• registerUsingCompleteFunction
• registerUsingReleasedFunction
• setAllowedInOffhand
• setArmorDamageable
• setCategory
• setCreativeCategory
• setEnchantType
• setEnchantibility
• setExplodable
• setFireResistant
• setGlint
• setHandEquipped
• setLiquidClip
• setMaxDamage
• setMaxStack
• setMaxStackSize
• setMaxUseDuration
• setMirroredSprite
• setProperties
• setPrototype
• setRequiresIconOverride
• setShouldDespawn
• setStackedByData
• setToolRender
• setUseAnimation

Variables

consticonOverrideFunctions

internal

iconOverrideFunctions: {}

All items icon override functions object.

---

Type declaration

• [key number]: Callback.ItemIconOverrideFunction

constnameOverrideFunctions

internal

nameOverrideFunctions: {}

All items name override functions object.

---

Type declaration

• [key number]: Callback.ItemNameOverrideFunction

Functions

addCreativeGroup

• addCreativeGroup(name: string, displayedName: string, ids: number[]): void

• Creates group of creative items.

  ---

  Parameters

  • name: string

    name of group

  • displayedName: string

    name of group in game

  • ids: number[]

    array of items in group

  Returns void

addRepairItem

• addRepairItem(id: string | number, repairId: string | number): void

• since: 3.1.1b127

  Specifies what items can be used to repair this item in the anvil.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • repairId: string | number

    string or numeric repair item ID

  Returns void

addRepairItemId

• addRepairItemId(id: string | number, repairId: string | number): void

• since: 3.1.1b127

  Specifies what items can be used to repair this item in the anvil.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • repairId: string | number

    string or numeric repair item ID

  Returns void

addRepairItemIds

• addRepairItemIds(id: string | number, items: number[]): void

• Specifies what items can be used to repair this item in the anvil.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • items: number[]

    array of numeric item IDs to be used as repair items

  Returns void

addRepairItems

• addRepairItems(id: string | number, items: (string | number)[]): void

• since: 3.1.1b127

  Specifies what items can be used to repair this item in the anvil.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • items: (string | number)[]

    array of numeric item IDs to be used as repair items

  Returns void

addToCreative

• addToCreative(id: string | number, count?: number, data?: number, extra?: ItemExtraData): void

• Adds item to creative inventory.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • optionalcount: number

    amount of the item to be added, generally should be 1

  • optionaldata: number

    item data

  • optionalextra: ItemExtraData

  Returns void

addToCreativeGroup

• addToCreativeGroup(name: string, displayedName: string, id: string | number): void

• since: 3.1.1b127

  Adds or creates a creative group with specified item.

  ---

  Parameters

  • name: string

    name of group

  • displayedName: string

    name of group in game

  • id: string | number

    single numeric or string id in group

  Returns void

createArmorItem

• createArmorItem(nameID: string, name: string, texture: TextureData, params: ArmorParams): NativeItem

• Creates armor item using specified parameters.

  ---

  Parameters

  • nameID: string

    string ID of the item; you should register it via IDRegistry.genItemID call first

  • name: string

    item name in English; add translations to the name using Translation module, all translation to the item and block names are applied automatically

  • texture: TextureData

    texture data used to create item

  • params: ArmorParams

    general armor item parameters object, the armor type there is required

  Returns NativeItem

createFoodItem

• createFoodItem(nameID: string, name: string, texture: TextureData, params?: FoodParams): NativeItem

• Creates eatable item using specified parameters.

  ---

  Parameters

  • nameID: string

    string ID of the item. You should register it via IDRegistry.genItemID call first

  • name: string

    item name in English; add translations to the name using Translation module, all translation to the item and block names are applied automatically

  • texture: TextureData

    texture data used to create item

  • optionalparams: FoodParams

    additional item parameters

  Returns NativeItem

createFuelItem

• createFuelItem(nameID: string, name: string, texture: TextureData, params?: ItemParams): void

• That feature is obsolete

  Use Item.createItem and Recipes.addFurnaceFuel instead.

  Invocation may throw an error

  Unsupported usage.

  ---

  Parameters

  • nameID: string

  • name: string

  • texture: TextureData

  • optionalparams: ItemParams

  Returns void

createItem

• createItem(nameID: string, name: string, texture: TextureData, params?: ItemParams): NativeItem

• Creates new item using specified parameters.

  ---

  Parameters

  • nameID: string

    string ID of the item; you should register it via IDRegistry.genItemID call first

  • name: string

    item name in English; add translations to the name using Translation module, all translation to the item and block names are applied automatically

  • texture: TextureData

    texture data used to create item

  • optionalparams: ItemParams

    additional item parameters

  Returns NativeItem

createThrowableItem

• createThrowableItem(nameID: string, name: string, texture: TextureData, params?: ItemParams): NativeItem

• Creates throwable item using specified parameters.

  ---

  Parameters

  • nameID: string

    string ID of the item; you should register it via IDRegistry.genItemID call first

  • name: string

    item name in English; add translations to the name using Translation module, all translation to the item and block names are applied automatically

  • texture: TextureData

    texture data used to create item

  • optionalparams: ItemParams

    additional item parameters

  Returns NativeItem

describeItem

• describeItem(numericID: number, description: object): void

• Applies several properties via one method call.

  That feature is obsolete

  Consider using appropriate setters instead.

  ---

  Parameters

  • numericID: number

    numeric item ID

  • description: object

  Returns void

getArmorValue

• getArmorValue(id: string | number): number

• since: 2.4.0b119

  Natural armor points, that also is displayed above hotbar.

  ---

  Parameters

  • id: string | number

    numeric item ID

  Returns number

  Natural armor half points.

getCategory

• getCategory(id: string | number): EItemCategory

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns EItemCategory

getCreativeCategory

• getCreativeCategory(id: string | number): EItemCategory

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns EItemCategory

getDynamicIconOverride

• getDynamicIconOverride(id: number, count: number, data: number, extra: ItemExtraData): void

• since: 3.1.1b127

  Parameters

  • id: number

  • count: number

  • data: number

  • extra: ItemExtraData

  Returns void

getEnchantSlot

• getEnchantSlot(id: string | number): number

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns number

getEnchantValue

• getEnchantValue(id: string | number): number

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns number

getItemById

• getItemById(id: string): NativeItem

• Gets NativeItem instance that can be used to apply some properties to the item.

  That feature is obsolete

  ---

  Parameters

  • id: string

    string ID of the item

  Returns NativeItem

  NativeItem instance associated with this item.

getMaxDamage

• getMaxDamage(id: string | number): number

• Parameters

  • id: string | number

    numeric item ID

  Returns number

  Maximum damage value for the specified item.

getMaxStack

• getMaxStack(id: number): number
• getMaxStack(id: number, data: number): number

• That feature is obsolete

  Use same function with data parameter.

  ---

  Parameters

  • id: number

    numeric item ID

  Returns number

  Maximum stack size for the specified item.

getMaxStackSize

• getMaxStackSize(id: string | number, data?: number): number

• since: 3.1.1b127

  Parameters

  • id: string | number

  • optionaldata: number

  Returns number

  Maximum stack size for the specified item.

getMaxUseDuration

• getMaxUseDuration(id: string | number): number

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns number

getName

• getName(id: number, data: number): string
• getName(id: number, data: number, encode: any): string

• Parameters

  • id: number

    numeric item ID

  • data: number

    item data

  Returns string

  Current item name.

getNumericId

• getNumericId(id: string | number): number

• Parameters

  • id: string | number

    string ID of the item

  Returns number

  Item numeric ID by it's string ID or just returns it's numeric ID if input was a numeric ID.

getNutrition

• getNutrition(id: string | number): number

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns number

getUseAnimation

• getUseAnimation(id: string | number): EItemAnimation

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns EItemAnimation

invokeItemUseNoTarget

• invokeItemUseNoTarget(item: ItemInstance, noModCallback: boolean): void

• internal

  Invoke click on the block in world without target.

  ---

  Parameters

  • item: ItemInstance

    item which used on the block

  • noModCallback: boolean

    if true, mod ItemUse callback will be not executed

  Returns void

invokeItemUseOn

• invokeItemUseOn(coords: ItemUseCoordinates, item: ItemInstance, noModCallback: boolean, entity: number): void

• internal

  Invoke click on the block in world.

  ---

  Parameters

  • coords: ItemUseCoordinates

    coords of click on the block

  • item: ItemInstance

    item which used on the block

  • noModCallback: boolean

    if true, mod ItemUse callback will be not executed

  • entity: number

    player which clicked on the block

  Returns void

isAllowedInOffhand

• isAllowedInOffhand(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isArmor

• isArmor(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isArmorDamageable

• isArmorDamageable(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isExplodable

• isExplodable(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isFireResistant

• isFireResistant(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isFood

• isFood(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isGlint

• isGlint(id: string | number, data?: number, extra?: ItemExtraData): void

• since: 3.1.1b127

  Parameters

  • id: string | number

  • optionaldata: number

  • optionalextra: ItemExtraData

  Returns void

isHandEquipped

• isHandEquipped(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isLiquidClip

• isLiquidClip(id: string | number, data?: number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  • optionaldata: number

  Returns boolean

isMirroredSprite

• isMirroredSprite(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isNativeItem

• isNativeItem(id: number): boolean

• Parameters

  • id: number

    numeric item ID

  Returns boolean

  true if given item is vanilla item, false otherwise.

isRequiresIconOverride

• isRequiresIconOverride(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isShouldDespawn

• isShouldDespawn(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isStackedByData

• isStackedByData(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isThrowable

• isThrowable(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isToolRender

• isToolRender(id: string | number): boolean

• since: 3.1.1b127

  Parameters

  • id: string | number

  Returns boolean

isValid

• isValid(id: number): boolean
• isValid(id: number, data: number): boolean

• since: 2.2.1b94 (not worked before)

  Parameters

  • id: number

    numeric item ID

  Returns boolean

  true, if an item with such ID exists, false otherwise.

registerDispenseFunction

• registerDispenseFunction(nameID: string | number, func: ItemDispensedFunction): void

• Registers function to be called when item is dispensed from dispenser.

  ---

  Parameters

  • nameID: string | number

    string or numeric ID of the item

  • func: ItemDispensedFunction

    function that is called when such an event occurs

  Returns void

registerIconOverrideFunction

• registerIconOverrideFunction(nameID: string | number, func: ItemIconOverrideFunction): void

• Registers item ID as requiring item icon override and registers function to perform such an override.

  ---

  Parameters

  • nameID: string | number

    string or numeric ID of the item

  • func: ItemIconOverrideFunction

    function that is called to override item icon. Should return Item.TextureData object to be used for the item. See Callback.ItemIconOverrideFunction documentation for details

  Returns void

registerNameOverrideFunction

• registerNameOverrideFunction(nameID: string | number, func: ItemNameOverrideFunction): void

• Registers function to perform item name overrides. Since 2.4.0b122-4 also supports vanilla items and blocks.

  ---

  Parameters

  • nameID: string | number

    string or numeric ID of the item

  • func: ItemNameOverrideFunction

    function that is called to override item name. Should return string to be used as new item name

  Returns void

registerNoTargetUseFunction

• registerNoTargetUseFunction(nameID: string | number, func: ItemUseNoTargetFunction): void

• Registers function to be called when player uses item in the air (not on the block).

  ---

  Parameters

  • nameID: string | number

    string or numeric ID of the item

  • func: ItemUseNoTargetFunction

    function that is called when such an event occurs

  Returns void

registerThrowableFunction

• registerThrowableFunction(nameID: string | number, useFunc: ProjectileHitFunction): void

• Registers function that is called when throwable item with specified ID hits block or entity.

  ---

  Parameters

  • nameID: string | number

    string or numeric ID of the item

  • useFunc: ProjectileHitFunction

    function that is called when such an event occurs

  Returns void

registerThrowableFunctionForID

• registerThrowableFunctionForID(numericID: number, useFunc: ProjectileHitFunction): void

• Same as Item.registerThrowableFunction, but supports numeric IDs only.

  ---

  Parameters

  • numericID: number

  • useFunc: ProjectileHitFunction

  Returns void

registerUseFunction

• registerUseFunction(nameID: string | number, useFunc: ItemUseFunction): void

• Registers function that is called when user touches some block in the world with specified item.

  ---

  Parameters

  • nameID: string | number

    string or numeric ID of the item

  • useFunc: ItemUseFunction

    function that is called when such an event occurs

  Returns void

registerUseFunctionForID

• registerUseFunctionForID(numericID: number, useFunc: ItemUseFunction): void

• Same as Item.registerUseFunction, but supports numeric IDs only.

  ---

  Parameters

  • numericID: number

  • useFunc: ItemUseFunction

  Returns void

registerUsingCompleteFunction

• registerUsingCompleteFunction(nameID: string | number, func: ItemUsingCompleteFunction): void

• Registers function to be called when player completes using item that has maximum use time set with Item.setMaxUseDuration function.

  ---

  Parameters

  • nameID: string | number

    string or numeric ID of the item

  • func: ItemUsingCompleteFunction

    function that is called when such an event occurs

  Returns void

registerUsingReleasedFunction

• registerUsingReleasedFunction(nameID: string | number, func: ItemUsingReleasedFunction): void

• Registers function to be called when player doesn't complete using item that has maximum use time set with Item.setMaxUseDuration function. Vanilla bow uses this function with max use duration of 72000 ticks.

  ---

  Parameters

  • nameID: string | number

    string or numeric ID of the item

  • func: ItemUsingReleasedFunction

    function that is called when such an event occurs

  Returns void

setAllowedInOffhand

• setAllowedInOffhand(id: string | number, allowed: boolean): void

• since: 2.0.4b35

  Allows item to be put in offhand slot.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • allowed: boolean

  Returns void

setArmorDamageable

• setArmorDamageable(id: string | number, damageable: boolean): void

• Parameters

  • id: string | number

  • damageable: boolean

  Returns void

setCategory

• setCategory(id: string | number, category: number): void

• Sets item creative category.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • category: number

    item category, should be one of the EItemCategory values

  Returns void

setCreativeCategory

• setCreativeCategory(id: string | number, category: number): void

• since: 3.1.1b127

  Sets item creative category.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • category: number

    item category, should be one of the EItemCategory values

  Returns void

setEnchantType

• setEnchantType(id: string | number, enchant: number, value: number): void

• Specifies how the item can be enchanted.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • enchant: number

    enchant type defining when enchants can or cannot be applied to this item, one of the EEnchantType

  • value: number

    quality of the enchants that are applied, the higher this value is, the better enchants you get with the same level

  Returns void

setEnchantibility

• setEnchantibility(id: string | number, type: number, value: number): void

• since: 3.1.1b127

  Parameters

  • id: string | number

  • type: number

  • value: number

  Returns void

setExplodable

• setExplodable(id: string | number, explodable: boolean): void

• since: 2.4.0b119

  Parameters

  • id: string | number

  • explodable: boolean

  Returns void

setFireResistant

• setFireResistant(id: string | number, resistant: boolean): void

• since: 2.4.0b119

  Parameters

  • id: string | number

  • resistant: boolean

  Returns void

setGlint

• setGlint(id: string | number, enabled: boolean): void

• Sets item as glint (like enchanted tools or golden apple).

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • enabled: boolean

    if true, the item will be displayed as glint item

  Returns void

setHandEquipped

• setHandEquipped(id: string | number, enabled: boolean): void

• Specifies how the player should hold the item.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • enabled: boolean

    if true, player holds the item as a tool, not as a simple item

  Returns void

setLiquidClip

• setLiquidClip(id: string | number, enabled: boolean): void

• Allows to click with item on liquid blocks.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • enabled: boolean

    if true, liquid blocks can be selected on click

  Returns void

setMaxDamage

• setMaxDamage(id: string | number, damage: number): void

• Sets item maximum data value.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • damage: number

    maximum data value for the item

  Returns void

setMaxStack

• setMaxStack(id: string | number, size: number): void

• since: 3.1.1b127

  Parameters

  • id: string | number

  • size: number

  Returns void

setMaxStackSize

• setMaxStackSize(id: string | number, size: number): void

• since: 3.1.1b127

  Parameters

  • id: string | number

  • size: number

  Returns void

setMaxUseDuration

• setMaxUseDuration(id: string | number, duration: number): void

• Limits maximum use duration. This is useful to create such items as bows.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • duration: number

    maximum use duration in ticks

  Returns void

setMirroredSprite

• setMirroredSprite(id: string | number, enabled: boolean): void

• since: 3.1.1b127

  Parameters

  • id: string | number

  • enabled: boolean

  Returns void

setProperties

• setProperties(id: string | number, props: string): void

• Sets additional properties for the item, uses Minecraft mechanisms to set them. Full list of properties is currently unavailable.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • props: string

    JSON string containing some of the properties

  Returns void

setPrototype

• setPrototype(nameID: any, prototype: ItemLegacyPrototype): void

• That feature is obsolete

  Should not be used in new mods, consider using Item properties setters instead.

  ---

  Parameters

  • nameID: any

  • prototype: ItemLegacyPrototype

  Returns void

setRequiresIconOverride

• setRequiresIconOverride(id: string | number, enabled: boolean): void

• since: 3.1.1b127

  Parameters

  • id: string | number

  • enabled: boolean

  Returns void

setShouldDespawn

• setShouldDespawn(id: string | number, should: boolean): void

• since: 2.4.0b119

  Parameters

  • id: string | number

  • should: boolean

  Returns void

setStackedByData

• setStackedByData(id: string | number, enabled: boolean): void

• That feature is obsolete

  No longer supported. Probably?

  ---

  Parameters

  • id: string | number

  • enabled: boolean

  Returns void

setToolRender

• setToolRender(id: string | number, enabled: boolean): void

• Specifies how the player should hold the item.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • enabled: boolean

    if true, player holds the item as a tool, not as a simple item

  Returns void

setUseAnimation

• setUseAnimation(id: string | number, animType: number): void

• Sets animation type for the item.

  ---

  Parameters

  • id: string | number

    string or numeric item ID

  • animType: number

    use animation type, one of the EItemAnimation values

  Returns void