Class CustomBlock

constructor

• new CustomBlock(): CustomBlock

  Returns CustomBlock

Static ReadonlyCOMPONENT_ID

OptionalbeforeOnPlayerPlace

• beforeOnPlayerPlace?(
      event: BlockComponentPlayerPlaceBeforeEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentPlayerPlaceBeforeEvent
  • args: CustomComponentParameters

  Returns void

  Remarks

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

OptionalonBreak

• onBreak?(
      event: BlockComponentBlockBreakEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentBlockBreakEvent
  • args: CustomComponentParameters

  Returns 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.

OptionalonEntityFallOn

• onEntityFallOn?(
      event: BlockComponentEntityFallOnEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentEntityFallOnEvent
  • args: CustomComponentParameters

  Returns void

  Remarks

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

OptionalonPlace

• onPlace?(
      event: BlockComponentOnPlaceEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentOnPlaceEvent
  • args: CustomComponentParameters

  Returns void

  Remarks

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

OptionalonPlayerBreak

• onPlayerBreak?(
      event: BlockComponentPlayerBreakEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentPlayerBreakEvent
  • args: CustomComponentParameters

  Returns void

OptionalonPlayerInteract

• onPlayerInteract?(
      event: BlockComponentPlayerInteractEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentPlayerInteractEvent
  • args: CustomComponentParameters

  Returns void

  Remarks

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

OptionalonRandomTick

• onRandomTick?(
      event: BlockComponentRandomTickEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentRandomTickEvent
  • args: CustomComponentParameters

  Returns void

  Remarks

  This function will be called when a block randomly ticks.

OptionalonRedstoneUpdate

• onRedstoneUpdate?(
      event: BlockComponentRedstoneUpdateEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentRedstoneUpdateEvent
  • args: CustomComponentParameters

  Returns 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.

OptionalonStepOff

• onStepOff?(
      event: BlockComponentStepOffEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentStepOffEvent
  • args: CustomComponentParameters

  Returns void

  Remarks

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

OptionalonStepOn

• onStepOn?(
      event: BlockComponentStepOnEvent,
      args: CustomComponentParameters,
  ): void

  Parameters

  • event: BlockComponentStepOnEvent
  • args: CustomComponentParameters

  Returns void

  Remarks

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

OptionalonTick

• onTick?(event: BlockComponentTickEvent, args: CustomComponentParameters): void

  Parameters

  • event: BlockComponentTickEvent
  • args: CustomComponentParameters

  Returns void

  Remarks

  This function will be called when a block ticks.