org.block.api

Class BlockAPI

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

org.block.api.BlockAPI

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class BlockAPI
extends org.bukkit.plugin.java.JavaPlugin

Main class of the BlockAPI, provides useful static methods, and the only class that can link every class in the plugin.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList<CustomBlock>	customBlocks
private java.util.logging.Logger	logger The Minecraft Logger ( in the console )
private BlockPersistence	persist
static BlockAPI	plugin

Constructor Summary

Constructors

Constructor and Description
BlockAPI()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addMyCustomBlock(CustomBlock block) Add your own custom block
int	addMyCustomBlocks(CustomBlock... blocks) Add your own custom blocks
int	addMyCustomBlocks(java.util.List<CustomBlock> blockList) Add your own custom blocks
static org.bukkit.inventory.Recipe	createCraftRecipe(org.bukkit.inventory.ItemStack result, org.bukkit.material.MaterialData[] stacks) Create a shaped craft recipe, easily.
CustomBlock	getCustomBlock(org.bukkit.block.Block block) Get the custom block of this block.
CustomBlock	getCustomBlock(org.bukkit.inventory.ItemStack item) Get the custom block from a book item If none match return null
CustomBlock	getCustomBlock(java.lang.String identifier) Get the custom block with the specified identifier.
static int	getCustomBlockAmount(org.bukkit.inventory.ItemStack item) Get the amount of a custom block that is represented as an item
private CustomBlock	getCustomBlockFromName(java.lang.String name) Get the custom block from its name If none was found return null
java.util.ArrayList<CustomBlock>	getCustomBlocks()
static BlockAPI	getInstance()
static org.bukkit.inventory.ItemStack	getItem(CustomBlock block) Get a book that will match to the format of this custom block
private java.util.logging.Logger	getLoggerSafely() Get the Bukkit logger first, before we try to create our own
boolean	isIdTaken(java.lang.String identifier) Check if a specified identifier is taken if you will use your metadata value for some purposes, you should check if your identifier is taken
boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command cmd, java.lang.String label, java.lang.String[] args)
void	onDisable()
void	onEnable()
void	registerRecipe(org.bukkit.inventory.Recipe... recipes) Register all the given recipe
static org.bukkit.block.Block	setBlock(CustomBlock cblock, org.bukkit.block.Block block) Change that block to the given custom block
static org.bukkit.inventory.ItemStack	setCustomBlockAmount(org.bukkit.inventory.ItemStack item, int amount) Change the amount of a custom block that is represented as an item

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDatabase, getDatabaseClasses, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPluginLoader, getResource, getServer, initialize, installDDL, isEnabled, isInitialized, isNaggable, onLoad, onTabComplete, reloadConfig, removeDDL, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toString

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

plugin

public static BlockAPI plugin

logger

private java.util.logging.Logger logger

The Minecraft Logger ( in the console )

customBlocks

private java.util.ArrayList<CustomBlock> customBlocks

persist

private BlockPersistence persist

Constructor Detail

BlockAPI

public BlockAPI()

Method Detail

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

onCommand

public boolean onCommand(org.bukkit.command.CommandSender sender,
                org.bukkit.command.Command cmd,
                java.lang.String label,
                java.lang.String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

Overrides:

onCommand in class org.bukkit.plugin.java.JavaPlugin

getLoggerSafely

private java.util.logging.Logger getLoggerSafely()

Get the Bukkit logger first, before we try to create our own

getCustomBlocks

public java.util.ArrayList<CustomBlock> getCustomBlocks()

addMyCustomBlock

public boolean addMyCustomBlock(CustomBlock block)

Add your own custom block

Returns:

if the block was succesfully added

addMyCustomBlocks

public int addMyCustomBlocks(CustomBlock... blocks)

Add your own custom blocks

Returns:

the number of attempt that failed

addMyCustomBlocks

public int addMyCustomBlocks(java.util.List<CustomBlock> blockList)

Add your own custom blocks

Returns:

the number of attempt that failed

getCustomBlock

public CustomBlock getCustomBlock(java.lang.String identifier)

Get the custom block with the specified identifier. If none was found return null

getCustomBlockFromName

private CustomBlock getCustomBlockFromName(java.lang.String name)

Get the custom block from its name If none was found return null

getCustomBlock

public CustomBlock getCustomBlock(org.bukkit.inventory.ItemStack item)

Get the custom block from a book item If none match return null

getCustomBlock

public CustomBlock getCustomBlock(org.bukkit.block.Block block)

Get the custom block of this block. If none was found return null

isIdTaken

public boolean isIdTaken(java.lang.String identifier)

Check if a specified identifier is taken if you will use your metadata value for some purposes, you should check if your identifier is taken

registerRecipe

public void registerRecipe(org.bukkit.inventory.Recipe... recipes)

Register all the given recipe

getInstance

public static BlockAPI getInstance()

Returns:

an instance of this class, mainly added for CustomBlock

setBlock

public static org.bukkit.block.Block setBlock(CustomBlock cblock,
                              org.bukkit.block.Block block)

Change that block to the given custom block

getItem

public static org.bukkit.inventory.ItemStack getItem(CustomBlock block)

Get a book that will match to the format of this custom block

getCustomBlockAmount

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

Get the amount of a custom block that is represented as an item

setCustomBlockAmount

public static org.bukkit.inventory.ItemStack setCustomBlockAmount(org.bukkit.inventory.ItemStack item,
                                                  int amount)

Change the amount of a custom block that is represented as an item

createCraftRecipe

public static org.bukkit.inventory.Recipe createCraftRecipe(org.bukkit.inventory.ItemStack result,
                                            org.bukkit.material.MaterialData[] stacks)

Create a shaped craft recipe, easily. To register a recipe call register(recipe)

Parameters:

result - is the item the player will be given

stacks - is an itemstack( materialdata can be obtained from an item stack ) array the size must be 9, it will be like the recipe will be in the craft

Returns:

the recipe or null if any argument is null or if the recipe is null