com.bgsoftware.wildchests.api

Class WildChestsAPI

java.lang.Object

com.bgsoftware.wildchests.api.WildChestsAPI

public final class WildChestsAPI
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WildChestsAPI()

Method Summary

Modifier and Type	Method and Description
static Chest	getChest(org.bukkit.Location location) Get a regular chest in a specific location.
static ChestData	getChestData(org.bukkit.inventory.ItemStack itemStack) Get the settings object of a chest, by it's item.
static ChestData	getChestData(java.lang.String name) Get the settings object of a chest, by it's name.
static WildChests	getInstance() Get the instance of the plugin.
static LinkedChest	getLinkedChest(org.bukkit.Location location) Get a linked chest in a specific location.
static StorageChest	getStorageChest(org.bukkit.Location location) Get a storage chest in a specific location.

Methods inherited from class java.lang.Object

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

Constructor Detail

WildChestsAPI

public WildChestsAPI()

Method Detail

getChest

public static Chest getChest(org.bukkit.Location location)

Get a regular chest in a specific location.

Parameters:

location - The location to check.

Returns:

The chest object. If no chests were found, or the chest is in an unloaded chunk, null will be returned.

getLinkedChest

public static LinkedChest getLinkedChest(org.bukkit.Location location)

Get a linked chest in a specific location.

Parameters:

location - The location to check.

Returns:

The chest object. If no chests were found, the chest is not a linked chest, or the chest is in an unloaded chunk, null will be returned.

getStorageChest

public static StorageChest getStorageChest(org.bukkit.Location location)

Get a storage chest in a specific location.

Parameters:

location - The location to check.

Returns:

The chest object. If no chests were found, the chest is not a storage chest, or the chest is in an unloaded chunk, null will be returned.

getChestData

public static ChestData getChestData(java.lang.String name)

Get the settings object of a chest, by it's name.

Parameters:

name - The name of the chest (similar to config names)

getChestData

public static ChestData getChestData(org.bukkit.inventory.ItemStack itemStack)

Get the settings object of a chest, by it's item.

Parameters:

itemStack - The item to check (similar to configured item in config)

getInstance

public static WildChests getInstance()

Get the instance of the plugin.