net.glowstone.block

Class GlowBlock

java.lang.Object

net.glowstone.block.GlowBlock

All Implemented Interfaces:

org.bukkit.block.Block, org.bukkit.metadata.Metadatable

public class GlowBlock
extends Object
implements org.bukkit.block.Block

Represents a single block in a world.

Constructor Summary

Constructors

Constructor and Description
GlowBlock(GlowChunk chunk, int x, int y, int z) Creates an object to refer to a block.

Method Summary

Modifier and Type	Method and Description
void	applyPhysics(org.bukkit.Material oldType, int newTypeId, byte oldData, byte newData) Notify this block and its surrounding blocks that this block has changed type and data.
boolean	breakNaturally()
boolean	breakNaturally(float yield) Break the block naturally, randomly dropping only some of the drops.
boolean	breakNaturally(float yield, Collection<org.bukkit.inventory.ItemStack> drops) Breaks this block and drops items.
boolean	breakNaturally(org.bukkit.inventory.ItemStack tool)
void	count(int timeout) Increments the count of recent state changes.
boolean	equals(Object obj)
org.bukkit.block.Biome	getBiome()
BlockEntity	getBlockEntity()
int	getBlockPower()
int	getBlockPower(org.bukkit.block.BlockFace face)
GlowChunk	getChunk()
int	getCounter() Returns the number of recent state changes, as defined by count(int).
byte	getData()
Collection<org.bukkit.inventory.ItemStack>	getDrops()
Collection<org.bukkit.inventory.ItemStack>	getDrops(org.bukkit.inventory.ItemStack tool)
org.bukkit.block.BlockFace	getFace(org.bukkit.block.Block block)
double	getHumidity()
byte	getLightFromBlocks()
byte	getLightFromSky()
byte	getLightLevel()
org.bukkit.Location	getLocation()
org.bukkit.Location	getLocation(org.bukkit.Location loc)
MaterialValueManager.ValueCollection	getMaterialValues()
List<org.bukkit.metadata.MetadataValue>	getMetadata(String metadataKey)
org.bukkit.block.PistonMoveReaction	getPistonMoveReaction()
GlowBlock	getRelative(org.bukkit.block.BlockFace face)
GlowBlock	getRelative(org.bukkit.block.BlockFace face, int distance)
GlowBlock	getRelative(int modX, int modY, int modZ)
GlowBlockState	getState()
GlowBlockState	getState(boolean useSnapshot)
double	getTemperature()
org.bukkit.Material	getType()
int	getTypeId()
GlowWorld	getWorld()
int	getX()
int	getY()
int	getZ()
int	hashCode()
boolean	hasMetadata(String metadataKey)
boolean	isBlockFaceIndirectlyPowered(org.bukkit.block.BlockFace face)
boolean	isBlockFacePowered(org.bukkit.block.BlockFace face)
boolean	isBlockIndirectlyPowered()
boolean	isBlockPowered()
boolean	isBurnable() Get block material's burn ability.
boolean	isEmpty()
boolean	isFlammable() Get block material's flammable ability.
boolean	isLiquid()
void	removeMetadata(String metadataKey, org.bukkit.plugin.Plugin owningPlugin)
void	setBiome(org.bukkit.block.Biome bio)
void	setData(byte data)
void	setData(byte data, boolean applyPhysics)
void	setMetadata(String metadataKey, org.bukkit.metadata.MetadataValue newMetadataValue)
void	setType(org.bukkit.Material type)
void	setType(org.bukkit.Material type, boolean applyPhysics) Set the Material type of a block and optionally apply physics.
void	setType(org.bukkit.Material type, byte data, boolean applyPhysics) Set the Material type of a block with data and optionally apply physics.
boolean	setTypeId(int type)
boolean	setTypeId(int type, boolean applyPhysics)
boolean	setTypeIdAndData(int type, byte data, boolean applyPhysics)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bukkit.block.Block

getBlockKey

Constructor Detail

GlowBlock

public GlowBlock(GlowChunk chunk,
                 int x,
                 int y,
                 int z)

Creates an object to refer to a block.

Parameters:

chunk - the chunk

x - the X coordinate

