eu.wauz.wauzcore.items.scrolls

Interface InventoryScroll

All Known Implementing Classes:

ScrollFortune, ScrollGenericRune, ScrollGenericSkillgem, ScrollRegret, ScrollToughness, ScrollWisdom

public interface InventoryScroll

A scroll or similar that can be used on items in a player's inventory.

Author:

Wauzmons

See Also:

WauzScrolls

Method Summary

Modifier and Type	Method and Description
java.lang.String	getScrollName()
boolean	use(org.bukkit.event.inventory.InventoryClickEvent event, java.lang.String itemName) Uses the scroll on the clicked item.

Method Detail

getScrollName

java.lang.String getScrollName()

Returns:

The name of the scroll.

use

boolean use(org.bukkit.event.inventory.InventoryClickEvent event,
            java.lang.String itemName)

Uses the scroll on the clicked item.

Parameters:

event - The inventory event.

itemName - The name of the item, the scroll is used on.

Returns:

If the usage was successful and the scroll should be consumed.