com.sk89q.worldguard.bukkit

Class BukkitUtil

java.lang.Object

com.sk89q.worldguard.bukkit.BukkitUtil

public class BukkitUtil
extends Object

Method Summary

Modifier and Type	Method and Description
static Target	createTarget(org.bukkit.block.Block block) Get a blacklist target for the given block.
static Target	createTarget(org.bukkit.block.Block block, org.bukkit.Material material) Get a blacklist target for the given block.
static Target	createTarget(org.bukkit.inventory.ItemStack item) Get a blacklist target for the given item.
static Target	createTarget(org.bukkit.Material material) Get a blacklist target for the given material.
static void	dropSign(org.bukkit.block.Block block) Deprecated. see Block.breakNaturally()
static void	findFreePosition(org.bukkit.entity.Player player) Find a position for the player to stand that is not inside a block.
static Collection<? extends org.bukkit.entity.Player>	getOnlinePlayers() Get a collection of the currently online players.
static int	getPotionEffectBits(org.bukkit.inventory.ItemStack item) Get just the potion effect bits.
static boolean	isBlockWater(org.bukkit.World world, int ox, int oy, int oz) Checks if the given block is water
static boolean	isIntensiveEntity(org.bukkit.entity.Entity entity) Returns whether an entity should be removed for the halt activity mode.
static boolean	isWaterPotion(org.bukkit.inventory.ItemStack item) Checks if the given potion is a vial of water.
static org.bukkit.entity.Player	matchSinglePlayer(org.bukkit.Server server, String name) Deprecated. see WorldGuardPlugin.matchSinglePlayer(org.bukkit.command.CommandSender, String)
static String	replaceColorMacros(String str) Replace color macros in a string.
static void	setBlockToWater(org.bukkit.World world, int ox, int oy, int oz) Sets the given block to fluid water.
static org.bukkit.Location	toLocation(org.bukkit.World world, com.sk89q.worldedit.Vector vec) Converts a WorldEdit vector to a Bukkit location.
static ProtectedRegion	toRegion(org.bukkit.Chunk chunk) Create a dummy region that encompasses the size of a chunk.
static com.sk89q.worldedit.BlockVector	toVector(org.bukkit.block.Block block) Converts the location of a Bukkit block to a WorldEdit vector.
static com.sk89q.worldedit.Vector	toVector(org.bukkit.Location loc) Converts a Bukkit location to a WorldEdit vector.
static com.sk89q.worldedit.Vector	toVector(org.bukkit.util.Vector vector) Converts a Bukkit vector to a WorldEdit vector.
static <T extends Enum<T>> T	tryEnum(Class<T> enumType, String... values) Deprecated. use Enums.findByValue(Class, String...)

Methods inherited from class java.lang.Object

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

Method Detail

toVector

public static com.sk89q.worldedit.BlockVector toVector(org.bukkit.block.Block block)

Converts the location of a Bukkit block to a WorldEdit vector.

Parameters:

block - The block to convert

Returns:

The block's location as a BlockVector

toVector

public static com.sk89q.worldedit.Vector toVector(org.bukkit.Location loc)

Converts a Bukkit location to a WorldEdit vector.

Parameters:

loc - A Bukkit Location

Returns:

A Vector with the location's x, y, and z values

toVector

public static com.sk89q.worldedit.Vector toVector(org.bukkit.util.Vector vector)

Converts a Bukkit vector to a WorldEdit vector.

Parameters:

vector - The Bukkit vector

Returns:

A WorldEdit vector with the same values as the Bukkit vector.

toLocation

public static org.bukkit.Location toLocation(org.bukkit.World world,
                                             com.sk89q.worldedit.Vector vec)

Converts a WorldEdit vector to a Bukkit location.

Parameters:

world - The World to create the new Location with

vec - The vector to use for coordinates

Returns:

The Vector as a location with a World of world

toRegion

public static ProtectedRegion toRegion(org.bukkit.Chunk chunk)

Create a dummy region that encompasses the size of a chunk.

Parameters:

chunk - The chunk

Returns:

The dummy region

matchSinglePlayer

@Deprecated
public static org.bukkit.entity.Player matchSinglePlayer(org.bukkit.Server server,
                                                                     String name)

Deprecated. see WorldGuardPlugin.matchSinglePlayer(org.bukkit.command.CommandSender, String)

Matches one player based on name.

Parameters:

server - The server to check

name - The name to attempt to match

Returns:

The matched player if any, otherwise null

dropSign

@Deprecated
public static void dropSign(org.bukkit.block.Block block)

Deprecated. see Block.breakNaturally()

Drops a sign item and removes a sign.

Parameters:

block - The block

setBlockToWater

public static void setBlockToWater(org.bukkit.World world,
                                   int ox,
                                   int oy,
                                   int oz)

Sets the given block to fluid water. Used by addSpongeWater()

Parameters:

world -

ox -

oy -

oz -

isBlockWater

public static boolean isBlockWater(org.bukkit.World world,
                                   int ox,
                                   int oy,
                                   int oz)

Checks if the given block is water

Parameters:

world - the world

ox - x

oy - y

oz - z

Returns:

true if it's water

isWaterPotion

public static boolean isWaterPotion(org.bukkit.inventory.ItemStack item)

Checks if the given potion is a vial of water.

Parameters:

item - the item to check

Returns:

true if it's a water vial

getPotionEffectBits

public static int getPotionEffectBits(org.bukkit.inventory.ItemStack item)

Get just the potion effect bits. This is to work around bugs with potion parsing.

Parameters:

item - item

Returns:

new bits

findFreePosition

public static void findFreePosition(org.bukkit.entity.Player player)

Find a position for the player to stand that is not inside a block. Blocks above the player will be iteratively tested until there is a series of two free blocks. The player will be teleported to that free position.

Parameters:

player -

replaceColorMacros

public static String replaceColorMacros(String str)

Replace color macros in a string. The macros are in the form of `[char] where char represents the color. R is for red, Y is for yellow, G is for green, C is for cyan, B is for blue, and P is for purple. The uppercase versions of those are the darker shades, while the lowercase versions are the lighter shades. For white, it's 'w', and 0-2 are black, dark grey, and grey, respectively.

Parameters:

str -

Returns:

color-coded string

isIntensiveEntity

public static boolean isIntensiveEntity(org.bukkit.entity.Entity entity)

Returns whether an entity should be removed for the halt activity mode.

Parameters:

entity -

Returns:

true if it's to be removed

tryEnum

@Deprecated
public static <T extends Enum<T>> T tryEnum(Class<T> enumType,
                                                        String... values)

Deprecated. use Enums.findByValue(Class, String...)

Search an enum for a value, and return the first one found. Return null if the enum entry is not found.

Parameters:

enumType - enum class

values - values to test

Returns:

a value in the enum or null

createTarget

public static Target createTarget(org.bukkit.block.Block block)

Get a blacklist target for the given block.

Parameters:

block - the block

Returns:

a target

createTarget

public static Target createTarget(org.bukkit.block.Block block,
                                  org.bukkit.Material material)

Get a blacklist target for the given block.

Parameters:

block - the block

material - a fallback material

Returns:

a target

createTarget

public static Target createTarget(org.bukkit.inventory.ItemStack item)

Get a blacklist target for the given item.

Parameters:

item - the item

Returns:

a target

createTarget

public static Target createTarget(org.bukkit.Material material)

Get a blacklist target for the given material.

Parameters:

material - the material

Returns:

a target

getOnlinePlayers

public static Collection<? extends org.bukkit.entity.Player> getOnlinePlayers()

Get a collection of the currently online players.

Returns:

The online players