Equipment Operations

Operations on equipments in inventory.

  • equip and unequip changes the equipped status.
  • drop drops the equipment from the inventory.

Syntax

equip CONTRAINED_ITEM_LIST
unequip CONTRAINED_ITEM_LIST
drop CONTRAINED_ITEM_LIST

Annotations:

  • :dpad - Use the DPad menu instead of inventory menu to change equipments.

Change equipments

Example

# Equip the first weapon
equip weapon 
# Unequip the first **equipped** weapon
unequip weapon
# Equip multiple items
equip 1 royal-claymore 1 hylian-shield
# Unequip multiple items
unequip all shields all bows
# Unequip the second equipped Hylian Shield
unequip hylian-shield[slot=2]

# You can also equip armors and champion abilities
equip champion-tunic
unequip gale
# You cannot unequip arrows
unequip fire-arrow # Error! cannot unequip arrow

Warning

When using from-slot or slot for unequip, note that unequip only targets the equipped items. So slot=2 means the second equipped item. equip and other commands target all items, so equip weapon[slot=3] equips the third weapon in the inventory, regardless of which weapon is currently equipped. If the third weapon is already equipped, you will get an error.

This may seem like a weird design choice, but it makes intuitive sense when you use the command in most cases.

Tip

Normally, you would omit the amount for equip or use 1 for multiple categories, since equipping another item of the same category would just unequip the previous one. However, in some configurations, the items won’t be auto-unequipped. If you actually want to equip more than one item, you have to specify [equipped=false]. Otherwise, it will error when it hits an item that’s already equipped. For example, equip all weapons[equipped=false].

unequip all should always work as expected.

By default, changing equipments are assumed to be done in the pause menu. This should be ok in most cases. However, there are edge cases where action must be done through the DPad Quick Menu, examples include:

  • You are holding items in the pause menu.
  • The item slot is not visible in the pause menu, only in quick menu.

In these scenarios, you can use the :dpad annotation to specify the equipment change should be done via the quick menu.

Example

# Switch equipments with DPad quick menu
:dpad equip fire-arrow
:dpad unequip weapon

Warning

Note that :dpad unequip can only be used to unequip the first equipped item in the quick menu, and cannot be used to unequip arrows.

Dropping Equipments from Inventory

Use the drop command to drop equipments, which deletes the item in inventory, and spawns the item in overworld when the inventory is closed.

The game has a limitation on how many weapons can be dropped, but this is not implemented in the simulator.

Examples

drop all shields
drop all but 1 axe