Package cn.nukkit.blockstate

Class BlockState

java.lang.Object

cn.nukkit.blockstate.BlockState

All Implemented Interfaces:

IBlockState, Serializable

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@ParametersAreNonnullByDefault
public final class BlockState
extends Object
implements Serializable, IBlockState

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final BlockState	AIR

Method Summary

Modifier and Type	Method	Description
ItemBlock	asItemBlock(int count)
boolean	equals(Object o)
BlockState	forItem()
int	getBigDamage()	Deprecated.
int	getBitSize()
Block	getBlock()
Block	getBlock(Level level, int x, int y, int z, int layer, boolean repair, Consumer<BlockStateRepair> callback)
int	getBlockId()
boolean	getBooleanValue(String propertyName)
OptionalBoolean	getCachedValidation()
BlockState	getCurrentState()
Number	getDataStorage()
int	getExactIntStorage()
BigInteger	getHugeDamage()
int	getIntValue(String propertyName)
int	getLegacyDamage()	Deprecated.
String	getPersistenceValue(String propertyName)
BlockProperties	getProperties()
Serializable	getPropertyValue(String propertyName)
int	getSignedBigDamage()	Deprecated.
int	hashCode()
boolean	isCachedValidationValid()
boolean	isDefaultState()
static BlockState	of(int blockId)
static BlockState	of(int blockId, byte blockData)
static BlockState	of(int blockId, int blockData)
static BlockState	of(int blockId, long blockData)
static BlockState	of(int blockId, Number blockData)
static BlockState	of(int blockId, BigInteger blockData)
static BlockState	of(String persistedStateId)	Returns the BlockState object that represents the given persistedStateId.
static BlockState	of(String persistedStateId, boolean useDefaultPropertyValues)	Returns the BlockState object that represents the given persistedStateId.
BlockState	onlyWithProperties(BlockProperty<?>... properties)
BlockState	onlyWithProperties(String... propertyNames)
BlockState	onlyWithProperty(BlockProperty<?> property)
<T extends Serializable> BlockState	onlyWithProperty(BlockProperty<T> property, T value)
BlockState	onlyWithProperty(String name)
BlockState	onlyWithProperty(String name, Serializable value)
String	toString()
void	validate()
BlockState	withBlockId(int blockId)
BlockState	withData(int data)
BlockState	withData(long data)
BlockState	withData(Number data)
BlockState	withData(BigInteger data)
<E extends Serializable> BlockState	withProperty(BlockProperty<E> property, E value)
BlockState	withProperty(String propertyName, Serializable value)
BlockState	withProperty(String propertyName, String persistenceValue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface cn.nukkit.blockstate.IBlockState

asItemBlock, getBigId, getBlock, getBlock, getBlock, getBlock, getBlock, getBlock, getBlockRepairing, getBlockRepairing, getBlockRepairing, getBlockRepairing, getBlockRepairing, getBlockRepairing, getBlockRepairing, getBlockRepairing, getBooleanValue, getCheckedProperty, getCheckedPropertyValue, getFullId, getIntValue, getLegacyStateId, getMinimalistStateId, getPersistenceName, getPersistenceValue, getProperty, getPropertyNames, getPropertyValue, getRuntimeId, getStateId, getUncheckedPropertyValue, getUncheckedPropertyValue

Field Details

AIR

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final BlockState AIR

Method Details

of

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public static BlockState of(@Nonnegative
 int blockId)

of

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public static BlockState of(@Nonnegative
 int blockId,
 @Nonnegative
 byte blockData)

of

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public static BlockState of(@Nonnegative
 int blockId,
 @Nonnegative
 int blockData)

of

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public static BlockState of(@Nonnegative
 int blockId,
 @Nonnegative
 long blockData)

of

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public static BlockState of(@Nonnegative
 int blockId,
 @Nonnegative
 BigInteger blockData)

of

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public static BlockState of(@Nonnegative
 int blockId,
 @Nonnegative
 Number blockData)

Throws:

InvalidBlockStateDataTypeException - If the blockData param is not Integer, Long, or BigInteger.

of

@PowerNukkitOnly
@Since("1.5.2.0-PN")
@Nonnull
public static BlockState of(@Nonnull
 String persistedStateId)

Returns the BlockState object that represents the given persistedStateId.

Same as of(persistedStateid, true.

Parameters:

persistedStateId - Must follow the same syntax returned by IBlockState.getStateId() or IBlockState.getLegacyStateId()

Returns:

The block state, never null

Throws:

InvalidBlockPropertyValueException - If any property value in the given persistedStateId is not valid for the state.

of

@PowerNukkitOnly
@Since("1.5.2.0-PN")
@Nonnull
public static BlockState of(@Nonnull
 String persistedStateId,
 boolean useDefaultPropertyValues)

Returns the BlockState object that represents the given persistedStateId.

Parameters:

persistedStateId - Must follow the same syntax returned by IBlockState.getStateId() or IBlockState.getLegacyStateId()

useDefaultPropertyValues - When true, the default value will be used for any missing BlockProperty in persistedStateId.

Returns:

The block state, never null

Throws:

IllegalArgumentException - If useDefaultPropertyValues is false and there are missing properties

InvalidBlockPropertyValueException - If any property value in the given persistedStateId is not valid for the state.

NoSuchElementException - If there are no block registered with the given id.

getBlockId

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnegative
public int getBlockId()

Specified by:

getBlockId in interface IBlockState

withData

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public BlockState withData(@Nonnegative
 int data)

withData

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public BlockState withData(@Nonnegative
 long data)

withData

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public BlockState withData(@Nonnegative
 BigInteger data)

withData

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public BlockState withData(@Nonnegative
 Number data)

withBlockId

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public BlockState withBlockId(@Nonnegative
 int blockId)

withProperty

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public <E extends Serializable> BlockState withProperty(BlockProperty<E> property,
 @Nullable
 E value)

withProperty

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public BlockState withProperty(String propertyName,
 @Nullable
 Serializable value)

Throws:

NoSuchElementException - If the property is not registered

InvalidBlockPropertyValueException - If the new value is not accepted by the property

withProperty

@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public BlockState withProperty(String propertyName,
 String persistenceValue)

onlyWithProperties

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public BlockState onlyWithProperties(BlockProperty<?>... properties)

Throws:

NoSuchElementException - If any of the property is not registered

onlyWithProperties

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public BlockState onlyWithProperties(String... propertyNames)

Throws:

NoSuchElementException - If any of the given property names is not found

onlyWithProperty

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public BlockState onlyWithProperty(String name)

Throws:

NoSuchElementException - If the property was not found

onlyWithProperty

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public BlockState onlyWithProperty(BlockProperty<?> property)

Throws:

NoSuchElementException - If the property was not found

onlyWithProperty

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public BlockState onlyWithProperty(String name,
 Serializable value)

Throws:

NoSuchElementException - If the property is not registered

InvalidBlockPropertyValueException - If the new value is not accepted by the property

onlyWithProperty

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public <T extends Serializable> BlockState onlyWithProperty(BlockProperty<T> property,
 T value)

Throws:

NoSuchElementException - If the property is not registered

InvalidBlockPropertyValueException - If the new value is not accepted by the property

forItem

@Since("1.4.0.0-PN")
@PowerNukkitOnly
public BlockState forItem()

asItemBlock

@Since("1.4.0.0-PN")
@PowerNukkitOnly
@Nonnull
public ItemBlock asItemBlock(int count)

Specified by:

asItemBlock in interface IBlockState

getDataStorage

@Nonnegative
@Nonnull
@PowerNukkitOnly
public Number getDataStorage()

Specified by:

getDataStorage in interface IBlockState

getProperties

@Nonnull
@PowerNukkitOnly
public BlockProperties getProperties()

Specified by:

getProperties in interface IBlockState

getLegacyDamage

@Nonnegative
@Deprecated
@DeprecationDetails(reason="Can\'t store all data, exists for backward compatibility reasons",
                    since="1.4.0.0-PN",
                    replaceWith="getDataStorage()")
@PowerNukkitOnly
public int getLegacyDamage()

Deprecated.

Specified by:

getLegacyDamage in interface IBlockState

getBigDamage

@Unsigned
@Deprecated
@DeprecationDetails(reason="Can\'t store all data, exists for backward compatibility reasons",
                    since="1.4.0.0-PN",
                    replaceWith="getDataStorage()")
@PowerNukkitOnly
public int getBigDamage()

Deprecated.

Specified by:

getBigDamage in interface IBlockState

getSignedBigDamage

@Nonnegative
@Since("1.4.0.0-PN")
@PowerNukkitOnly
@Deprecated
@DeprecationDetails(reason="Can\'t store all data, exists for backward compatibility reasons",
                    since="1.4.0.0-PN",
                    replaceWith="getDataStorage()")
public int getSignedBigDamage()

Deprecated.

Specified by:

getSignedBigDamage in interface IBlockState

getHugeDamage

@Nonnegative
@PowerNukkitOnly
@Since("1.4.0.0-PN")
@Nonnull
public BigInteger getHugeDamage()

Specified by:

getHugeDamage in interface IBlockState

getPropertyValue

@Nonnull
@PowerNukkitOnly
public Serializable getPropertyValue(String propertyName)

Specified by:

getPropertyValue in interface IBlockState

getIntValue

@PowerNukkitOnly
public int getIntValue(String propertyName)

Specified by:

getIntValue in interface IBlockState

getBooleanValue

@PowerNukkitOnly
public boolean getBooleanValue(String propertyName)

Specified by:

getBooleanValue in interface IBlockState

getPersistenceValue

@Nonnull
@PowerNukkitOnly
public String getPersistenceValue(String propertyName)

Specified by:

getPersistenceValue in interface IBlockState

getCurrentState

@Nonnull
@PowerNukkitOnly
public BlockState getCurrentState()

Specified by:

getCurrentState in interface IBlockState

getBitSize

@PowerNukkitOnly
public int getBitSize()

Specified by:

getBitSize in interface IBlockState

getExactIntStorage

@Since("1.4.0.0-PN")
@PowerNukkitOnly
public int getExactIntStorage()

Specified by:

getExactIntStorage in interface IBlockState

Throws:

ArithmeticException - If the storage have more than 32 bits

isDefaultState

@Since("1.4.0.0-PN")
@PowerNukkitOnly
public boolean isDefaultState()

Specified by:

isDefaultState in interface IBlockState

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

validate

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public void validate()

Throws:

InvalidBlockStateException - If the stored state is invalid

isCachedValidationValid

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public boolean isCachedValidationValid()

getCachedValidation

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public OptionalBoolean getCachedValidation()

getBlock

@Nonnull
@PowerNukkitOnly
public Block getBlock()

Specified by:

getBlock in interface IBlockState

getBlock

@Nonnull
@PowerNukkitOnly
public Block getBlock(@Nullable
 Level level,
 int x,
 int y,
 int z,
 int layer,
 boolean repair,
 @Nullable
 Consumer<BlockStateRepair> callback)

Specified by:

getBlock in interface IBlockState

toString

public String toString()

Overrides:

toString in class Object