Interface ItemCustomComponent

Contains a set of events that will be raised for an item. This object must be bound using the ItemComponentRegistry.

Hierarchy

ItemCustomComponent

Index

Properties

onBeforeDurabilityDamage? onCompleteUse? onConsume? onHitEntity? onMineBlock? onUse? onUseOn?

Properties

`Optional` onBeforeDurabilityDamage

onBeforeDurabilityDamage?: ((arg) => void)

Type declaration

- (arg): void
- Parameters
  - arg: ItemComponentBeforeDurabilityDamageEvent
  Returns void
  
  Remarks
  This function will be called when an item containing this component is hitting an entity and about to take durability damage.

`Optional` onCompleteUse

onCompleteUse?: ((arg) => void)

Type declaration

- (arg): void
- Parameters
  - arg: ItemComponentCompleteUseEvent
  Returns void
  
  Remarks
  This function will be called when an item containing this component's use duration was completed.

`Optional` onConsume

onConsume?: ((arg) => void)

Type declaration

- (arg): void
- Parameters
  - arg: ItemComponentConsumeEvent
  Returns void
  
  Remarks
  This function will be called when an item containing this component is eaten by an entity.

`Optional` onHitEntity

onHitEntity?: ((arg) => void)

Type declaration

- (arg): void
- Parameters
  - arg: ItemComponentHitEntityEvent
  Returns void
  
  Remarks
  This function will be called when an item containing this component is used to hit another entity.

`Optional` onMineBlock

onMineBlock?: ((arg) => void)

Type declaration

- (arg): void
- Parameters
  - arg: ItemComponentMineBlockEvent
  Returns void
  
  Remarks
  This function will be called when an item containing this component is used to mine a block.

`Optional` onUse

onUse?: ((arg) => void)

Type declaration

- (arg): void
- Parameters
  - arg: ItemComponentUseEvent
  Returns void
  
  Remarks
  This function will be called when an item containing this component is used by a player.

`Optional` onUseOn

onUseOn?: ((arg) => void)

Type declaration

- (arg): void
- Parameters
  - arg: ItemComponentUseOnEvent
  Returns void
  
  Remarks
  This function will be called when an item containing this component is used on a block.