nova/xyz.xenondevs.nova.world.block.behavior/Breakable

Breakable

Defines values used for block breaking. Makes blocks breakable.

Inheritors

Types

class Default(hardness: Provider<Double>, toolCategories: Provider<Set<ToolCategory>>, toolTier: Provider<ToolTier?>, requiresToolForDrops: Provider<Boolean>, breakParticles: Provider<Material?>, showBreakAnimation: Provider<Boolean>) : Breakable

Default implementation of Breakable.

Properties

breakParticles

abstract val breakParticles: Material?

The type of break particles to spawn in case the block is entity-backed or model-less with no vanilla particles.

hardness

abstract val hardness: Double

The hardness of the block. Higher values mean the block takes longer to break.

requiresToolForDrops

abstract val requiresToolForDrops: Boolean

Whether the block requires a tool to drop its item.

showBreakAnimation

abstract val showBreakAnimation: Boolean

Whether the break animation should be shown.

toolCategories

abstract val toolCategories: Set<ToolCategory>

The ToolCategories required to break the block. If empty, no specific tool is required.

toolTier

abstract val toolTier: ToolTier?

The ToolTier required to break the block. Can be null to not require a specific tool tier.

Functions

canPlace

open suspend fun canPlace(pos: BlockPos, state: NovaBlockState, ctx: Context<DefaultContextIntentions.BlockPlace>): Boolean

Checks whether a block of state can be placed at pos using the given ctx.

getDrops

open fun getDrops(pos: BlockPos, state: NovaBlockState, ctx: Context<DefaultContextIntentions.BlockBreak>): List<ItemStack>

Retrieves the items that would be dropped when breaking a block of state at pos with the given ctx. Handlers should check DefaultContextParamTypes.BLOCK_DROPS and DefaultContextParamTypes.BLOCK_STORAGE_DROPS.

getExp

open fun getExp(pos: BlockPos, state: NovaBlockState, ctx: Context<DefaultContextIntentions.BlockBreak>): Int

Retrieves the amount of experience that would be dropped when breaking a block of state at pos with the given ctx. Handlers should check DefaultContextParamTypes.BLOCK_EXP_DROPS.

handleAttack

open fun handleAttack(pos: BlockPos, state: NovaBlockState, ctx: Context<DefaultContextIntentions.BlockBreak>)

Handles attack (left-click) on a block of state at pos with the given ctx.

handleBreak

open fun handleBreak(pos: BlockPos, state: NovaBlockState, ctx: Context<DefaultContextIntentions.BlockBreak>)

Handles the destruction of a block of state at pos with the given ctx.

handleEntityInside

open fun handleEntityInside(pos: BlockPos, state: NovaBlockState, entity: Entity)

Called when an entity is inside a block of state at pos.

handleInteract

open fun handleInteract(pos: BlockPos, state: NovaBlockState, ctx: Context<DefaultContextIntentions.BlockInteract>): Boolean

Handles interaction (right-click) with a block of state at pos with the given ctx.

handleNeighborChanged

open fun handleNeighborChanged(pos: BlockPos, state: NovaBlockState)

Called when a redstone update happened that may affect this state at pos.

handlePlace

open fun handlePlace(pos: BlockPos, state: NovaBlockState, ctx: Context<DefaultContextIntentions.BlockPlace>)

Handles the placement of a block of state at pos with the given ctx.

handleRandomTick

open fun handleRandomTick(pos: BlockPos, state: NovaBlockState)

Handles a random tick for a block of state at pos.

handleScheduledTick

open fun handleScheduledTick(pos: BlockPos, state: NovaBlockState)

Handles a scheduled tick for a block of state at pos.

pickBlockCreative

open fun pickBlockCreative(pos: BlockPos, state: NovaBlockState, ctx: Context<DefaultContextIntentions.BlockInteract>): ItemStack?

Chooses the ItemStack that should be given to the player when mid-clicking a block of state at pos with the given ctx in creative mode.

ticksRandomly

open fun ticksRandomly(state: NovaBlockState): Boolean

Whether this behavior implements random-tick logic for the given state. Note that the result of this method will be cached on startup.

updateShape

open fun updateShape(pos: BlockPos, state: NovaBlockState, neighborPos: BlockPos): NovaBlockState

Called when a block at neighborPos changed to update the NovaBlockState of this state at pos.