Package com.sk89q.worldedit.world.block

Class BaseBlock

java.lang.Object

com.sk89q.worldedit.world.block.BaseBlock

All Implemented Interfaces:

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

Direct Known Subclasses:

BlanketBaseBlock, MobSpawnerBlock, SignBlock, SkullBlock

public class BaseBlock
extends Object
implements BlockStateHolder<BaseBlock>, TileEntityBlock

Represents a "snapshot" of a block with NBT Data.

An instance of this block contains all the information needed to accurately reproduce the block, provided that the instance was made correctly. In some implementations, it may not be possible to get a snapshot of blocks correctly, so, for example, the NBT data for a block may be missing.

Constructor Summary

Constructors

Modifier	Constructor	Description
	BaseBlock(int id, int data)	Deprecated.
	BaseBlock(BlockState blockState)	Construct a block with a state.
	BaseBlock(BlockState state, CompoundTag nbtData)	Deprecated.
protected	BaseBlock(BlockState state, LazyReference<com.sk89q.worldedit.util.nbt.CompoundBinaryTag> nbtData)	Construct a block with the given ID, data value and NBT data structure.
	BaseBlock(BlockType blockType)	Deprecated. FAWE deprecation - Just use the BlockType.getDefaultState()

Method Summary

Modifier and Type	Method	Description
boolean	apply(Extent extent, BlockVector3 get, BlockVector3 set)
void	applyTileEntity(OutputExtent output, int x, int y, int z)
boolean	equals(Object o)	Checks whether the type ID and data value are equal.
boolean	equalsFuzzy(BlockStateHolder<?> o)	Checks if the type is the same, and if the matched states are the same.
BlockType	getBlockType()	Get the block type.
int	getInternalBlockTypeId()	Get type id (legacy uses).
int	getInternalId()	Get combined id (legacy uses).
int	getInternalPropertiesId()	Get the block data (legacy uses).
BlockMaterial	getMaterial()
String	getNbtId()	Return the name of the title entity ID.
LazyReference<com.sk89q.worldedit.util.nbt.CompoundBinaryTag>	getNbtReference()	Get the object's NBT data (tile entity data).
int	getOrdinal()
final char	getOrdinalChar()
static BlockState	getState(int id, int data)
<V> V	getState(PropertyKey property)	Gets the value for the given state.
<V> V	getState(Property<V> property)	Gets the State for this Block.
Map<Property<?>,Object>	getStates()	Gets a map of state to state values.
int	hashCode()
void	setNbtReference(LazyReference<com.sk89q.worldedit.util.nbt.CompoundBinaryTag> nbtData)	Set the object's NBT data (tile entity data).
BaseBlock	toBaseBlock()	Gets a BaseBlock from this BlockStateHolder.
BaseBlock	toBaseBlock(LazyReference<com.sk89q.worldedit.util.nbt.CompoundBinaryTag> compoundTag)	Gets a BaseBlock from this BlockStateHolder.
BlockState	toBlockState()
BlockState	toImmutableState()	Returns an immutable BlockState from this BlockStateHolder.
String	toString()
<V> BaseBlock	with(PropertyKey property, V value)	Returns a BlockStateHolder with the given state and value applied.
<V> BaseBlock	with(Property<V> property, V value)	Returns a BlockState with the given state and value applied.
BaseBlock	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

applyBlock, getAsString, toBaseBlock, 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, getNbtData, hasNbtData, setNbt, setNbtData

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

apply, applyBlock

Constructor Details

BaseBlock

@Deprecated
public BaseBlock(BlockType blockType)

Deprecated.

FAWE deprecation - Just use the BlockType.getDefaultState()

Construct a block with the given type and default data.

Parameters:

blockType - The block type

BaseBlock

public BaseBlock(BlockState blockState)

Construct a block with a state.

Parameters:

blockState - The blockstate

BaseBlock

@Deprecated
public BaseBlock(BlockState state,
 CompoundTag nbtData)

Deprecated.

Construct a block with the given ID, data value and NBT data structure.

Parameters:

state - The block state

nbtData - NBT data, which must be provided

BaseBlock

protected BaseBlock(BlockState state,
 LazyReference<com.sk89q.worldedit.util.nbt.CompoundBinaryTag> nbtData)

Construct a block with the given ID, data value and NBT data structure.

Parameters:

state - The block state

nbtData - NBT data, which must be provided

BaseBlock

@Deprecated
public BaseBlock(int id,
 int data)

