Interface: ItemCustomComponent
Contains a set of events that will be raised for an item. This object must be bound using the ItemComponentRegistry.
Properties
onBeforeDurabilityDamage()?
optionalonBeforeDurabilityDamage: (arg) =>void
Parameters
| Parameter | Type |
|---|---|
arg | ItemComponentBeforeDurabilityDamageEvent |
Returns
void
onCompleteUse()?
optionalonCompleteUse: (arg) =>void
Parameters
| Parameter | Type |
|---|---|
arg | ItemComponentCompleteUseEvent |
Returns
void
onConsume()?
optionalonConsume: (arg) =>void
Parameters
| Parameter | Type |
|---|---|
arg | ItemComponentConsumeEvent |
Returns
void
onHitEntity()?
optionalonHitEntity: (arg) =>void
Parameters
| Parameter | Type |
|---|---|
arg | ItemComponentHitEntityEvent |
Returns
void
onMineBlock()?
optionalonMineBlock: (arg) =>void
Remarks
This function will be called when an item containing this component is used to mine a block.
Parameters
| Parameter | Type |
|---|---|
arg | ItemComponentMineBlockEvent |
Returns
void
onUse()?
optionalonUse: (arg) =>void
Remarks
This function will be called when an item containing this component is used by a player.
Parameters
| Parameter | Type |
|---|---|
arg | ItemComponentUseEvent |
Returns
void
onUseOn()?
optionalonUseOn: (arg) =>void
Parameters
| Parameter | Type |
|---|---|
arg | ItemComponentUseOnEvent |
Returns
void