Package com.sk89q.worldedit.world.block

Class BlockState

java.lang.Object

com.sk89q.worldedit.world.block.BlockState

All Implemented Interfaces:

Filter, TileEntityBlock, Pattern, BlockStateHolder<BlockState>, NbtValued

Direct Known Subclasses:

FuzzyBlockState

public class BlockState
extends Object
implements BlockStateHolder<BlockState>, Pattern

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

Constructor Summary

Constructors

Constructor	Description
BlockState(BlockType blockType, int internalId, int ordinal)
BlockState(BlockType blockType, int internalId, int ordinal, CompoundTag tile)

Method Summary

Modifier and Type	Method	Description
boolean	apply(Extent extent, BlockVector3 get, BlockVector3 set)
BaseBlock	applyBlock(BlockVector3 position)	Return a BaseBlock for the given position.
void	applyTileEntity(OutputExtent output, int x, int y, int z)
boolean	equals(Object obj)
boolean	equalsFuzzy(BlockStateHolder<?> o)	Checks if the type is the same, and if the matched states are the same.
static BlockState	get(BlockType type, String state)	Returns a temporary BlockState for a given type and string.
static BlockState	get(BlockType type, String state, BlockState defaultState)	Returns a temporary BlockState for a given type and string.
static BlockState	get(String state)	Returns a temporary BlockState for a given type and string.
BlockType	getBlockType()	Get the block type.
static BlockState	getFromInternalId(int combinedId)	Deprecated. Magic Numbers
static BlockState	getFromOrdinal(int ordinal)	Deprecated.
final int	getInternalBlockTypeId()	Deprecated.
int	getInternalId()	Get combined id (legacy uses).
final int	getInternalPropertiesId()	Deprecated.
BlockMaterial	getMaterial()
CompoundTag	getNbtData()	Deprecated.
final int	getOrdinal()
final char	getOrdinalChar()
<V> V	getState(PropertyKey key)	Deprecated.
<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()
boolean	isAir()
BaseBlock	toBaseBlock()	Gets a BaseBlock from this BlockStateHolder.
BaseBlock	toBaseBlock(ITileInput input, int x, int y, int z)
BaseBlock	toBaseBlock(LazyReference<com.sk89q.worldedit.util.nbt.CompoundBinaryTag> compoundTag)	Gets a BaseBlock from this BlockStateHolder.
BlockState	toImmutableState()	Returns an immutable BlockState from this BlockStateHolder.
Mask	toMask()
String	toString()
<V> BlockState	with(PropertyKey property, V value)	Returns a BlockStateHolder with the given state and value applied.
<V> BlockState	with(Property<V> property, V value)	Returns a BlockState with the given state and value applied.
<V> BlockState	withProperties(BlockState other)
BlockState	withPropertyId(int propertyId)	Magic number (legacy uses).

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

getAsString, toBaseBlock, toBaseBlock

Methods inherited from interface com.fastasyncworldedit.core.queue.Filter

appliesChunk, appliesLayer, applyChunk, finishChunk, fork, join

Methods inherited from interface com.sk89q.worldedit.world.NbtValued

getNbt, getNbtReference, hasNbtData, setNbt, setNbtData, setNbtReference

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

apply, applyBlock

Methods inherited from interface com.sk89q.worldedit.blocks.TileEntityBlock

getNbtId

Constructor Details

BlockState

public BlockState(BlockType blockType,
 int internalId,
 int ordinal)

BlockState

public BlockState(BlockType blockType,
 int internalId,
 int ordinal,
 @Nonnull
 CompoundTag tile)

Method Details

getFromInternalId

@Deprecated
public static BlockState getFromInternalId(int combinedId)
                                    throws InputParseException

Deprecated.

Magic Numbers

Returns a temporary BlockState for a given internal id.

Returns:

BlockState

Throws:

InputParseException

getFromOrdinal

@Deprecated
public static BlockState getFromOrdinal(int ordinal)

Deprecated.

get

public static BlockState get(String state)
                      throws InputParseException

Returns a temporary BlockState for a given type and string.

Parameters:

state - String e.g., minecraft:water[level=4]

Returns:

BlockState

Throws:

InputParseException

get

public static BlockState get(@Nullable
 BlockType type,
 String state)
                      throws InputParseException

Returns a temporary BlockState for a given type and string.

It's faster if a BlockType is provided compared to parsing the string.

