com.palmergames.bukkit.util

Class BukkitTools

java.lang.Object

com.palmergames.bukkit.util.BukkitTools

public class BukkitTools
extends java.lang.Object

A class of functions related to Bukkit in general.

Version:

1.0

Author:

Shade (Chris H, ElgarL)

Constructor Summary

Constructors

Constructor and Description
BukkitTools()

Method Summary

Methods

Modifier and Type	Method and Description
static int	calcChunk(int value) Accepts an X or Z value and returns the associated Towny plot value.
static org.bukkit.block.Block	getBlockOffset(org.bukkit.block.Block block, int xOffset, int yOffset, int zOffset) Find a block at a specific offset.
static byte	getData(org.bukkit.block.Block block)
static org.bukkit.material.MaterialData	getData(org.bukkit.block.BlockState state)
static org.bukkit.material.MaterialData	getData(org.bukkit.inventory.ItemStack stack)
static byte	getDataData(org.bukkit.block.BlockState state)
static byte	getDataData(org.bukkit.inventory.ItemStack stack)
static org.bukkit.Material	getMaterial(int id) Find a Material from an Id.
static org.bukkit.Material	getMaterial(java.lang.String name) Find a Material from an enum name.
static int	getMaterialId(org.bukkit.Material material) Get the Id (magic number) of a Material type.
static org.bukkit.entity.Player[]	getOnlinePlayers() Get an array of all online players
static org.bukkit.entity.Player	getPlayer(java.lang.String playerId)
static org.bukkit.entity.Player	getPlayerExact(java.lang.String name)
static java.util.HashMap<java.lang.String,java.lang.Integer>	getPlayersPerWorld() Count the number of players online in each world
static org.bukkit.plugin.PluginManager	getPluginManager()
static org.bukkit.scheduler.BukkitScheduler	getScheduler()
static org.bukkit.Server	getServer()
static org.bukkit.Material	getType(org.bukkit.block.BlockState state)
static int	getTypeId(org.bukkit.block.Block block)
static int	getTypeId(org.bukkit.block.BlockState state)
static int	getTypeId(org.bukkit.inventory.ItemStack stack)
static java.util.List<java.lang.String>	getWhiteListedUsers() Compiles a list of all whitelisted users.
static org.bukkit.World	getWorld(java.lang.String name)
static java.util.List<org.bukkit.World>	getWorlds()
static void	initialize(Towny plugin)
static boolean	isOnline(java.lang.String playerId) Tests if this player is online.
static boolean	isPrimaryThread()
static java.util.List<org.bukkit.entity.Player>	matchPlayer(java.lang.String name)
static int	scheduleAsyncDelayedTask(java.lang.Runnable task, long delay) Accepts a Runnable object and a delay (-1 for no delay)
static int	scheduleAsyncRepeatingTask(java.lang.Runnable task, long delay, long repeat) Accepts a Runnable object with a delay/repeat (-1 for no delay)
static int	scheduleSyncDelayedTask(java.lang.Runnable task, long delay) Accepts a Runnable object and a delay (-1 for no delay)
static int	scheduleSyncRepeatingTask(java.lang.Runnable task, long delay, long repeat) Accepts a Runnable object with a delay/repeat (-1 for no delay)
static void	setData(org.bukkit.block.Block block, byte data, boolean applyPhysics)
static void	setTypeId(org.bukkit.block.Block block, int type, boolean applyPhysics)
static void	setTypeIdAndData(org.bukkit.block.Block block, int type, byte data, boolean applyPhysics)

Methods inherited from class java.lang.Object

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

Constructor Detail

BukkitTools

public BukkitTools()

Method Detail

initialize

public static void initialize(Towny plugin)

getOnlinePlayers

public static org.bukkit.entity.Player[] getOnlinePlayers()

Get an array of all online players

Returns:

array of online players

matchPlayer

public static java.util.List<org.bukkit.entity.Player> matchPlayer(java.lang.String name)

getPlayerExact

public static org.bukkit.entity.Player getPlayerExact(java.lang.String name)

getPlayer

public static org.bukkit.entity.Player getPlayer(java.lang.String playerId)

isOnline

public static boolean isOnline(java.lang.String playerId)

Tests if this player is online.

Parameters:

playerId - the UUID or name of the player.

