org.block.api

Class CustomBlock

java.lang.Object

org.block.api.CustomBlock

public class CustomBlock
extends java.lang.Object

Represents a custom block simuled by the server and this plugin.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	description The List that will be used on their items with setLore(list) method
private java.util.List<org.bukkit.inventory.ItemStack>	drops These items will be the default one dropped when the block is destroyed
private float	hardness This is the hardness value, it will be used when this block should explode if the hardness is greater than yield then the block isn't destroyed A negative value is a non-explodable block
private int	id This is the id of the block, it will render to
private java.lang.String	identifier This will be the metadata string to identify your block.
private java.util.ArrayList<org.bukkit.Location>	locs All the locs where this block has been placed
private int	maxStackSize This the maximum amount of item stackable
private java.lang.String	name This is the name of this custom block
private org.bukkit.inventory.Recipe	recipe This is the default recipe for this custom block By default it's null until you call setRecipe(Recipe rec);

Constructor Summary

Constructors

Constructor and Description
CustomBlock() You should set its identifier and name because currently it's a random
CustomBlock(java.lang.String id) This will be the metadata string to identify your block.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLocation(org.bukkit.Location loc)
void	burn(org.bukkit.event.block.BlockBurnEvent event) Fired when this block has burnt
void	burning(org.bukkit.event.block.BlockIgniteEvent event) Fired when this block is burning
void	collide(org.bukkit.event.vehicle.VehicleBlockCollisionEvent event) Fired when a vehicle collide with this block
void	damage(org.bukkit.event.block.BlockDamageEvent event) Fired when this block is damaged by a player
void	destroy(org.bukkit.event.block.BlockBreakEvent event) Fired when this block is destroyed
boolean	equals(org.bukkit.block.Block block) Check if a block match to this custom block
void	exploded(org.bukkit.event.entity.EntityExplodeEvent event, org.bukkit.block.Block block) Fired when this block was destroyed by an explosion
int	getBlockID() This is the id of the block, it will render to
java.util.List<java.lang.String>	getDescription() Get the List that will be used on their items with setLore(list) method
java.util.List<org.bukkit.inventory.ItemStack>	getDrops()
float	getHardness()
java.lang.String	getIdentifier() This is the metadata string that identify this block
java.util.ArrayList<org.bukkit.Location>	getLocs()
int	getMaxStackSize() This the maximum amount of item stackable
java.lang.String	getName()
org.bukkit.inventory.Recipe	getRecipe() Be aware if not set by user @return null
void	handleDestroy(org.bukkit.event.block.BlockBreakEvent event)
void	handleExplode(org.bukkit.event.entity.EntityExplodeEvent event, org.bukkit.block.Block block)
void	handlePlace(org.bukkit.event.player.PlayerInteractEvent event, BlockAPI plugin) Thrown when a player right click with a book that match the format of this block
void	hanging_placed(org.bukkit.event.hanging.HangingPlaceEvent event) Fired when an hanging is placed on this block
void	leftClick(org.bukkit.event.player.PlayerInteractEvent event) Fired when a player left click on this block
void	physics(org.bukkit.event.block.BlockPhysicsEvent event) Fired when some physics concern this custom block e.g: like when a sand block falls
void	place(org.bukkit.event.block.BlockPlaceEvent event) Fired when this block is placed
void	power(org.bukkit.event.block.BlockRedstoneEvent event) Fired when this block is powered by redstone
void	projectile_hit(org.bukkit.event.entity.ProjectileHitEvent event, org.bukkit.block.Block block) Fired when a projectile hit this block
void	removeLocation(org.bukkit.Location location)
void	rightClick(org.bukkit.event.player.PlayerInteractEvent event) Fired when a player right click on this block
void	setBlockID(int id) This is the id of the block, it will render to currently only render as block so from 1 to 255
void	setDescription(java.util.List<java.lang.String> description) Set the List that will be used on their items with setLore(list) method
void	setDrops(org.bukkit.inventory.ItemStack... drops)
void	setDrops(java.util.List<org.bukkit.inventory.ItemStack> drops)
void	setHardness(float hardness)
void	setMaxStackSize(int maxStackSize) This the maximum amount of item stackable
void	setName(java.lang.String name)
void	setRecipe(org.bukkit.inventory.Recipe recipe) Set the default recipe to this one, nothing is done with is, it's only for futur uses or other developers uses To get help to create a recipe see BlockAPI
void	walk(org.bukkit.event.player.PlayerMoveEvent event) Fired when a player walk on this block

Methods inherited from class java.lang.Object

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

Field Detail

identifier

private java.lang.String identifier

This will be the metadata string to identify your block. If you do not set it or if it is already taken it will be generated randomly

name

private java.lang.String name

This is the name of this custom block

id

private int id

This is the id of the block, it will render to

maxStackSize

private int maxStackSize

