pylon-core/io.github.pylonmc.pylon.core.block.context/BlockBreakContext

BlockBreakContext

Information surrounding a block break event. Used to centralize block breaking logic so that BlockBreakEvent, BlockExplodeEvent, etc. can all be references by one interface rather than having to be dealt with individually.

Inheritors

Types

BlockExploded

data class BlockExploded(val event: BlockExplodeEvent) : BlockBreakContext

The block is being exploded as a result of another block exploding

BlockExplosionOrigin

data class BlockExplosionOrigin(val event: BlockExplodeEvent) : BlockBreakContext

The block is exploding (e.g. beds in the Nether/End, respawn anchors in the Overworld/End)

Burned

data class Burned(val event: BlockBurnEvent) : BlockBreakContext

The block has been burned away by fire

Delete

class Delete(val block: Block) : BlockBreakContext

The block is being forcefully broken by BlockStorage.deleteBlock

Destroyed

data class Destroyed(val event: BlockDestroyEvent) : BlockBreakContext

The block has been destroyed for another reason, such as a lever dropping because the block it was attached to was broken. It is not really documented exactly when the event that this relies on is actually fired for some reason.

EntityExploded

data class EntityExploded(val block: Block, val event: EntityExplodeEvent) : BlockBreakContext

The block is being exploded by an entity (e.g. a creeper or TNT)

Faded

data class Faded(val event: BlockFadeEvent) : BlockBreakContext

The block has faded away (see BlockFadeEvent for more details)

PlayerBreak

@JvmRecord

data class PlayerBreak(val event: BlockBreakEvent) : Record, BlockBreakContext

The block is being broken by a player

PluginBreak

class PluginBreak @JvmOverloads constructor(val block: Block, val normallyDrops: Boolean = true, val shouldSetToAir: Boolean = true) : BlockBreakContext

The block is being broken by a plugin

Properties

block

abstract val block: Block

The block that is about to be broken.

normallyDrops

@get:JvmName(name = "normallyDrops")

abstract val normallyDrops: Boolean

Determines the default drop behavior of the context

shouldSetToAir

@get:JvmName(name = "shouldSetToAir")

open val shouldSetToAir: Boolean

If true, the block will be set to air after the Pylon data is removed