Edit

Share via


ItemCustomComponent Interface

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

Properties

onBeforeDurabilityDamage

onBeforeDurabilityDamage?: (arg0: ItemComponentBeforeDurabilityDamageEvent, arg1: CustomComponentParameters) => void;

This function will be called when an item containing this component is hitting an entity and about to take durability damage.

Type: (arg0: ItemComponentBeforeDurabilityDamageEvent, arg1: CustomComponentParameters) => void

onCompleteUse

onCompleteUse?: (arg0: ItemComponentCompleteUseEvent, arg1: CustomComponentParameters) => void;

This function will be called when an item containing this component's use duration was completed.

Type: (arg0: ItemComponentCompleteUseEvent, arg1: CustomComponentParameters) => void

onConsume

onConsume?: (arg0: ItemComponentConsumeEvent, arg1: CustomComponentParameters) => void;

This function will be called when an item containing this component is eaten by an entity.

Type: (arg0: ItemComponentConsumeEvent, arg1: CustomComponentParameters) => void

onHitEntity

onHitEntity?: (arg0: ItemComponentHitEntityEvent, arg1: CustomComponentParameters) => void;

This function will be called when an item containing this component is used to hit another entity.

Type: (arg0: ItemComponentHitEntityEvent, arg1: CustomComponentParameters) => void

onMineBlock

onMineBlock?: (arg0: ItemComponentMineBlockEvent, arg1: CustomComponentParameters) => void;

This function will be called when an item containing this component is used to mine a block.

Type: (arg0: ItemComponentMineBlockEvent, arg1: CustomComponentParameters) => void

onUse

onUse?: (arg0: ItemComponentUseEvent, arg1: CustomComponentParameters) => void;

This function will be called when an item containing this component is used by a player.

Type: (arg0: ItemComponentUseEvent, arg1: CustomComponentParameters) => void

onUseOn

onUseOn?: (arg0: ItemComponentUseOnEvent, arg1: CustomComponentParameters) => void;

This function will be called when an item containing this component is used on a block.

Type: (arg0: ItemComponentUseOnEvent, arg1: CustomComponentParameters) => void