Class PlayerCraftRecipeSignal

Hierarchy (View Summary)

EventSignal
- PlayerCraftRecipeSignal

Index

Constructors

Properties

amount identifier player recipe world identifier

Methods

Constructors

constructor

new PlayerCraftRecipeSignal(
    player: Player,
    recipe: Recipe,
    amount: number,
): PlayerCraftRecipeSignal
Creates a new instance of the PlayerCraftRecipeSignal class.
Parameters
- player: Player
  The player that is crafting the recipe.
- recipe: Recipe
  The recipe being crafted.
- amount: number
  The amount times the recipe is being crafted.
Returns PlayerCraftRecipeSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/player-craft-recipe.ts:31

Properties

amount

amount: number

The amount times the recipe is being crafted.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`player

player: Player

The player that is crafting the recipe.

recipe

recipe: Recipe

The recipe being crafted.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: PlayerCraftRecipe = WorldEvent.PlayerCraftRecipe

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