y - the Y coordinate

z - the Z coordinate

Method Detail

getChunk

public GlowChunk getChunk()

Specified by:

getChunk in interface org.bukkit.block.Block

getLocation

public org.bukkit.Location getLocation()

Specified by:

getLocation in interface org.bukkit.block.Block

getLocation

public org.bukkit.Location getLocation(org.bukkit.Location loc)

Specified by:

getLocation in interface org.bukkit.block.Block

getBlockEntity

public BlockEntity getBlockEntity()

getState

public GlowBlockState getState()

Specified by:

getState in interface org.bukkit.block.Block

getState

public GlowBlockState getState(boolean useSnapshot)

Specified by:

getState in interface org.bukkit.block.Block

getBiome

public org.bukkit.block.Biome getBiome()

Specified by:

getBiome in interface org.bukkit.block.Block

setBiome

public void setBiome(org.bukkit.block.Biome bio)

Specified by:

setBiome in interface org.bukkit.block.Block

getTemperature

public double getTemperature()

Specified by:

getTemperature in interface org.bukkit.block.Block

getHumidity

public double getHumidity()

Specified by:

getHumidity in interface org.bukkit.block.Block

getFace

public org.bukkit.block.BlockFace getFace(org.bukkit.block.Block block)

Specified by:

getFace in interface org.bukkit.block.Block

getRelative

public GlowBlock getRelative(int modX,
                             int modY,
                             int modZ)

Specified by:

getRelative in interface org.bukkit.block.Block

getRelative

public GlowBlock getRelative(org.bukkit.block.BlockFace face)

Specified by:

getRelative in interface org.bukkit.block.Block

getRelative

public GlowBlock getRelative(org.bukkit.block.BlockFace face,
                             int distance)

Specified by:

getRelative in interface org.bukkit.block.Block

getType

public org.bukkit.Material getType()

Specified by:

getType in interface org.bukkit.block.Block

getTypeId

public int getTypeId()

Specified by:

getTypeId in interface org.bukkit.block.Block

setType

public void setType(org.bukkit.Material type)

Specified by:

setType in interface org.bukkit.block.Block

setType

public void setType(org.bukkit.Material type,
                    boolean applyPhysics)

Set the Material type of a block and optionally apply physics.

Specified by:

setType in interface org.bukkit.block.Block

setType

public void setType(org.bukkit.Material type,
                    byte data,
                    boolean applyPhysics)

Set the Material type of a block with data and optionally apply physics.

Parameters:

type - The type to set the block to.

data - The raw data to set the block to.

applyPhysics - notify this block and surrounding blocks to update physics

setTypeId

public boolean setTypeId(int type)

Specified by:

setTypeId in interface org.bukkit.block.Block

setTypeId

public boolean setTypeId(int type,
                         boolean applyPhysics)

Specified by:

setTypeId in interface org.bukkit.block.Block

setTypeIdAndData

public boolean setTypeIdAndData(int type,
                                byte data,
                                boolean applyPhysics)

Specified by:

setTypeIdAndData in interface org.bukkit.block.Block

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.bukkit.block.Block

isLiquid

public boolean isLiquid()

Specified by:

isLiquid in interface org.bukkit.block.Block

isFlammable

public boolean isFlammable()

Get block material's flammable ability. (ability to have fire spread to it)

Returns:

if this block is flammable

isBurnable

public boolean isBurnable()

Get block material's burn ability. (ability to have fire consume it)

Returns:

if this block is burnable

getMaterialValues

public MaterialValueManager.ValueCollection getMaterialValues()

getData

public byte getData()

Specified by:

getData in interface org.bukkit.block.Block

setData

public void setData(byte data)

Specified by:

setData in interface org.bukkit.block.Block

setData

public void setData(byte data,
                    boolean applyPhysics)

Specified by:

setData in interface org.bukkit.block.Block

getLightLevel

public byte getLightLevel()

Specified by:

getLightLevel in interface org.bukkit.block.Block

getLightFromSky

public byte getLightFromSky()

Specified by:

getLightFromSky in interface org.bukkit.block.Block

getLightFromBlocks

public byte getLightFromBlocks()

