Returns a map of custom block state properties to be used for the block texture item. These properties will be merged with the vanilla block state properties of the block.

getDropItem

open fun getDropItem(context: BlockBreakContext): ItemStack?

Returns the item that the block should drop.

getHeldEntity

@ApiStatus.NonExtendable

open fun getHeldEntity(name: String): Entity?

@ApiStatus.NonExtendable

open fun <T : Entity> getHeldEntity(clazz: Class<T>, name: String): T?

getHeldEntityOrThrow

@ApiStatus.NonExtendable

open fun getHeldEntityOrThrow(name: String): Entity

@ApiStatus.NonExtendable

open fun <T : Entity> getHeldEntityOrThrow(clazz: Class<T>, name: String): T

getHeldEntityUuid

@ApiStatus.NonExtendable

open fun getHeldEntityUuid(name: String): UUID?

getHeldEntityUuidOrThrow

@ApiStatus.NonExtendable

open fun getHeldEntityUuidOrThrow(name: String): UUID

getHeldRebarEntity

@ApiStatus.NonExtendable

open fun getHeldRebarEntity(name: String): RebarEntity<*>?

@ApiStatus.NonExtendable

open fun <T : RebarEntity<*>> getHeldRebarEntity(clazz: Class<T>, name: String): T?

getHeldRebarEntityOrThrow

@ApiStatus.NonExtendable

open fun <T : RebarEntity<*>> getHeldRebarEntityOrThrow(clazz: Class<T>, name: String): T

getKey

open override fun getKey(): NamespacedKey

getPickItem

open fun getPickItem(): ItemStack?

Returns the item that should be given when the block is middle clicked.

getSettings

fun getSettings(): Config

Returns settings associated with the block.

getWaila

open fun getWaila(player: Player): WailaDisplay?

WAILA is the text that shows up when looking at a block to tell you what the block is.

isHeldEntityPresent

@ApiStatus.NonExtendable

open fun isHeldEntityPresent(name: String): Boolean

Returns false if the block holds no entity with the provided name, the entity is unloaded or does not physically exist.

isVisible

open override fun isVisible(player: Player): Boolean

If the block is currently visible to the player. Used only to determine which io.github.pylonmc.rebar.culling.PlayerCullingConfig interval to use

key

open fun key(): @NotNull Key

onBreak

open fun onBreak(drops: MutableList<ItemStack>, context: BlockBreakContext)

Called as the block is being broken. At this point, the block break cannot be cancelled, but the physical block has not yet been broken or removed from io.github.pylonmc.rebar.block.BlockStorage.

onCulled

open override fun onCulled(player: Player)

Does not do anything for group culled blocks, see onGroupCulled

onGroupCulled

open override fun onGroupCulled(player: Player, group: RebarGroupCulledBlock.CullingGroup)

onGroupVisible

open override fun onGroupVisible(player: Player, group: RebarGroupCulledBlock.CullingGroup)

onInteract

open override fun onInteract(event: PlayerInteractEvent, priority: EventPriority)

This may be called for both hands, so make sure you check which hand is used.

onVisible

open override fun onVisible(player: Player)

Does not do anything for group culled blocks, see onGroupVisible

postBreak

open override fun postBreak(context: BlockBreakContext)

Called after the block has been broken. At this point, the block has been physically removed, block drops have been dropped, and the block has been removed from io.github.pylonmc.rebar.block.BlockStorage.

postInitialise

open fun postInitialise()

Called after both the create constructor and the load constructor.

preBreak

open fun preBreak(context: BlockBreakContext): Boolean

Called before the block is broken. Note this is not called for Deletions as those are not cancellable.

refreshBlockTextureItem

fun refreshBlockTextureItem()

Call this method to refresh the block texture entity's item to be the result of getBlockTextureItem, or a barrier if that returns null.

scheduleBlockTextureItemRefresh

fun scheduleBlockTextureItemRefresh()

Schedules the block texture item to be refreshed on the next server tick. See refreshBlockTextureItem.

tryRemoveAllEntities

open fun tryRemoveAllEntities()

tryRemoveEntity

open fun tryRemoveEntity(name: String)

updateConnectedFaces

fun updateConnectedFaces()

updateDisplays

fun updateDisplays()

whenHeldRebarEntityLoads

@ApiStatus.NonExtendable

open fun whenHeldRebarEntityLoads(name: String, consumer: Consumer<RebarEntity<*>>)

@ApiStatus.NonExtendable

open fun <T : RebarEntity<*>> whenHeldRebarEntityLoads(clazz: Class<T>, name: String, consumer: Consumer<T>)

write

open override fun write(pdc: PersistentDataContainer)

Called when the block is saved.

writeDebugInfo

open fun writeDebugInfo(pdc: PersistentDataContainer)

Called when debug info is requested for the block by someone using the DebugWaxedWeatheredCutCopperStairs. If there is any transient data that can be useful for debugging, you're encouraged to serialize it here.