Deprecated.

Construct a block with the given ID and data value.

Parameters:

id - ID value

data - data value

Method Details

getState

public static BlockState getState(int id,
 int data)

getStates

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

Gets a map of state to state values.

Specified by:

getStates in interface BlockStateHolder<BaseBlock>

Returns:

The state map

getBlockType

public BlockType getBlockType()

Description copied from interface: BlockStateHolder

Get the block type.

Specified by:

getBlockType in interface BlockStateHolder<BaseBlock>

Returns:

The type

with

public <V> BaseBlock 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<BaseBlock>

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)

Gets the State for this Block.

Specified by:

getState in interface BlockStateHolder<BaseBlock>

Parameters:

property - The state to get the value for

Returns:

The state value

getNbtId

public String getNbtId()

Description copied from interface: TileEntityBlock

Return the name of the title entity ID.

Specified by:

getNbtId in interface TileEntityBlock

Returns:

tile entity ID, non-null string

getNbtReference

@Nullable
public LazyReference<com.sk89q.worldedit.util.nbt.CompoundBinaryTag> getNbtReference()

Description copied from interface: NbtValued

Get the object's NBT data (tile entity data).

This only needs to be used if you don't want to immediately resolve the data. Otherwise, you probably want NbtValued.getNbt().

Specified by:

getNbtReference in interface NbtValued

Returns:

compound tag, or null

setNbtReference

public void setNbtReference(@Nullable
 LazyReference<com.sk89q.worldedit.util.nbt.CompoundBinaryTag> nbtData)

Description copied from interface: NbtValued

Set the object's NBT data (tile entity data).

Specified by:

setNbtReference in interface NbtValued

Parameters:

nbtData - NBT data, or null if no data

equals

public boolean equals(Object o)

Checks whether the type ID and data value are equal.

Overrides:

equals in class Object

getInternalId

public int getInternalId()

Description copied from interface: BlockStateHolder

Get combined id (legacy uses).

Specified by:

getInternalId in interface BlockStateHolder<BaseBlock>

getMaterial

public BlockMaterial getMaterial()

Specified by:

getMaterial in interface BlockStateHolder<BaseBlock>

getOrdinal

public int getOrdinal()

Specified by:

getOrdinal in interface BlockStateHolder<BaseBlock>

getOrdinalChar

public final char getOrdinalChar()

Specified by:

getOrdinalChar in interface BlockStateHolder<BaseBlock>

equalsFuzzy

public boolean equalsFuzzy(BlockStateHolder<?> o)

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

Specified by:

equalsFuzzy in interface BlockStateHolder<BaseBlock>

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<BaseBlock>

Returns:

A BlockState

toBaseBlock

public BaseBlock toBaseBlock()

Description copied from interface: BlockStateHolder

Gets a BaseBlock from this BlockStateHolder.

Specified by:

toBaseBlock in interface BlockStateHolder<BaseBlock>

Returns:

The BaseBlock

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<BaseBlock>

Parameters:

compoundTag - The NBT Data to apply

Returns:

The BaseBlock This must be overridden by new subclasses. See NonAbstractForCompatibility for details

apply

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

Specified by:

apply in interface Pattern

Throws:

WorldEditException

applyTileEntity

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

Specified by:

applyTileEntity in interface BlockStateHolder<BaseBlock>

withPropertyId

public BaseBlock withPropertyId(int propertyId)

Description copied from interface: BlockStateHolder

Magic number (legacy uses).

Specified by:

withPropertyId in interface BlockStateHolder<BaseBlock>

getInternalBlockTypeId

public int getInternalBlockTypeId()

Description copied from interface: BlockStateHolder

Get type id (legacy uses).

Specified by:

getInternalBlockTypeId in interface BlockStateHolder<BaseBlock>

getInternalPropertiesId

public int getInternalPropertiesId()

Description copied from interface: BlockStateHolder

Get the block data (legacy uses).

Specified by:

getInternalPropertiesId in interface BlockStateHolder<BaseBlock>

with

public <V> BaseBlock 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<BaseBlock>

Parameters:

property - The property key

value - The value

Returns:

The modified state, or same if could not be applied

getState

public <V> V getState(PropertyKey property)

Description copied from interface: BlockStateHolder

Gets the value for the given state.

Specified by:

getState in interface BlockStateHolder<BaseBlock>

Parameters:

property - The state

Returns:

The value

toBlockState

public BlockState toBlockState()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object