Specified by:

getLightFromBlocks in interface org.bukkit.block.Block

isBlockPowered

public boolean isBlockPowered()

Specified by:

isBlockPowered in interface org.bukkit.block.Block

isBlockIndirectlyPowered

public boolean isBlockIndirectlyPowered()

Specified by:

isBlockIndirectlyPowered in interface org.bukkit.block.Block

isBlockFacePowered

public boolean isBlockFacePowered(org.bukkit.block.BlockFace face)

Specified by:

isBlockFacePowered in interface org.bukkit.block.Block

isBlockFaceIndirectlyPowered

public boolean isBlockFaceIndirectlyPowered(org.bukkit.block.BlockFace face)

Specified by:

isBlockFaceIndirectlyPowered in interface org.bukkit.block.Block

getBlockPower

public int getBlockPower(org.bukkit.block.BlockFace face)

Specified by:

getBlockPower in interface org.bukkit.block.Block

getBlockPower

public int getBlockPower()

Specified by:

getBlockPower in interface org.bukkit.block.Block

getPistonMoveReaction

public org.bukkit.block.PistonMoveReaction getPistonMoveReaction()

Specified by:

getPistonMoveReaction in interface org.bukkit.block.Block

toString

public String toString()

Overrides:

toString in class Object

breakNaturally

public boolean breakNaturally(float yield)

Break the block naturally, randomly dropping only some of the drops.

Parameters:

yield - The approximate portion of the drops to actually drop.

Returns:

true if the block was destroyed

breakNaturally

public boolean breakNaturally(float yield,
                              Collection<org.bukkit.inventory.ItemStack> drops)

Breaks this block and drops items.

Parameters:

yield - the probability to drop each item

drops - the items to potentially drop

Returns:

true if broken; false if this block is already air

breakNaturally

public boolean breakNaturally()

Specified by:

breakNaturally in interface org.bukkit.block.Block

breakNaturally

public boolean breakNaturally(org.bukkit.inventory.ItemStack tool)

Specified by:

breakNaturally in interface org.bukkit.block.Block

getDrops

public Collection<org.bukkit.inventory.ItemStack> getDrops()

Specified by:

getDrops in interface org.bukkit.block.Block

getDrops

public Collection<org.bukkit.inventory.ItemStack> getDrops(org.bukkit.inventory.ItemStack tool)

Specified by:

getDrops in interface org.bukkit.block.Block

setMetadata

public void setMetadata(String metadataKey,
                        org.bukkit.metadata.MetadataValue newMetadataValue)

Specified by:

setMetadata in interface org.bukkit.metadata.Metadatable

getMetadata

public List<org.bukkit.metadata.MetadataValue> getMetadata(String metadataKey)

Specified by:

getMetadata in interface org.bukkit.metadata.Metadatable

hasMetadata

public boolean hasMetadata(String metadataKey)

Specified by:

hasMetadata in interface org.bukkit.metadata.Metadatable

removeMetadata

public void removeMetadata(String metadataKey,
                           org.bukkit.plugin.Plugin owningPlugin)

Specified by:

removeMetadata in interface org.bukkit.metadata.Metadatable

applyPhysics

public void applyPhysics(org.bukkit.Material oldType,
                         int newTypeId,
                         byte oldData,
                         byte newData)

Notify this block and its surrounding blocks that this block has changed type and data.

Parameters:

oldType - the old block type

newTypeId - the new block type

oldData - the old data

newData - the new data

count

public void count(int timeout)

Increments the count of recent state changes. Used to implement redstone-torch burnout.

Parameters:

timeout - the number of game ticks before this state change is no longer considered recent

getCounter

public int getCounter()

Returns the number of recent state changes, as defined by count(int). Used to implement redstone-torch burnout.

Returns:

the number of recent state changes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getX

public int getX()

Specified by:

getX in interface org.bukkit.block.Block

getY

public int getY()

Specified by:

getY in interface org.bukkit.block.Block

getZ

public int getZ()

Specified by:

getZ in interface org.bukkit.block.Block

getWorld

public GlowWorld getWorld()

Specified by:

getWorld in interface org.bukkit.block.Block