Class ItemStackDamagedSignal

Hierarchy (View Summary)

EventSignal
- ItemStackDamagedSignal

Index

Constructors

Properties

durabilityBefore durbabilityDamageDealt identifier itemStack world identifier

Methods

Constructors

constructor

new ItemStackDamagedSignal(
    itemStack: ItemStack,
    durabilityBefore: number,
    durabilityDamageDealt: number,
): ItemStackDamagedSignal
Create a new item stack damaged event.
Parameters
- itemStack: ItemStack
  The item stack that took damage.
- durabilityBefore: number
  The durability before the damage was dealt.
- durabilityDamageDealt: number
  The amount of damage dealt to the item stack.
Returns ItemStackDamagedSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/item-stack-damaged.ts:30

Properties

`Readonly`durabilityBefore

durabilityBefore: number

The durability before the damage was dealt.

durbabilityDamageDealt

durbabilityDamageDealt: number

The amount of damage dealt to the item stack.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`itemStack

itemStack: ItemStack

The item stack that took damage.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: ItemStackDamaged = WorldEvent.ItemStackDamaged

The identifier of the signal.

Methods

emit

emit(): boolean
Emits the signal instance.

Returns boolean
Whether the signal was emitted successfully; default is true.
Inherited from EventSignal.emit
- Defined in packages/core/src/events/event-signal.ts:34