com.bgsoftware.wildbuster.api.handlers

Interface BustersManager

public interface BustersManager

Method Summary

Modifier and Type	Method and Description
ChunkBuster	createChunkBuster(java.lang.String name, int radius, org.bukkit.inventory.ItemStack busterItem) Create a new chunk buster type.
PlayerBuster	createPlayerBuster(org.bukkit.entity.Player player, org.bukkit.Location placedLocation, ChunkBuster buster) Create a new active chunk buster.
BlockData	getBlockData(org.bukkit.block.Block block) Get a block data from a block.
ChunkBuster	getChunkBuster(org.bukkit.inventory.ItemStack item) Get a chunk buster by it's item.
ChunkBuster	getChunkBuster(java.lang.String name) Get a chunk buster by it's name.
java.util.List<ChunkBuster>	getChunkBusters() Get all available chunk busters.
PlayerBuster	getNotifyBuster(java.util.UUID uuid) Get an active chunk buster that has a notify status enabled.
PlayerBuster	getPlayerBuster(org.bukkit.Chunk chunk) Get an active chunk buster inside a chunk.
java.util.List<PlayerBuster>	getPlayerBusters() Get all current active chunk busters.
java.util.List<PlayerBuster>	getPlayerBusters(org.bukkit.OfflinePlayer player) Get all current active chunk busters by a player.
void	handleBusterPlacement(org.bukkit.entity.Player player, org.bukkit.Location location, ChunkBuster chunkBuster) Handle placement of chunk buster.
boolean	isChunkBusted(org.bukkit.Chunk chunk) Check whether or not a chunk is currently being busted or not.
PlayerBuster	loadPlayerBuster(java.lang.String busterName, java.util.UUID uuid, org.bukkit.World world, boolean cancelStatus, boolean notifyStatus, int currentLevel, java.util.List<org.bukkit.Chunk> chunksList, java.util.List<BlockData> removedBlocks) Load an active chunk buster into cache.
void	removeChunkBusters() Remove all chunk busters from cache.
void	removePlayerBuster(PlayerBuster buster) Remove an active chunk buster.
void	setNotifyBuster(PlayerBuster buster) Change the notify status of a chunk buster.

Method Detail

getChunkBuster

ChunkBuster getChunkBuster(java.lang.String name)

Get a chunk buster by it's name.

Parameters:

name - The name of the chunk buster.

getChunkBuster

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

Get a chunk buster by it's item.

Parameters:

item - The item of the chunk buster.

getChunkBusters

java.util.List<ChunkBuster> getChunkBusters()

Get all available chunk busters.

getPlayerBuster

PlayerBuster getPlayerBuster(org.bukkit.Chunk chunk)

Get an active chunk buster inside a chunk.

Parameters:

chunk - The chunk to check for an active chunk buster.

Returns:

The chunk buster if exists, otherwise null.

isChunkBusted

boolean isChunkBusted(org.bukkit.Chunk chunk)

Check whether or not a chunk is currently being busted or not.

Parameters:

chunk - The chunk to check for being busted.

getPlayerBusters

java.util.List<PlayerBuster> getPlayerBusters()

Get all current active chunk busters.

getPlayerBusters

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

Get all current active chunk busters by a player.

Parameters:

player - The player to check.

createChunkBuster

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

Create a new chunk buster type.

Parameters:

name - The name of the new chunk buster. Must be unique.

radius - The radius of the new chunk buster.

busterItem - The item of the new chunk buster.

removeChunkBusters

void removeChunkBusters()

Remove all chunk busters from cache.

createPlayerBuster

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

Create a new active chunk buster.

Parameters:

player - The player who placed the chunk buster.

placedLocation - The location the chunk buster was placed at.

buster - The chunk buster type.

Returns:

The new active chunk buster.

loadPlayerBuster

PlayerBuster loadPlayerBuster(java.lang.String busterName,
                              java.util.UUID uuid,
                              org.bukkit.World world,
                              boolean cancelStatus,
                              boolean notifyStatus,
                              int currentLevel,
                              java.util.List<org.bukkit.Chunk> chunksList,
                              java.util.List<BlockData> removedBlocks)

Load an active chunk buster into cache.

Parameters:

busterName - The name of the chunk buster type.

uuid - The uuid of the player who placed the chunk buster.

world - The world the chunk buster is active inside.

cancelStatus - The cancel status of the chunk buster.

notifyStatus - The notify status of the chunk buster.

currentLevel - The current level the chunk buster is busting.

chunksList - A list of chunks the chunk buster is busting.

removedBlocks - A list of already removed blocks.

Returns:

The new active chunk buster.

removePlayerBuster

void removePlayerBuster(PlayerBuster buster)

Remove an active chunk buster.

Parameters:

buster - The active chunk buster to remove.

setNotifyBuster

void setNotifyBuster(PlayerBuster buster)

Change the notify status of a chunk buster.

Parameters:

buster - The chunk buster to change its notify status.

getNotifyBuster

PlayerBuster getNotifyBuster(java.util.UUID uuid)

Get an active chunk buster that has a notify status enabled.

Parameters:

uuid - The uuid of the player who placed the chunk buster.

getBlockData

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

Get a block data from a block. The block data caches important information about the block, to be used to restore it later.

Parameters:

block - The block to get data of.

handleBusterPlacement

void handleBusterPlacement(org.bukkit.entity.Player player,
                           org.bukkit.Location location,
                           ChunkBuster chunkBuster)

Handle placement of chunk buster. This method will not check for existing busters, permissions and such. It will only handle the chunk placement event.

Parameters:

player - The player who placed the chunk buster.

location - The location the buster was placed at.

chunkBuster - The chunk buster that was placed.