Class PlayerStartEmotingSignal

Hierarchy (View Summary)

EventSignal
- PlayerStartEmotingSignal

Index

Constructors

Properties

emote identifier player tickLength world identifier

Methods

Constructors

constructor

new PlayerStartEmotingSignal(
    player: Player,
    emote: string,
    tickLength: number,
): PlayerStartEmotingSignal
Create a new player start emoting signal.
Parameters
- player: Player
  The player that started emoting.
- emote: string
  The emote the player started.
- tickLength: number
  The duration of the emote in ticks.
Returns PlayerStartEmotingSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/player-start-emoting.ts:30

Properties

`Readonly`emote

emote: string

The emote the player started.

`Readonly`identifier

identifier: PlayerStartEmoting = WorldEvent.PlayerStartEmoting

The identifier of the signal.

`Readonly`player

player: Player

The player that started emoting.

`Readonly`tickLength

tickLength: number

The duration of the emote in ticks.

`Readonly`world

world: World

The world instance the signal was emitted in.

`Static` `Readonly`identifier

identifier: WorldEvent

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