Returns:

a true value if online

getWorlds

public static java.util.List<org.bukkit.World> getWorlds()

getWorld

public static org.bukkit.World getWorld(java.lang.String name)

getServer

public static org.bukkit.Server getServer()

getPluginManager

public static org.bukkit.plugin.PluginManager getPluginManager()

getScheduler

public static org.bukkit.scheduler.BukkitScheduler getScheduler()

isPrimaryThread

public static boolean isPrimaryThread()

scheduleSyncDelayedTask

public static int scheduleSyncDelayedTask(java.lang.Runnable task,
                          long delay)

Accepts a Runnable object and a delay (-1 for no delay)

Parameters:

task - runnable object

delay - ticks to delay starting

Returns:

-1 if unable to schedule or an index to the task is successful.

scheduleAsyncDelayedTask

public static int scheduleAsyncDelayedTask(java.lang.Runnable task,
                           long delay)

Accepts a Runnable object and a delay (-1 for no delay)

Parameters:

task -

delay - ticks to delay starting

Returns:

-1 if unable to schedule or an index to the task is successful.

scheduleSyncRepeatingTask

public static int scheduleSyncRepeatingTask(java.lang.Runnable task,
                            long delay,
                            long repeat)

Accepts a Runnable object with a delay/repeat (-1 for no delay)

Parameters:

task - runnable object

delay - ticks to delay starting

repeat - ticks to repeat after

Returns:

-1 if unable to schedule or an index to the task is successful.

scheduleAsyncRepeatingTask

public static int scheduleAsyncRepeatingTask(java.lang.Runnable task,
                             long delay,
                             long repeat)

Accepts a Runnable object with a delay/repeat (-1 for no delay)

Parameters:

task - runnable object

delay - ticks to delay starting

repeat - ticks to repeat after

Returns:

-1 if unable to schedule or an index to the task is successful.

getPlayersPerWorld

public static java.util.HashMap<java.lang.String,java.lang.Integer> getPlayersPerWorld()

Count the number of players online in each world

Returns:

Map of world to online players.

getBlockOffset

public static org.bukkit.block.Block getBlockOffset(org.bukkit.block.Block block,
                                    int xOffset,
                                    int yOffset,
                                    int zOffset)

Find a block at a specific offset.

Parameters:

block -

xOffset -

yOffset -

zOffset -

Returns:

Block at the new location.

getTypeId

public static int getTypeId(org.bukkit.block.Block block)

getData

public static byte getData(org.bukkit.block.Block block)

setTypeIdAndData

public static void setTypeIdAndData(org.bukkit.block.Block block,
                    int type,
                    byte data,
                    boolean applyPhysics)

setTypeId

public static void setTypeId(org.bukkit.block.Block block,
             int type,
             boolean applyPhysics)

setData

public static void setData(org.bukkit.block.Block block,
           byte data,
           boolean applyPhysics)

getType

public static org.bukkit.Material getType(org.bukkit.block.BlockState state)

getTypeId

public static int getTypeId(org.bukkit.block.BlockState state)

getData

public static org.bukkit.material.MaterialData getData(org.bukkit.block.BlockState state)

getDataData

public static byte getDataData(org.bukkit.block.BlockState state)

getTypeId

public static int getTypeId(org.bukkit.inventory.ItemStack stack)

getData

public static org.bukkit.material.MaterialData getData(org.bukkit.inventory.ItemStack stack)

getDataData

public static byte getDataData(org.bukkit.inventory.ItemStack stack)

getMaterial

public static org.bukkit.Material getMaterial(int id)

Find a Material from an Id.

Parameters:

id -

Returns:

getMaterial

public static org.bukkit.Material getMaterial(java.lang.String name)

Find a Material from an enum name.

Parameters:

name -

Returns:

getMaterialId

public static int getMaterialId(org.bukkit.Material material)

Get the Id (magic number) of a Material type.

Parameters:

material -

Returns:

getWhiteListedUsers

public static java.util.List<java.lang.String> getWhiteListedUsers()

Compiles a list of all whitelisted users.

Returns:

List of all whitelist player names.

calcChunk

public static int calcChunk(int value)

Accepts an X or Z value and returns the associated Towny plot value.

Parameters:

value -

Returns:

int of the relevant townblock x/z.