gyurix.spigotutils

Class BlockData

java.lang.Object

gyurix.spigotutils.BlockData

All Implemented Interfaces:

ConfigSerialization.StringSerializable, java.lang.Comparable<BlockData>

public class BlockData
extends java.lang.Object
implements ConfigSerialization.StringSerializable, java.lang.Comparable<BlockData>

Class used for storing the data of a block, or an item

Field Summary

Fields

Modifier and Type	Field and Description
boolean	anydata True if the BlockData can be applied to any subtype of the block
short	data The requested subtype of the block
int	id The requested type of the block
org.bukkit.Material	material The requested type of the block

Constructor Summary

Constructors

Constructor and Description
BlockData(org.bukkit.block.Block b) Constructs a new BlockData representing the type of the given block
BlockData(org.bukkit.block.BlockState b) Constructs a new BlockData representing the type of the given block state
BlockData(int id) Constructs a new BlockData with the allowing any subtypes of the given item/block id
BlockData(int id, short data) Constructs a new BlockData of the given item/block id and subtype
BlockData(org.bukkit.inventory.ItemStack is) Makes a new BlockData from an ItemStack
BlockData(org.bukkit.Material type)
BlockData(org.bukkit.Material type, short durability)
BlockData(java.lang.String in) Makes a new Block data from a String, which should have format [itemId|itemName][:subType]

Method Summary

Modifier and Type	Method and Description
BlockData	clone() Makes a copy of the BlockData, storing all it's parameters
int	compareTo(BlockData o)
boolean	equals(java.lang.Object obj)
org.bukkit.Material	getType()
int	hashCode()
boolean	isBlock(org.bukkit.block.Block b) Checks if the given block has the same type as this block data.
void	sendChange(org.bukkit.entity.Player plr, org.bukkit.Location loc)
void	setBlock(org.bukkit.block.Block b) Sets the given blocks type and id to the one stored by this BlockData with allowing Minecraft physics calculations.
void	setBlockNoPhysics(org.bukkit.block.Block b) Sets the given blocks type and id to the one stored by this BlockData without allowing Minecraft physics calculations.
org.bukkit.inventory.ItemStack	toItem() Converts this block data to an item
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

anydata

public boolean anydata

True if the BlockData can be applied to any subtype of the block

data

public short data

The requested subtype of the block

id

public int id

The requested type of the block

material

public org.bukkit.Material material

The requested type of the block

Constructor Detail

BlockData

public BlockData(org.bukkit.block.Block b)

Constructs a new BlockData representing the type of the given block

Parameters:

b - - Target Block

BlockData

public BlockData(org.bukkit.block.BlockState b)

Constructs a new BlockData representing the type of the given block state

Parameters:

b - - Target Block

BlockData

public BlockData(int id)

Constructs a new BlockData with the allowing any subtypes of the given item/block id

Parameters:

id - - The wanted block / item id

BlockData

public BlockData(int id,
                 short data)

Constructs a new BlockData of the given item/block id and subtype

Parameters:

id - - The items / blocks id

data - - The items / blocks subtype

BlockData

public BlockData(java.lang.String in)

Makes a new Block data from a String, which should have format [itemId|itemName][:subType]

Parameters:

in - - The convertable String

BlockData

public BlockData(org.bukkit.inventory.ItemStack is)

Makes a new BlockData from an ItemStack

Parameters:

is - - The convertable ItemStack

BlockData

public BlockData(org.bukkit.Material type)

BlockData

public BlockData(org.bukkit.Material type,
                 short durability)

Method Detail

compareTo

public int compareTo(BlockData o)

Specified by:

compareTo in interface java.lang.Comparable<BlockData>

getType

public org.bukkit.Material getType()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

clone

public BlockData clone()

Makes a copy of the BlockData, storing all it's parameters

Overrides:

clone in class java.lang.Object

Returns:

The copy of the BlockData

toString

public java.lang.String toString()

Specified by:

toString in interface ConfigSerialization.StringSerializable

Overrides:

toString in class java.lang.Object

isBlock

public boolean isBlock(org.bukkit.block.Block b)

Checks if the given block has the same type as this block data.

Parameters:

b - - Checkable block

Returns:

True if the block's type is the same as this block data

sendChange

public void sendChange(org.bukkit.entity.Player plr,
                       org.bukkit.Location loc)

setBlock

public void setBlock(org.bukkit.block.Block b)

Sets the given blocks type and id to the one stored by this BlockData with allowing Minecraft physics calculations.

Parameters:

b - - Setable block

setBlockNoPhysics

public void setBlockNoPhysics(org.bukkit.block.Block b)

Sets the given blocks type and id to the one stored by this BlockData without allowing Minecraft physics calculations.

Parameters:

b - - Setable block

toItem

public org.bukkit.inventory.ItemStack toItem()

Converts this block data to an item

Returns:

The conversion result