Use Item

This unlocker will trigger when a player uses an item (interacts with an item).

id

use item

Data

Important

You have to set at least one of the following data.

name Optional

• Type: string
• Default: none
• Description: The name of the item.

lore Optional

• Type: string
• Default: none
• Description: The lore of the item.

nbt Optional

• Type: string
• Default: none
• Description: The NBT of the item.

Condition

item

id: item

Specifies the type of item to interact with. Supports fuzzy matching and compatibility with other plugin items.

Goal

consume Optional

• Type: boolean
• Default: false
• Description: Whether to consume the item after use.

Variable

type

Returns the name of the used item type

display-name

Returns the display name of the used item

Example

# Use Item Unlock (Item Interaction)
- type: "use item"
  condition:
    # Item type, supports fuzzy matching and compatibility with other plugins like pickup item
    item: "diamond_sword"
  goal:
    # Whether to consume after use
    consume: true