eu.wauz.wauzcore.items.scrolls

Class WauzScrolls

java.lang.Object

eu.wauz.wauzcore.items.scrolls.WauzScrolls

All Implemented Interfaces:

CustomItem

public class WauzScrolls
extends java.lang.Object
implements CustomItem

A class for handling the usage of scrolls and socketable items.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<java.lang.String,InventoryScroll>	scrollMap A map of all scrolls, indexed by scroll name.
private static java.util.List<org.bukkit.Material>	validScrollMaterials A list of materials a scroll or socketable item can have.

Constructor Summary

Constructors

Constructor and Description
WauzScrolls()

Method Summary

Modifier and Type	Method and Description
java.util.List<org.bukkit.Material>	getCustomItemMaterials() Returns the materials that trigger events with the item.
static InventoryScroll	getScroll(java.lang.String scrollName) Gets a scroll for the given name from the map.
static void	onScrollItemInteract(org.bukkit.event.inventory.InventoryClickEvent event, java.lang.String itemName) Handles the usage of item interactive scrolls, aswell as runes and skillgems.
static void	onScrollItemInteract(org.bukkit.event.player.PlayerInteractEvent event) Handles the usage of right click scrolls.
static void	registerScroll(InventoryScroll scroll) Registers a scroll.
void	use(org.bukkit.event.player.PlayerInteractEvent event) Handles the usage of right click scrolls.

Methods inherited from class java.lang.Object

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

Field Detail

scrollMap

private static java.util.Map<java.lang.String,InventoryScroll> scrollMap

A map of all scrolls, indexed by scroll name.

validScrollMaterials

private static java.util.List<org.bukkit.Material> validScrollMaterials

A list of materials a scroll or socketable item can have.

Constructor Detail

WauzScrolls

public WauzScrolls()

Method Detail

getScroll

public static InventoryScroll getScroll(java.lang.String scrollName)

Gets a scroll for the given name from the map. Can also find scroll objects for runes and skillgems.

Parameters:

scrollName - The name of the scroll.

Returns:

The scroll or null, if not found.

registerScroll

public static void registerScroll(InventoryScroll scroll)

Registers a scroll.

Parameters:

scroll - The scroll to register.

use

public void use(org.bukkit.event.player.PlayerInteractEvent event)

Handles the usage of right click scrolls.

Specified by:

use in interface CustomItem

Parameters:

event - The interaction event.

See Also:

onScrollItemInteract(PlayerInteractEvent)

getCustomItemMaterials

public java.util.List<org.bukkit.Material> getCustomItemMaterials()

Returns the materials that trigger events with the item.

Specified by:

getCustomItemMaterials in interface CustomItem

Returns:

The list of materials.

onScrollItemInteract

public static void onScrollItemInteract(org.bukkit.event.player.PlayerInteractEvent event)

Handles the usage of right click scrolls. Includes following types: Comfort, Summoning, Blueprint. Removes the scroll item, if successful.

Parameters:

event - The interaction event.

See Also:

For item interactive scrolls..., WauzPlayerEventHomeChange, PetObtainEvent.call(Player, WauzPet), WauzTowers.tryToConstruct(Player, String)

onScrollItemInteract

public static void onScrollItemInteract(org.bukkit.event.inventory.InventoryClickEvent event,
                                        java.lang.String itemName)

Handles the usage of item interactive scrolls, aswell as runes and skillgems. Includes following types: Wisdom, Fortune, Toughness, Regret. Removes the scroll item, if successful.

Parameters:

event - The inventory event.

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

See Also:

For right click scrolls..., getScroll(String), InventoryScroll.use(InventoryClickEvent, String)