org.bukkit.block.BlockState Interface Reference

Represents a captured state of a block, which will not change automatically. More...

Inheritance diagram for org.bukkit.block.BlockState:

Collaboration diagram for org.bukkit.block.BlockState:

Public Member Functions
Block	getBlock ()
	Gets the block represented by this BlockState.
MaterialData	getData ()
	Gets the metadata for this block.
Material	getType ()
	Gets the type of this block.
int	getTypeId ()
	Gets the type-id of this block.
byte	getLightLevel ()
	Gets the light level between 0-15.
World	getWorld ()
	Gets the world which contains this Block.
int	getX ()
	Gets the x-coordinate of this block.
int	getY ()
	Gets the y-coordinate of this block.
int	getZ ()
	Gets the z-coordinate of this block.
Location	getLocation ()
	Gets the location of this block.
Location	getLocation (Location loc)
	Stores the location of this block in the provided Location object.
Chunk	getChunk ()
	Gets the chunk which contains this block.
void	setData (MaterialData data)
	Sets the metadata for this block.
void	setType (Material type)
	Sets the type of this block.
boolean	setTypeId (int type)
	Sets the type-id of this block.
boolean	update ()
	Attempts to update the block represented by this state, setting it to the new values as defined by this state.
boolean	update (boolean force)
	Attempts to update the block represented by this state, setting it to the new values as defined by this state.
byte	getRawData ()
void	setRawData (byte data)
Public Member Functions inherited from org.bukkit.metadata.Metadatable
void	setMetadata (String metadataKey, MetadataValue newMetadataValue)
	Sets a metadata value in the implementing object's metadata store.
List< MetadataValue >	getMetadata (String metadataKey)
	Returns a list of previously set metadata values from the implementing object's metadata store.
boolean	hasMetadata (String metadataKey)
	Tests to see whether the implementing object contains the given metadata value in its metadata store.
void	removeMetadata (String metadataKey, Plugin owningPlugin)
	Removes the given metadata value from the implementing object's metadata store.

Detailed Description

Represents a captured state of a block, which will not change automatically.

Unlike Block, which only one object can exist per coordinate, BlockState can exist multiple times for any given Block. Note that another plugin may change the state of the block and you will not know, or they may change the block to another type entirely, causing your BlockState to become invalid.

Definition at line 18 of file BlockState.java.

Member Function Documentation

Block org.bukkit.block.BlockState.getBlock

(

)

Gets the block represented by this BlockState.

Returns

Block that this BlockState represents

Chunk org.bukkit.block.BlockState.getChunk

(

)

Gets the chunk which contains this block.

Returns

Containing Chunk

MaterialData org.bukkit.block.BlockState.getData

(

)

Gets the metadata for this block.

Returns

block specific metadata

byte org.bukkit.block.BlockState.getLightLevel

(

)

Gets the light level between 0-15.

Returns

light level

Location org.bukkit.block.BlockState.getLocation

(

)

Gets the location of this block.

Returns

location

Location org.bukkit.block.BlockState.getLocation

(

Location

loc

)

Stores the location of this block in the provided Location object.

If the provided Location is null this method does nothing and returns null.

Returns

The Location object provided or null

byte org.bukkit.block.BlockState.getRawData

(

)

Returns

The data as a raw byte.

Material org.bukkit.block.BlockState.getType

(

)

Gets the type of this block.

Returns

block type

int org.bukkit.block.BlockState.getTypeId

(

)

Gets the type-id of this block.

Returns

block type-id

World org.bukkit.block.BlockState.getWorld

(

)

Gets the world which contains this Block.

Returns

World containing this block

int org.bukkit.block.BlockState.getX

(

)

Gets the x-coordinate of this block.

Returns

x-coordinate

int org.bukkit.block.BlockState.getY

(

)

Gets the y-coordinate of this block.

Returns

y-coordinate

int org.bukkit.block.BlockState.getZ

(

)

Gets the z-coordinate of this block.

Returns

z-coordinate

void org.bukkit.block.BlockState.setData

(

MaterialData

data

)

Sets the metadata for this block.

Parameters

data	New block specific metadata

void org.bukkit.block.BlockState.setRawData

(

byte

data

)

Parameters

data	The new data value for the block.

void org.bukkit.block.BlockState.setType

(

Material

type

)

Sets the type of this block.

Parameters

type	Material to change this block to

boolean org.bukkit.block.BlockState.setTypeId

(

int

type

)

Sets the type-id of this block.

Parameters

type	Type-Id to change this block to

Returns

Whether it worked?

boolean org.bukkit.block.BlockState.update

(

)

Attempts to update the block represented by this state, setting it to the new values as defined by this state.

This has the same effect as calling update(false). That is to say, this will not modify the state of a block if it is no longer the same type as it was when this state was taken. It will return false in this eventuality.

Returns

true if the update was successful, otherwise false

See Also

update(boolean)

boolean org.bukkit.block.BlockState.update

(

boolean

force

)

Attempts to update the block represented by this state, setting it to the new values as defined by this state.

Unless force is true, this will not modify the state of a block if it is no longer the same type as it was when this state was taken. It will return false in this eventuality.

If force is true, it will set the type of the block to match the new state, set the state data and then return true.

Parameters

force

true to forcefully set the state

Returns

true if the update was successful, otherwise false

---

The documentation for this interface was generated from the following file:

• org/bukkit/block/BlockState.java