Class PlayerEditSignSignal

Hierarchy (View Summary)

EventSignal
- PlayerEditSignSignal

Index

Constructors

Properties

backText block frontText identifier player world identifier

Methods

Constructors

constructor

new PlayerEditSignSignal(
    player: Player,
    block: Block,
    frontText?: string,
    backText?: string,
): PlayerEditSignSignal
Creates a new instance of the PlayerEditSignSignal class.
Parameters
- player: Player
  The player that is editing the sign.
- block: Block
  The block of the sign being edited.
- OptionalfrontText: string
  The front text of the sign.
- OptionalbackText: string
  The back text of the sign.
Returns PlayerEditSignSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/player-edit-sign.ts:37

Properties

backText

backText: string

The back text of the sign.

`Readonly`block

block: Block

The block of the sign being edited.

frontText

frontText: string

The front text of the sign.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`player

player: Player

The player that is editing the sign.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: PlayerEditSign = WorldEvent.PlayerEditSign

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