com.bgsoftware.wildbuster.api

Class WildBusterAPI

java.lang.Object

com.bgsoftware.wildbuster.api.WildBusterAPI

public final class WildBusterAPI
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
WildBusterAPI()

Method Summary

Modifier and Type	Method and Description
static ChunkBuster	createChunkBuster(java.lang.String name, int radius, org.bukkit.inventory.ItemStack busterItem) Create a new chunk-buster.
static PlayerBuster	createPlayerBuster(org.bukkit.entity.Player player, org.bukkit.Location placedLocation, ChunkBuster buster) Create a new player-buster.
static BlockData	getBlockData(org.bukkit.block.Block block) Get block-data from a block object
static ChunkBuster	getChunkBuster(org.bukkit.inventory.ItemStack item) Get a chunk-buster object by it's buster item
static ChunkBuster	getChunkBuster(java.lang.String name) Get a chunk-buster object by it's name
static PlayerBuster	getNotifyBuster(org.bukkit.OfflinePlayer player) Get the player-buster that send notifications to the player.
static PlayerBuster	getPlayerBuster(org.bukkit.Chunk chunk) Get a player-buster from a chunk.
static java.util.List<PlayerBuster>	getPlayerBusters(org.bukkit.OfflinePlayer player) Get all player-buster that are ran by a player.
static WildBuster	getWildBuster() Get the wildbuster object
static void	removePlayerBuster(PlayerBuster buster) Remove a player-buster from cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

WildBusterAPI

public WildBusterAPI()

Method Detail

getChunkBuster

public static ChunkBuster getChunkBuster(java.lang.String name)

Get a chunk-buster object by it's name

Parameters:

name - a name to check

Returns:

chunk-buster object

getChunkBuster

public static ChunkBuster getChunkBuster(org.bukkit.inventory.ItemStack item)

Get a chunk-buster object by it's buster item

Parameters:

item - an item to check

Returns:

chunk-buster object

getPlayerBuster

public static PlayerBuster getPlayerBuster(org.bukkit.Chunk chunk)

Get a player-buster from a chunk.

Parameters:

chunk - chunk to check

Returns:

player-buster object

getPlayerBusters

public static java.util.List<PlayerBuster> getPlayerBusters(org.bukkit.OfflinePlayer player)

Get all player-buster that are ran by a player.

Parameters:

player - player to check

Returns:

list of player-buster objects

createChunkBuster

public static ChunkBuster createChunkBuster(java.lang.String name,
                                            int radius,
                                            org.bukkit.inventory.ItemStack busterItem)

Create a new chunk-buster.

Parameters:

name - The name of the new chunk-buster

radius - The radius of the new chunk-buster

busterItem - The item of the new chunk-buster

Returns:

A new chunk-buster object

createPlayerBuster

public static PlayerBuster createPlayerBuster(org.bukkit.entity.Player player,
                                              org.bukkit.Location placedLocation,
                                              ChunkBuster buster)

Create a new player-buster.

Parameters:

player - player that placed the chunk-buster.

placedLocation - location of chunk-buster

buster - the chunk-buster object

Returns:

A new player-buster object

removePlayerBuster

public static void removePlayerBuster(PlayerBuster buster)

Remove a player-buster from cache. Note: IT DOESN'T STOP IT!

Parameters:

buster - a player-buster to remove

getNotifyBuster

public static PlayerBuster getNotifyBuster(org.bukkit.OfflinePlayer player)

Get the player-buster that send notifications to the player.

Parameters:

player - a player to check

Returns:

The player-buster that notifies.

getBlockData

public static BlockData getBlockData(org.bukkit.block.Block block)

Get block-data from a block object

Parameters:

block - a block to check

Returns:

block data of the provided block

getWildBuster

public static WildBuster getWildBuster()

Get the wildbuster object

Returns:

wildbuster object