Custom Items

The Item Module lets you create custom items that go far beyond standard Minecraft items. You can make keys that open doors, weapons that apply special effects, tools that trigger complex game logic, or even custom food items.

Manage your custom items in /editmap -> Items (Book).

Creating a Custom Item

1. Go to the Items menu.
2. Click "Add Item" and give your new item a unique name for your own reference.
3. Click on the new item in the menu to open the Item Edit Menu.

Configuring a Custom Item

In the Item Edit Menu, you define how your item looks and what it does.

Appearance

• Item: Clicking this opens the powerful Item Build Menu. Here you can customize every visual aspect:
  • Material: The base item type (e.g., DIAMOND_SWORD, POTION).
  • Name & Lore: Set a custom display name and description, with full support for color codes.
  • Enchantments: Add any enchantment at any level. You can also add a "Fake Enchant" glow without an actual enchantment.
  • Potion Effects: If the material is a potion, you can add custom potion effects.

Behavior

• Movable In Inventory: If set to No, players will not be able to move this item in their inventory. It will be "stuck" in the slot it's given in, perfect for menu items or persistent tools.
• Action Triggers: This is where you bring your item to life. You can assign a Function to run when a player interacts with this item in different ways:
  • Left Click Function: Runs when the player left-clicks with the item.
  • Right Click Function: Runs when the player right-clicks.
  • Hold Function: Runs when a player switches to this item in their hotbar.
  • Stop Holding Function: Runs when a player switches away from this item.
  • Drop Function: Runs when the player drops the item.
  • Equip/Unequip Function: Runs when the item is equipped or unequipped as armor.

Example: Creating a "Grappling Hook"

Let's create a custom Fishing Rod that teleports the player where the hook lands.

1. Create a Function: First, create a function named GrappleTeleport.
   • Add a Teleport action.
   • For the Target Player, leave it as the default (the player who triggered the event).
   • For the Location, set it to the Location provided by the event.
2. Create a Custom Item: Go to the Items menu and create a new item called Grappling Hook.
3. Configure Appearance: In the Item Edit Menu, click "Item".
   • Change the material to FISHING_ROD.
   • Give it a name like &6Grappling Hook.
   • Add lore like &7Right-click to grapple!.
4. Create a Region Event:
   • Go to /editmap -> Regions and select your main game region.
   • Go to Events and create a new Projectile Land event.
   • Add a Conditional action to it.
     • Condition: Player Has Item, and select your Grappling Hook custom item.
     • If Actions: Add a Call Function action and select your GrappleTeleportFunction.
5. Give the Item: Use the Give Item action in your game's start logic to give players the Grappling Hook.

Now, when a player holding the Grappling Hook right-clicks, the hook will fire. When it lands, the event will check if they have the hook, and if so, run the function to teleport them to the hook's landing spot.