com.bgsoftware.wildtools.api

Class WildToolsAPI

java.lang.Object

com.bgsoftware.wildtools.api.WildToolsAPI

public final class WildToolsAPI
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WildToolsAPI()

Method Summary

Modifier and Type	Method and Description
static CannonTool	getCannonTool(org.bukkit.inventory.ItemStack itemStack) Get a cannon-tool object by an item-stack
static Selection	getCannonWandSelection(org.bukkit.entity.Player player) Get a players cannon-wand selection
static CraftingTool	getCraftingTool(org.bukkit.inventory.ItemStack itemStack) Get a crafting-tool object by an item-stack
static CuboidTool	getCuboidTool(org.bukkit.inventory.ItemStack itemStack) Get a cuboid-tool object by an item-stack
static HarvesterTool	getHarvesterTool(org.bukkit.inventory.ItemStack itemStack) Get a harvester-tool object by an item-stack
static LightningTool	getLightningTool(org.bukkit.inventory.ItemStack itemStack) Get a lightning-tool object by an item-stack
static PillarTool	getPillarTool(org.bukkit.inventory.ItemStack itemStack) Get a pillar-tool object by an item-stack
static double	getPrice(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack itemStack) Get a price for an item-stack
static SellTool	getSellTool(org.bukkit.inventory.ItemStack itemStack) Get a sell-tool object by an item-stack
static Tool	getTool(org.bukkit.inventory.ItemStack itemStack) Get a tool object by an item-stack
static Tool	getTool(java.lang.String name) Get a tool object by a name
static WildTools	getWildTools() Get the wildtools object
static boolean	isOwningTool(org.bukkit.inventory.ItemStack itemStack, org.bukkit.entity.Player player) Checks if a player is owning the private tool.

Methods inherited from class java.lang.Object

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

Constructor Detail

WildToolsAPI

public WildToolsAPI()

Method Detail

getTool

public static Tool getTool(org.bukkit.inventory.ItemStack itemStack)

Get a tool object by an item-stack

Parameters:

itemStack - an item-stack to check

Returns:

tool object

getTool

public static Tool getTool(java.lang.String name)

Get a tool object by a name

Parameters:

name - an name to check

Returns:

tool object

getCannonTool

public static CannonTool getCannonTool(org.bukkit.inventory.ItemStack itemStack)

Get a cannon-tool object by an item-stack

Parameters:

itemStack - an item-stack to check

Returns:

cannon-tool object

getCraftingTool

public static CraftingTool getCraftingTool(org.bukkit.inventory.ItemStack itemStack)

Get a crafting-tool object by an item-stack

Parameters:

itemStack - an item-stack to check

Returns:

crafting-tool object

getCuboidTool

public static CuboidTool getCuboidTool(org.bukkit.inventory.ItemStack itemStack)

Get a cuboid-tool object by an item-stack

Parameters:

itemStack - an item-stack to check

Returns:

cuboid-tool object

getHarvesterTool

public static HarvesterTool getHarvesterTool(org.bukkit.inventory.ItemStack itemStack)

Get a harvester-tool object by an item-stack

Parameters:

itemStack - an item-stack to check

Returns:

harvester-tool object

getLightningTool

public static LightningTool getLightningTool(org.bukkit.inventory.ItemStack itemStack)

Get a lightning-tool object by an item-stack

Parameters:

itemStack - an item-stack to check

Returns:

lightning-tool object

getPillarTool

public static PillarTool getPillarTool(org.bukkit.inventory.ItemStack itemStack)

Get a pillar-tool object by an item-stack

Parameters:

itemStack - an item-stack to check

Returns:

pillar-tool object

getSellTool

public static SellTool getSellTool(org.bukkit.inventory.ItemStack itemStack)

Get a sell-tool object by an item-stack

Parameters:

itemStack - an item-stack to check

Returns:

sell-tool object

getCannonWandSelection

public static Selection getCannonWandSelection(org.bukkit.entity.Player player)

Get a players cannon-wand selection

Parameters:

player - a player to check

Returns:

selection object, null if no selection exists

isOwningTool

public static boolean isOwningTool(org.bukkit.inventory.ItemStack itemStack,
                                   org.bukkit.entity.Player player)

Checks if a player is owning the private tool. If there's no tool for the item or it's not private, true will be returned.

Parameters:

itemStack - The item to check

player - The player to check

Returns:

True if player is owning the tool, otherwise false.

getWildTools

public static WildTools getWildTools()

Get the wildtools object

Returns:

wildtools object

getPrice

public static double getPrice(org.bukkit.entity.Player player,
                              org.bukkit.inventory.ItemStack itemStack)

Get a price for an item-stack

Parameters:

player - a player to check

itemStack - an item-stack to check

Returns:

the price of the item-stack, -1 if no price exists