This the maximum amount of item stackable

locs

private java.util.ArrayList<org.bukkit.Location> locs

All the locs where this block has been placed

recipe

private org.bukkit.inventory.Recipe recipe

This is the default recipe for this custom block By default it's null until you call setRecipe(Recipe rec);

drops

private java.util.List<org.bukkit.inventory.ItemStack> drops

These items will be the default one dropped when the block is destroyed

hardness

private float hardness

This is the hardness value, it will be used when this block should explode if the hardness is greater than yield then the block isn't destroyed A negative value is a non-explodable block

description

private java.util.List<java.lang.String> description

The List that will be used on their items with setLore(list) method

Constructor Detail

CustomBlock

public CustomBlock()

You should set its identifier and name because currently it's a random

CustomBlock

public CustomBlock(java.lang.String id)

This will be the metadata string to identify your block. If you do not set it or if it is already taken it will be generated randomly

Method Detail

getIdentifier

public java.lang.String getIdentifier()

This is the metadata string that identify this block

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

handlePlace

public final void handlePlace(org.bukkit.event.player.PlayerInteractEvent event,
               BlockAPI plugin)

Thrown when a player right click with a book that match the format of this block

place

public void place(org.bukkit.event.block.BlockPlaceEvent event)

Fired when this block is placed

handleDestroy

public final void handleDestroy(org.bukkit.event.block.BlockBreakEvent event)

destroy

public void destroy(org.bukkit.event.block.BlockBreakEvent event)

Fired when this block is destroyed

power

public void power(org.bukkit.event.block.BlockRedstoneEvent event)

Fired when this block is powered by redstone

burn

public void burn(org.bukkit.event.block.BlockBurnEvent event)

Fired when this block has burnt

burning

public void burning(org.bukkit.event.block.BlockIgniteEvent event)

Fired when this block is burning

damage

public void damage(org.bukkit.event.block.BlockDamageEvent event)

Fired when this block is damaged by a player

walk

public void walk(org.bukkit.event.player.PlayerMoveEvent event)

Fired when a player walk on this block

leftClick

public void leftClick(org.bukkit.event.player.PlayerInteractEvent event)

Fired when a player left click on this block

rightClick

public void rightClick(org.bukkit.event.player.PlayerInteractEvent event)

Fired when a player right click on this block

collide

public void collide(org.bukkit.event.vehicle.VehicleBlockCollisionEvent event)

Fired when a vehicle collide with this block

handleExplode

public final void handleExplode(org.bukkit.event.entity.EntityExplodeEvent event,
                 org.bukkit.block.Block block)

exploded

public void exploded(org.bukkit.event.entity.EntityExplodeEvent event,
            org.bukkit.block.Block block)

Fired when this block was destroyed by an explosion

Parameters:

block - is the block that matches to this custom block

hanging_placed

public void hanging_placed(org.bukkit.event.hanging.HangingPlaceEvent event)

Fired when an hanging is placed on this block

projectile_hit

public void projectile_hit(org.bukkit.event.entity.ProjectileHitEvent event,
                  org.bukkit.block.Block block)

Fired when a projectile hit this block

physics

public void physics(org.bukkit.event.block.BlockPhysicsEvent event)

Fired when some physics concern this custom block e.g: like when a sand block falls

getBlockID

public int getBlockID()

This is the id of the block, it will render to

getMaxStackSize

public int getMaxStackSize()

This the maximum amount of item stackable

setMaxStackSize

public void setMaxStackSize(int maxStackSize)

This the maximum amount of item stackable

getRecipe

public org.bukkit.inventory.Recipe getRecipe()

Be aware if not set by user @return null

setRecipe

public void setRecipe(org.bukkit.inventory.Recipe recipe)

Set the default recipe to this one, nothing is done with is, it's only for futur uses or other developers uses To get help to create a recipe see BlockAPI

getDrops

public java.util.List<org.bukkit.inventory.ItemStack> getDrops()

setDrops

public void setDrops(java.util.List<org.bukkit.inventory.ItemStack> drops)

setDrops

public void setDrops(org.bukkit.inventory.ItemStack... drops)

getHardness

public float getHardness()

setHardness

public void setHardness(float hardness)

getDescription

public java.util.List<java.lang.String> getDescription()

Get the List that will be used on their items with setLore(list) method

setDescription

public void setDescription(java.util.List<java.lang.String> description)

Set the List that will be used on their items with setLore(list) method

setBlockID

public void setBlockID(int id)

This is the id of the block, it will render to currently only render as block so from 1 to 255

equals

public boolean equals(org.bukkit.block.Block block)

Check if a block match to this custom block

addLocation

public void addLocation(org.bukkit.Location loc)

removeLocation

public void removeLocation(org.bukkit.Location location)

getLocs

public java.util.ArrayList<org.bukkit.Location> getLocs()