eu.wauz.wauzcore.items.scrolls

Class ScrollRegret

java.lang.Object

eu.wauz.wauzcore.items.scrolls.ScrollRegret

All Implemented Interfaces:

InventoryScroll

public class ScrollRegret
extends java.lang.Object
implements InventoryScroll

A scroll or similar that can be used on items in a player's inventory. Can be dragged on an equip item to destroy socketed runes and skillgems.

Author:

Wauzmons

See Also:

WauzScrolls, WauzEquipment.clearAllSockets(InventoryClickEvent)

Constructor Summary

Constructors

Constructor and Description
ScrollRegret()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScrollRegret

public ScrollRegret()

Method Detail

getScrollName

public java.lang.String getScrollName()

Specified by:

getScrollName in interface InventoryScroll

Returns:

The name of the scroll.

use

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

Uses the scroll on the clicked item.

Specified by:

use in interface InventoryScroll

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.