Interface BlockCustomComponentBeta

Contains a set of events that will be raised for a block. This object must be bound using the BlockRegistry.

interface BlockCustomComponent {
    beforeOnPlayerPlace?: (
        arg0: BlockComponentPlayerPlaceBeforeEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onBreak?: (
        arg0: BlockComponentBlockBreakEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onEntity?: (
        arg0: BlockComponentEntityEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onEntityFallOn?: (
        arg0: BlockComponentEntityFallOnEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onPlace?: (
        arg0: BlockComponentOnPlaceEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onPlayerBreak?: (
        arg0: BlockComponentPlayerBreakEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onPlayerInteract?: (
        arg0: BlockComponentPlayerInteractEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onRandomTick?: (
        arg0: BlockComponentRandomTickEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onRedstoneUpdate?: (
        arg0: BlockComponentRedstoneUpdateEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onStepOff?: (
        arg0: BlockComponentStepOffEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onStepOn?: (
        arg0: BlockComponentStepOnEvent,
        arg1: CustomComponentParameters,
    ) => void;
    onTick?: (
        arg0: BlockComponentTickEvent,
        arg1: CustomComponentParameters,
    ) => void;
}

Properties

beforeOnPlayerPlace? onBreak? onEntity? onEntityFallOn? onPlace? onPlayerBreak? onPlayerInteract? onRandomTick? onRedstoneUpdate? onStepOff? onStepOn? onTick?

Properties

Optional BetabeforeOnPlayerPlace

beforeOnPlayerPlace?: (
    arg0: BlockComponentPlayerPlaceBeforeEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called before a player places the block.

Optional BetaonBreak

onBreak?: (
    arg0: BlockComponentBlockBreakEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when a specific block is destroyed. Changes in block permutations will not trigger this event. Fill Command and SetBlock Command can trigger this event when changing a block permutation only when using destroy mode. Custom blocks with the "minecraft:replaceable" component will not trigger the event when replaced.

Optional BetaonEntity

onEntity?: (
    arg0: BlockComponentEntityEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when an entity fires an event to this block in the world.

Optional BetaonEntityFallOn

onEntityFallOn?: (
    arg0: BlockComponentEntityFallOnEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when an entity falls onto the block that this custom component is bound to.

Optional BetaonPlace

onPlace?: (
    arg0: BlockComponentOnPlaceEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when the block that this custom component is bound to is placed.

Optional BetaonPlayerBreak

onPlayerBreak?: (
    arg0: BlockComponentPlayerBreakEvent,
    arg1: CustomComponentParameters,
) => void

Optional BetaonPlayerInteract

onPlayerInteract?: (
    arg0: BlockComponentPlayerInteractEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when a player sucessfully interacts with the block that this custom component is bound to.

Optional BetaonRandomTick

onRandomTick?: (
    arg0: BlockComponentRandomTickEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when a block randomly ticks.

Optional BetaonRedstoneUpdate

onRedstoneUpdate?: (
    arg0: BlockComponentRedstoneUpdateEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when an 'onRedstoneUpdate' engine event occurs if the block has a minecraft:redstone_consumer component and the redstone signal strength is >= to the components min_power field.

Optional BetaonStepOff

onStepOff?: (
    arg0: BlockComponentStepOffEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when an entity steps off the block that this custom component is bound to.

Optional BetaonStepOn

onStepOn?: (
    arg0: BlockComponentStepOnEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when an entity steps onto the block that this custom component is bound to.

Optional BetaonTick

onTick?: (
    arg0: BlockComponentTickEvent,
    arg1: CustomComponentParameters,
) => void

Remarks

This function will be called when a block ticks.

Settings

Member Visibility

On This Page

Properties