com.bgsoftware.wildbuster.api.objects

Interface PlayerBuster

public interface PlayerBuster

Method Summary

Modifier and Type	Method and Description
void	deleteBuster(boolean giveBusterItem) Delete this chunk buster.
java.lang.String	getBusterName() Get the name of the chunk buster type.
java.util.Timer	getBusterTimer() Get the timer object of this chunk buster.
ChunkBuster	getChunkBuster() Get the chunk buster type.
java.util.List<org.bukkit.Chunk>	getChunks() Get all chunks this chunk buster is busting.
int	getCurrentLevel() Get the current level of this chunk buster.
java.util.List<org.bukkit.entity.Player>	getNearbyPlayers() Get all nearby players to this chunk buster.
java.util.List<BlockData>	getRemovedBlocks() Get all the blocks that this chunk buster removed.
int	getTaskID() Deprecated. See getBusterTimer()
java.util.UUID	getUniqueID() Get the uuid of the player who placed this chunk buster.
org.bukkit.World	getWorld() Get the world of this chunk buster.
boolean	isCancelled() Check whether or not this buster is cancelled.
boolean	isNotify() Check whether or not this buster is notifying the player who placed it.
void	performCancel(org.bukkit.command.CommandSender sender) Perform a cancel task.
void	runCancelTask() Start running the reverse chunks task.
void	runRegularTask() Start running the busting chunks task.
void	setNotify() Set the chunk buster to notify the player who placed it.

Method Detail

getBusterName

java.lang.String getBusterName()

Get the name of the chunk buster type.

getChunkBuster

ChunkBuster getChunkBuster()

Get the chunk buster type.

getUniqueID

java.util.UUID getUniqueID()

Get the uuid of the player who placed this chunk buster.

getChunks

java.util.List<org.bukkit.Chunk> getChunks()

Get all chunks this chunk buster is busting.

getWorld

org.bukkit.World getWorld()

Get the world of this chunk buster.

getCurrentLevel

int getCurrentLevel()

Get the current level of this chunk buster.

getTaskID

@Deprecated
int getTaskID()

Deprecated. See getBusterTimer()

Get the task id of this chunk buster.

getBusterTimer

java.util.Timer getBusterTimer()

Get the timer object of this chunk buster.

getRemovedBlocks

java.util.List<BlockData> getRemovedBlocks()

Get all the blocks that this chunk buster removed.

isCancelled

boolean isCancelled()

Check whether or not this buster is cancelled.

isNotify

boolean isNotify()

Check whether or not this buster is notifying the player who placed it.

setNotify

void setNotify()

Set the chunk buster to notify the player who placed it.

runRegularTask

void runRegularTask()

Start running the busting chunks task.

performCancel

void performCancel(org.bukkit.command.CommandSender sender)

Perform a cancel task.

Parameters:

sender - The sender who asks to cancel this chunk buster.

runCancelTask

void runCancelTask()

Start running the reverse chunks task.

deleteBuster

void deleteBuster(boolean giveBusterItem)

Delete this chunk buster.

Parameters:

giveBusterItem - Whether or not the item should be given to the player who placed this chunk buster or not.

getNearbyPlayers

java.util.List<org.bukkit.entity.Player> getNearbyPlayers()

Get all nearby players to this chunk buster.