Package com.sk89q.worldedit.world.block

Class BlockState

java.lang.Object

com.sk89q.worldedit.world.block.BlockState

All Implemented Interfaces:

Pattern, BlockStateHolder<BlockState>

Direct Known Subclasses:

FuzzyBlockState

public class BlockState
extends Object
implements BlockStateHolder<BlockState>

An immutable class that represents the state a block can be in.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	equalsFuzzy(BlockStateHolder<?> o)	Checks if the type is the same, and if the matched states are the same.
String	getAsString()	Gets a String representation of this BlockStateHolder, in the format expected by WorldEdit's block parsers.
BlockType	getBlockType()	Get the block type.
<V> V	getState(Property<V> property)	Gets the value for the given state.
Map<Property<?>,Object>	getStates()	Gets an immutable collection of the states.
int	hashCode()
BaseBlock	toBaseBlock()	Gets a BaseBlock from this BlockStateHolder.
BaseBlock	toBaseBlock(LazyReference<org.enginehub.linbus.tree.LinCompoundTag> compoundTag)	Gets a BaseBlock from this BlockStateHolder.
BlockState	toImmutableState()	Returns an immutable BlockState from this BlockStateHolder.
String	toString()
<V> BlockState	with(Property<V> property, V value)	Returns a BlockState with the given state and value applied.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sk89q.worldedit.world.block.BlockStateHolder

applyBlock, toBaseBlock, toBaseBlock

Methods inherited from interface com.sk89q.worldedit.function.pattern.Pattern

apply

Method Details

getBlockType

public BlockType getBlockType()

Description copied from interface: BlockStateHolder

Get the block type.

Specified by:

getBlockType in interface BlockStateHolder<BlockState>

Returns:

The type

with

public <V> BlockState with(Property<V> property,
 V value)

Description copied from interface: BlockStateHolder

Returns a BlockState with the given state and value applied.

Specified by:

with in interface BlockStateHolder<BlockState>

Parameters:

property - The state

value - The value

Returns:

The modified state, or same if could not be applied

getState

public <V> V getState(Property<V> property)

Description copied from interface: BlockStateHolder

Gets the value for the given state.

Specified by:

getState in interface BlockStateHolder<BlockState>

Parameters:

property - The state

Returns:

The value

getStates

public Map<Property<?>,Object> getStates()

Description copied from interface: BlockStateHolder

Gets an immutable collection of the states.

Specified by:

getStates in interface BlockStateHolder<BlockState>

Returns:

The states

equalsFuzzy

public boolean equalsFuzzy(BlockStateHolder<?> o)

Description copied from interface: BlockStateHolder

Checks if the type is the same, and if the matched states are the same.

Specified by:

equalsFuzzy in interface BlockStateHolder<BlockState>

Parameters:

o - other block

Returns:

true if equal

toImmutableState

public BlockState toImmutableState()

Description copied from interface: BlockStateHolder

Returns an immutable BlockState from this BlockStateHolder.

Specified by:

toImmutableState in interface BlockStateHolder<BlockState>

Returns:

A BlockState

toBaseBlock

public BaseBlock toBaseBlock()

Description copied from interface: BlockStateHolder

Gets a BaseBlock from this BlockStateHolder.

Specified by:

toBaseBlock in interface BlockStateHolder<BlockState>

Returns:

The BaseBlock

toBaseBlock

public BaseBlock toBaseBlock(LazyReference<org.enginehub.linbus.tree.LinCompoundTag> compoundTag)

Description copied from interface: BlockStateHolder

Gets a BaseBlock from this BlockStateHolder.

Specified by:

toBaseBlock in interface BlockStateHolder<BlockState>

Parameters:

compoundTag - The NBT Data to apply

Returns:

The BaseBlock

getAsString

public String getAsString()

Description copied from interface: BlockStateHolder

Gets a String representation of this BlockStateHolder, in the format expected by WorldEdit's block parsers.

Specified by:

getAsString in interface BlockStateHolder<BlockState>

Returns:

a string representation

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object