org.spongepowered.api.block

Interface BlockType

All Superinterfaces:

CatalogType, PropertyHolder, Translatable

@CatalogedBy(value=BlockTypes.class)
public interface BlockType
extends CatalogType, Translatable, PropertyHolder

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 via DataHolder.

Method Summary

Modifier and Type	Method and Description
Collection<BlockState>	getAllBlockStates() Gets a Collection of all BlockStates for this BlockType.
BlockState	getDefaultState() Return the default state for this block.
Optional<ItemType>	getItem() Return the ItemType that represents this block.
String	getName() Return the internal ID for the block.
BlockSoundGroup	getSoundGroup() Gets the BlockSoundGroup for this block.
boolean	getTickRandomly() Gets if this BlockType is set to receive random block ticks.
Optional<BlockTrait<?>>	getTrait(String blockTrait) Attempts to retrieve the BlockTrait instance associated with this BlockStates BlockType by string id.
Collection<BlockTrait<?>>	getTraits() Gets an immutable Collection of all applicable BlockTraits for this BlockType.
void	setTickRandomly(boolean tickRandomly) Sets if the BlockType should receive random block ticks.

Methods inherited from interface org.spongepowered.api.CatalogType

getId

Methods inherited from interface org.spongepowered.api.text.translation.Translatable

getTranslation

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

getApplicableProperties, getProperty

Method Detail

getName

String getName()

Return the internal ID for the block.

The format of the internal ID may vary between implementations but in Minecraft, it follows the format of domain:type, an example being minecraft:stone.

Specified by:

getName in interface CatalogType

Returns:

The id

getDefaultState

BlockState getDefaultState()

Return the default state for this block.

Returns:

The default state

getAllBlockStates

Collection<BlockState> getAllBlockStates()

Gets a Collection of all BlockStates for this BlockType.

Returns:

An immutable collection of all block states for this block type

getItem

Optional<ItemType> getItem()

Return the ItemType that represents this block.

Returns:

The item type or Optional.empty() otherwise

getTickRandomly

boolean getTickRandomly()

Gets if this BlockType is set to receive random block ticks.

Random block ticks are most commonly used for growth of plants.

Returns:

If the BlockType ticks randomly.

setTickRandomly

void setTickRandomly(boolean tickRandomly)

Sets if the BlockType should receive random block ticks.

Random block ticks are most commonly used for growth of plants.

Parameters:

tickRandomly - If the BlockType should tick randomly.

getTraits

Collection<BlockTrait<?>> getTraits()

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

Returns:

An immutable collection of all applicable block traits

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

getSoundGroup

BlockSoundGroup getSoundGroup()

Gets the BlockSoundGroup for this block.

Returns:

This block's sound group.