Parameters:

type - BlockType e.g., BlockTypes.STONE (or null)

state - String e.g., minecraft:water[level=4]

Returns:

BlockState

Throws:

InputParseException

get

public static BlockState get(@Nullable
 BlockType type,
 String state,
 BlockState defaultState)
                      throws InputParseException

Returns a temporary BlockState for a given type and string.

It's faster if a BlockType is provided compared to parsing the string.

Parameters:

type - BlockType e.g., BlockTypes.STONE (or null)

state - String e.g., minecraft:water[level=4]

Returns:

BlockState

Throws:

InputParseException

withPropertyId

public BlockState withPropertyId(int propertyId)

Description copied from interface: BlockStateHolder

Magic number (legacy uses).

Specified by:

withPropertyId in interface BlockStateHolder<BlockState>

apply

public boolean apply(Extent extent,
 BlockVector3 get,
 BlockVector3 set)
              throws WorldEditException

Specified by:

apply in interface Pattern

Throws:

WorldEditException

applyBlock

public BaseBlock applyBlock(BlockVector3 position)

Description copied from interface: Pattern

Return a BaseBlock for the given position.

Specified by:

applyBlock in interface BlockStateHolder<BlockState>

Specified by:

applyBlock in interface Pattern

Parameters:

position - the position

Returns:

a block

toMask

public Mask toMask()

applyTileEntity

public void applyTileEntity(OutputExtent output,
 int x,
 int y,
 int z)

Specified by:

applyTileEntity in interface BlockStateHolder<BlockState>

getInternalPropertiesId

@Deprecated
public final int getInternalPropertiesId()

Deprecated.

The internal id with no type information.

Specified by:

getInternalPropertiesId in interface BlockStateHolder<BlockState>

getInternalBlockTypeId

@Deprecated
public final int getInternalBlockTypeId()

Deprecated.

Description copied from interface: BlockStateHolder

Get type id (legacy uses).

Specified by:

getInternalBlockTypeId in interface BlockStateHolder<BlockState>

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

with

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

Description copied from interface: BlockStateHolder

Returns a BlockStateHolder with the given state and value applied.

Specified by:

with in interface BlockStateHolder<BlockState>

Parameters:

property - The property key

value - The value

Returns:

The modified state, or same if could not be applied

withProperties

public <V> BlockState withProperties(BlockState other)

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

getBlockType

public BlockType getBlockType()

Description copied from interface: BlockStateHolder

Get the block type.

Specified by:

getBlockType in interface BlockStateHolder<BlockState>

Returns:

The type

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

getState

@Deprecated
public <V> V getState(PropertyKey key)

Deprecated.

Description copied from interface: BlockStateHolder

Gets the value for the given state.

Specified by:

getState in interface BlockStateHolder<BlockState>

Parameters:

key - The state

Returns:

The value

getNbtData

@Deprecated
public CompoundTag getNbtData()

Deprecated.

Description copied from interface: NbtValued

Get the object's NBT data (tile entity data). The returned tag, if modified in any way, should be sent to NbtValued.setNbtData(CompoundTag) so that the instance knows of the changes. Making changes without calling NbtValued.setNbtData(CompoundTag) could have unintended consequences.

NbtValued.hasNbtData() must return true if and only if method does not return null.

Specified by:

getNbtData in interface NbtValued

Returns:

compound tag, or null

toBaseBlock

public BaseBlock toBaseBlock(LazyReference<com.sk89q.worldedit.util.nbt.CompoundBinaryTag> 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 This must be overridden by new subclasses. See NonAbstractForCompatibility for details

getInternalId

public int getInternalId()

Description copied from interface: BlockStateHolder

Get combined id (legacy uses).

Specified by:

getInternalId in interface BlockStateHolder<BlockState>

getMaterial

public BlockMaterial getMaterial()

Specified by:

getMaterial in interface BlockStateHolder<BlockState>

getOrdinal

public final int getOrdinal()

Specified by:

getOrdinal in interface BlockStateHolder<BlockState>

getOrdinalChar

public final char getOrdinalChar()

Specified by:

getOrdinalChar in interface BlockStateHolder<BlockState>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isAir

public boolean isAir()

toBaseBlock

public BaseBlock toBaseBlock(ITileInput input,
 int x,
 int y,
 int z)

Specified by:

toBaseBlock in interface BlockStateHolder<BlockState>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object