org.spongepowered.api.block

Interface BlockState

All Superinterfaces:

CatalogType, DataSerializable, DirectionRelativePropertyHolder, ImmutableDataHolder<BlockState>, ImmutableValueStore<BlockState,ImmutableDataManipulator<?,?>>, PropertyHolder, ValueContainer<BlockState>

public interface BlockState
extends ImmutableDataHolder<BlockState>, DirectionRelativePropertyHolder, CatalogType

Represents a particular "state" that can exist at a Location with a particular BlockType and various ImmutableValues defining the information for the "block". Note that normally, there may exist only a single instance of a particular BlockState as they are immutable, a particular instance may be cached for various uses.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BlockState.Builder An ImmutableDataBuilder for a BlockState.
static class	BlockState.MatcherBuilder A builder for building BlockState.StateMatchers.
static class	BlockState.StateMatcher A BlockState matcher that will match various block states according to a pre-built list of BlockTraits and their values, such that not all BlockTraits contained in a BlockState must be matched.

Method Summary

Modifier and Type	Method and Description
static BlockState.Builder	builder() Creates a new BlockState.Builder for building BlockStates.
BlockState	cycleValue(Key<? extends BaseValue<? extends Cycleable<?>>> key) Gets the associated BlockState with the cycled BaseValue.
Optional<BlockTrait<?>>	getTrait(String blockTrait) Attempts to retrieve the BlockTrait instance associated with this BlockStates BlockType by string id.
Map<BlockTrait<?>,?>	getTraitMap() Gets an immutable or unmodifiable Map of the known BlockTraits to their current values for this BlockState.
Collection<BlockTrait<?>>	getTraits() Gets an immutable Collection of all applicable BlockTraits for this BlockState.
<T extends Comparable<T>> Optional<T>	getTraitValue(BlockTrait<T> blockTrait) Gets the Comparable value for the specific BlockTrait such that if the BlockState does not support the BlockTrait, Optional.empty() is returned.
Collection<?>	getTraitValues() Gets an immutable Collection of all the values for all BlockTraits for this BlockState.
BlockType	getType() Gets the base type of block.
static BlockState.MatcherBuilder	matcher(BlockType type) Constructs a new BlockState.MatcherBuilder to construct a BlockState.StateMatcher.
BlockSnapshot	snapshotFor(Location<World> location) Creates a new BlockSnapshot with this current BlockState at the desired Location.
BlockState	withExtendedProperties(Location<World> location) Applies extended properties for the current @{link BlockType} if any to the current BlockState.
Optional<BlockState>	withTrait(BlockTrait<?> trait, Object value) Gets the BlockState with the appropriate value for the given BlockTrait.

Methods inherited from interface org.spongepowered.api.data.ImmutableDataHolder

getManipulators

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.immutable.ImmutableValueStore

get, getContainers, getOrCreate, merge, merge, supports, transform, with, with, with, with, without

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Methods inherited from interface org.spongepowered.api.data.property.DirectionRelativePropertyHolder

getProperty

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

builder

static BlockState.Builder builder()

Creates a new BlockState.Builder for building BlockStates.

Returns:

The builder

matcher

static BlockState.MatcherBuilder matcher(BlockType type)

Constructs a new BlockState.MatcherBuilder to construct a BlockState.StateMatcher.

Parameters:

type - The block type

Returns:

The builder

getType

BlockType getType()

Gets the base type of block.

The type does not include block data such as the contents of inventories.

Returns:

The type of block

withExtendedProperties

BlockState withExtendedProperties(Location<World> location)

Applies extended properties for the current @{link BlockType} if any to the current BlockState. This usually is gathered from surrounding BlockState's.

Note: This should only be called for live BlockState's at a specific Location for accurate results.

Examples of some extended properties are:

• snow on podzul dirt block
• occupied status for beds
• fence connections

Parameters:

location - The location used to search for extended properties

Returns:

The blockstate with extended properties included if any

cycleValue

BlockState cycleValue(Key<? extends BaseValue<? extends Cycleable<?>>> key)

Gets the associated BlockState with the cycled BaseValue. Note that only Cycleable values can be cycled. To change a particular Key'ed Value, usage of the ImmutableValueStore.with(Key, Object) is recommended.

Parameters:

key - The key to cycle

Returns:

The blockstate instance with the cycled value

snapshotFor

BlockSnapshot snapshotFor(Location<World> location)

Creates a new BlockSnapshot with this current BlockState at the desired Location. If the Location has the same BlockState, and the BlockType can house a TileEntity, the data from the tile entity may be included in the returned BlockSnapshot.

Parameters:

location - The location for the snapshot

Returns:

The newly created snapshot

getTraitValue

<T extends Comparable<T>> Optional<T> getTraitValue(BlockTrait<T> blockTrait)

Gets the Comparable value for the specific BlockTrait such that if the BlockState does not support the BlockTrait, Optional.empty() is returned.

Type Parameters:

T - The generic type of block trait

Parameters:

blockTrait - The block trait instance

Returns:

The comparable value, if available and compatible

getTrait

Optional<BlockTrait<?>> getTrait(String blockTrait)

Attempts to retrieve the BlockTrait instance associated with this BlockStates BlockType by string id. If there is no BlockTrait available, Optional.empty() is returned.

Parameters:

blockTrait - The block trait id

Returns:

The block trait, if available

withTrait

Optional<BlockState> withTrait(BlockTrait<?> trait,
                               Object value)

Gets the BlockState with the appropriate value for the given BlockTrait. If the BlockTrait is not supported, Optional.empty() is returned. If the object is not either an instance contained in BlockTrait.getPossibleValues() or an instance Object.toString(), Optional.empty() may be returned.

Parameters:

trait - The trait

value - The value

Returns:

The blockstate, if supported

getTraits

Collection<BlockTrait<?>> getTraits()

Gets an immutable Collection of all applicable BlockTraits for this BlockState.

Returns:

An immutable collection of all applicable block traits

getTraitValues

Collection<?> getTraitValues()

Gets an immutable Collection of all the values for all BlockTraits for this BlockState.

Returns:

An immutable collection of all the values for all applicable traits

getTraitMap

Map<BlockTrait<?>,?> getTraitMap()

Gets an immutable or unmodifiable Map of the known BlockTraits to their current values for this BlockState.

Returns:

The immutable map of block traits to their values representing this block state