Package org.geysermc.geyser.api.block.custom.component

Interface CustomBlockComponents.Builder

Enclosing interface:

CustomBlockComponents

public static interface CustomBlockComponents.Builder

Method Summary

Modifier and Type	Method	Description
CustomBlockComponents	build()	Builds these CustomBlockComponents.
CustomBlockComponents.Builder	collisionBox(@Nullable BoxComponent collisionBox)	Deprecated. use collisionBoxes(BoxComponent...) instead
CustomBlockComponents.Builder	collisionBoxes(@Nullable Collection<BoxComponent> collisionBoxes)	Convenience method to set collision boxes for the block.
CustomBlockComponents.Builder	collisionBoxes(@Nullable BoxComponent... collisionBoxes)	Sets up to 16 different collision boxes for the block.
CustomBlockComponents.Builder	destructibleByMining(Float destructibleByMining)	Sets the destructible by mining value of the block.
CustomBlockComponents.Builder	displayName(String displayName)	Sets the display name of the block.
CustomBlockComponents.Builder	friction(Float friction)	Sets the friction value of the block.
CustomBlockComponents.Builder	geometry(GeometryComponent geometry)	Sets the geometry of the block.
CustomBlockComponents.Builder	lightDampening(Integer lightDampening)	Sets the light dampening value of the block.
CustomBlockComponents.Builder	lightEmission(Integer lightEmission)	Sets the light emission value of the block.
CustomBlockComponents.Builder	materialInstance(@NonNull String name, @NonNull MaterialInstance materialInstance)	Sets the material instances of the block.
CustomBlockComponents.Builder	placeAir(boolean placeAir)	Whether the block should place only air, overriding the default behavior.
CustomBlockComponents.Builder	placementFilter(List<PlacementConditions> placementConditions)	Sets the placement filter of the block.
CustomBlockComponents.Builder	selectionBox(@Nullable BoxComponent selectionBox)	Sets a selection box for the block.
CustomBlockComponents.Builder	tags(@Nullable Set<String> tags)	Sets the set of tags for the block.
CustomBlockComponents.Builder	transformation(TransformationComponent transformation)	Sets the transformation of the block.
CustomBlockComponents.Builder	unitCube(boolean unitCube)	Deprecated. Use geometry(GeometryComponent) with `minecraft:geometry.full_block` instead.

Method Details

selectionBox

CustomBlockComponents.Builder selectionBox(@Nullable BoxComponent selectionBox)

Sets a selection box for the block. Unlike Java Edition, there can only be one selection box.

Parameters:

selectionBox - a selection box, or null for none

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.selectionBox()

collisionBox

@Deprecated(since="2.9.5")
CustomBlockComponents.Builder collisionBox(@Nullable BoxComponent collisionBox)

Deprecated.

use collisionBoxes(BoxComponent...) instead

Sets a collision box for the block. Can be null to disable collisions.

Parameters:

collisionBox - the collision box to set

Returns:

this builder

Since:

2.2.0

collisionBoxes

CustomBlockComponents.Builder collisionBoxes(@Nullable BoxComponent... collisionBoxes)

Sets up to 16 different collision boxes for the block. Can be null to disable collisions.

Parameters:

collisionBoxes - the collision boxes to set

Returns:

this builder

Since:

2.9.5

See Also:

• CustomBlockComponents.collisionBoxes()

collisionBoxes

CustomBlockComponents.Builder collisionBoxes(@Nullable Collection<BoxComponent> collisionBoxes)

Convenience method to set collision boxes for the block. Can be null to disable collisions.

Parameters:

collisionBoxes - the collection of collision boxes to set

Returns:

this builder

Since:

2.9.5

See Also:

• CustomBlockComponents.collisionBoxes()

displayName

CustomBlockComponents.Builder displayName(String displayName)

Sets the display name of the block.

Parameters:

displayName - the display name to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.displayName()

geometry

CustomBlockComponents.Builder geometry(GeometryComponent geometry)

Sets the geometry of the block.

Parameters:

geometry - the geometry to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.geometry()

materialInstance

CustomBlockComponents.Builder materialInstance(@NonNull String name,
 @NonNull MaterialInstance materialInstance)

Sets the material instances of the block.

Parameters:

name - the name of the material instance

materialInstance - the material instance to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.materialInstances()

placementFilter

CustomBlockComponents.Builder placementFilter(List<PlacementConditions> placementConditions)

Sets the placement filter of the block.

Parameters:

placementConditions - the placement conditions to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.placementFilter()

destructibleByMining

CustomBlockComponents.Builder destructibleByMining(Float destructibleByMining)

Sets the destructible by mining value of the block.

Parameters:

destructibleByMining - the destructible by mining value to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.destructibleByMining()

friction

CustomBlockComponents.Builder friction(Float friction)

Sets the friction value of the block.

Parameters:

friction - the friction value to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.friction()

lightEmission

CustomBlockComponents.Builder lightEmission(Integer lightEmission)

Sets the light emission value of the block.

Parameters:

lightEmission - the light emission value to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.lightEmission()

lightDampening

CustomBlockComponents.Builder lightDampening(Integer lightDampening)

Sets the light dampening value of the block.

Parameters:

lightDampening - the light dampening value to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.lightDampening()

transformation

CustomBlockComponents.Builder transformation(TransformationComponent transformation)

Sets the transformation of the block.

Parameters:

transformation - the transformation to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.transformation()

unitCube

@Deprecated(since="2.2.2")
CustomBlockComponents.Builder unitCube(boolean unitCube)

Deprecated.

Use geometry(GeometryComponent) with `minecraft:geometry.full_block` instead.

Sets the unit cube value, equivalent to setting a full block geometry.

See Also:

• CustomBlockComponents.unitCube()

placeAir

CustomBlockComponents.Builder placeAir(boolean placeAir)

Whether the block should place only air, overriding the default behavior.

Parameters:

placeAir - whether the block should place only air

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.placeAir()

tags

CustomBlockComponents.Builder tags(@Nullable Set<String> tags)

Sets the set of tags for the block.

Parameters:

tags - the set of tags to set

Returns:

this builder

Since:

2.2.0

See Also:

• CustomBlockComponents.tags()

build

CustomBlockComponents build()

Builds these CustomBlockComponents.

Returns:

the built CustomBlockComponents

Since:

2.2.0