me.desht.sensibletoolbox.api

Class SensibleToolbox

java.lang.Object

me.desht.sensibletoolbox.api.SensibleToolbox

public class SensibleToolbox
extends Object

Top-level collection of utility methods for Sensible Toolbox.

Constructor Summary

Constructors

Constructor and Description
SensibleToolbox()

Method Summary

Methods

Modifier and Type	Method and Description
static BaseSTBBlock	getBlockAt(Location location) Given a location, return the STB block at that location, if any.
static BaseSTBBlock	getBlockAt(Location location, boolean checkSign) Given a location, return the STB block at that location, if any.
static <T extends BaseSTBBlock> T	getBlockAt(Location location, Class<T> type, boolean checkSign) Given a location, return the STB block at that location, if any.
static BlockProtection	getBlockProtection() Get the block protection handler.
static EnergyNet	getEnergyNet(Block block) Get the energy net for the given block.
static FriendManager	getFriendManager() Get the friend manager object.
static BaseSTBItem	getItemFromItemStack(ItemStack stack) Deprecated. use ItemRegistry.fromItemStack(org.bukkit.inventory.ItemStack)
static <T extends BaseSTBItem> T	getItemfromItemStack(ItemStack stack, Class<T> type) Deprecated. use ItemRegistry.fromItemStack(org.bukkit.inventory.ItemStack, Class)
static ItemRegistry	getItemRegistry() Get the item registry instance, which handles all item registration, retrieval and inspection.
static String	getPlayerNameFromUUID(UUID uuid) Given a UUID, attempt to get the player name for that UUID.
static me.desht.sensibletoolbox.SensibleToolboxPlugin	getPluginInstance() Get an instance of the running Sensible Toolbox plugin.
static void	registerItem(Plugin plugin, BaseSTBItem item) Deprecated. use ItemRegistry.registerItem(me.desht.sensibletoolbox.api.items.BaseSTBItem, org.bukkit.plugin.Plugin)
static void	registerItem(Plugin plugin, BaseSTBItem item, String configNode) Deprecated. use ItemRegistry.registerItem(me.desht.sensibletoolbox.api.items.BaseSTBItem, org.bukkit.plugin.Plugin, String)
static void	registerItem(Plugin plugin, BaseSTBItem item, String configNode, String permissionNode) Deprecated. use ItemRegistry.registerItem(me.desht.sensibletoolbox.api.items.BaseSTBItem, org.bukkit.plugin.Plugin, String, String)

Methods inherited from class java.lang.Object

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

Constructor Detail

SensibleToolbox

public SensibleToolbox()

Method Detail

getPluginInstance

public static me.desht.sensibletoolbox.SensibleToolboxPlugin getPluginInstance()

Get an instance of the running Sensible Toolbox plugin.

Returns:

the SensibleToolboxPlugin instance

getItemRegistry

public static ItemRegistry getItemRegistry()

Get the item registry instance, which handles all item registration, retrieval and inspection.

Returns:

the STB item registry

getItemFromItemStack

@Deprecated
public static BaseSTBItem getItemFromItemStack(ItemStack stack)

Deprecated. use ItemRegistry.fromItemStack(org.bukkit.inventory.ItemStack)

Given an item stack, get the SensibleToolbox object for that item, if any.

Parameters:

stack - the item stack

Returns:

the SensibleToolbox object, or null if the item is not a STB item

getItemfromItemStack

@Deprecated
public static <T extends BaseSTBItem> T getItemfromItemStack(ItemStack stack,
                                                        Class<T> type)

Deprecated. use ItemRegistry.fromItemStack(org.bukkit.inventory.ItemStack, Class)

Given an item stack and item type, get the SensibleToolbox object for that item and type, if any.

Parameters:

stack - the item stack

Returns:

the SensibleToolbox object, or null if the item is not a STB item of the given type

getBlockAt

public static BaseSTBBlock getBlockAt(Location location)

Given a location, return the STB block at that location, if any.

Parameters:

location - the location to check

Returns:

the STB block at that location, or null if there is none

getBlockAt

public static BaseSTBBlock getBlockAt(Location location,
                      boolean checkSign)

Given a location, return the STB block at that location, if any.

Parameters:

location - the location to check

checkSign - if true and the location contains a sign, then also check the location of the block the sign is attached to

Returns:

the STB block at that location, or null if there is none

getBlockAt

public static <T extends BaseSTBBlock> T getBlockAt(Location location,
                                    Class<T> type,
                                    boolean checkSign)

Given a location, return the STB block at that location, if any.

Parameters:

location - the location to check

type - the block must be an instance or a subclass of this type

checkSign - if true and the location contains a sign, then also check the location of the block the sign is attached to

Returns:

the STB block at that location, or null if there is no block of the given type

getPlayerNameFromUUID

public static String getPlayerNameFromUUID(UUID uuid)

Given a UUID, attempt to get the player name for that UUID. This will only succeed if that player has previously connected to this server, in which case the last known name for the UUID will be returned. If the player has changed their name since last logging in, this change will not be reflected in the return value for this method.

This method does not require contacting any external servers, so is safe to call from the main server thread.

Parameters:

uuid - the UUID to check

Returns:

the last known player name for this UUID, if any (null if name not known)

registerItem

@Deprecated
public static void registerItem(Plugin plugin,
                           BaseSTBItem item)

Deprecated. use ItemRegistry.registerItem(me.desht.sensibletoolbox.api.items.BaseSTBItem, org.bukkit.plugin.Plugin)

Register a new item with SensibleToolbox. The item must be a subclass of BaseSTBItem.

Parameters:

plugin - the plugin doing the registration

item - an instance of the item to be registered

registerItem

@Deprecated
public static void registerItem(Plugin plugin,
                           BaseSTBItem item,
                           String configNode)

Deprecated. use ItemRegistry.registerItem(me.desht.sensibletoolbox.api.items.BaseSTBItem, org.bukkit.plugin.Plugin, String)

Register an item with Sensible Toolbox. The item must be a subclass of BaseSTBItem.

Parameters:

plugin - the plugin doing the registration

item - an instance of the item to be registered

configNode - the parent configuration node prefix controlling enablement

registerItem

@Deprecated
public static void registerItem(Plugin plugin,
                           BaseSTBItem item,
                           String configNode,
                           String permissionNode)

Deprecated. use ItemRegistry.registerItem(me.desht.sensibletoolbox.api.items.BaseSTBItem, org.bukkit.plugin.Plugin, String, String)

Register an item with Sensible Toolbox. The item must be a subclass of BaseSTBItem.

Parameters:

plugin - the plugin doing the registration

item - an instance of the item to be registered

configNode - the parent configuration node prefix controlling enablement

permissionNode - the permission node prefix for registering item permissions

getFriendManager

public static FriendManager getFriendManager()

Get the friend manager object. This object is responsible for managing the trust relationships between players, primarily to support Restricted access mode on STB blocks.

Returns:

the friend manager

getEnergyNet

public static EnergyNet getEnergyNet(Block block)

Get the energy net for the given block.

Parameters:

block - the block to check

getBlockProtection

public static BlockProtection getBlockProtection()

Get the block protection handler. This should be used by any STB block or item which directly modifies blocks in the world or vanilla inventories, to reduce the possibilty of griefing.