Package org.spongepowered.api.block
Interface BlockType
-
- All Superinterfaces:
ComponentLike
,DataHolder
,DataHolder.Immutable<BlockType>
,DefaultedRegistryValue
,StateContainer<BlockState>
,Taggable<BlockType>
,ValueContainer
@CatalogedBy(BlockTypes.class) public interface BlockType extends DefaultedRegistryValue, ComponentLike, StateContainer<BlockState>, DataHolder.Immutable<BlockType>, Taggable<BlockType>
Describes a base type of block.Blocks are further differentiated using a
BlockState
. Complex data, such as inventory contents, are considered data, which is provided viaBlockEntity
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder
DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
doesUpdateRandomly()
Gets if this BlockType is set to receive random block ticks.boolean
isAnyOf(java.util.function.Supplier<? extends BlockType>... types)
Returns true if this type is any of the given block typesboolean
isAnyOf(BlockType... types)
Returns true if this type is any of the given block typesjava.util.Optional<ItemType>
item()
Return theItemType
that represents this block.void
setUpdateRandomly(boolean updateRandomly)
Sets if the BlockType should receive random block updates.BlockSoundGroup
soundGroup()
Gets theBlockSoundGroup
for this block.-
Methods inherited from interface net.kyori.adventure.text.ComponentLike
asComponent
-
Methods inherited from interface org.spongepowered.api.data.DataHolder.Immutable
mergeWith, mergeWith, transform, transform, with, with, with, without, without, without
-
Methods inherited from interface org.spongepowered.api.registry.DefaultedRegistryValue
asDefaultedReference, findKey, key
-
Methods inherited from interface org.spongepowered.api.state.StateContainer
defaultState, findStateProperty, stateProperties, validStates
-
-
-
-
Method Detail
-
item
java.util.Optional<ItemType> item()
Return theItemType
that represents this block.- Returns:
- The item type or
Optional.empty()
otherwise
-
doesUpdateRandomly
boolean doesUpdateRandomly()
Gets if this BlockType is set to receive random block ticks.Random block updates are most commonly used for growth of plants.
- Returns:
- If the BlockType updates randomly
-
setUpdateRandomly
void setUpdateRandomly(boolean updateRandomly)
Sets if the BlockType should receive random block updates.Random block updates are most commonly used for growth of plants.
- Parameters:
updateRandomly
- If the BlockType should update randomly
-
soundGroup
BlockSoundGroup soundGroup()
Gets theBlockSoundGroup
for this block.- Returns:
- This block's sound group.
-
isAnyOf
boolean isAnyOf(java.util.function.Supplier<? extends BlockType>... types)
Returns true if this type is any of the given block types- Parameters:
types
- the block types to check- Returns:
- true if this type is any of the given block types
-
isAnyOf
boolean isAnyOf(BlockType... types)
Returns true if this type is any of the given block types- Parameters:
types
- the block types to check- Returns:
- true if this type is any of the given block types
-
-