Class WorldTickSignal

Hierarchy (View Summary)

EventSignal
- WorldTickSignal

Index

Constructors

Properties

currentTick deltaTick identifier world identifier

Methods

Constructors

constructor

new WorldTickSignal(
    currentTick: bigint,
    deltaTick: bigint,
    world: World,
): WorldTickSignal
Creates a new world tick signal.
Parameters
- currentTick: bigint
  The current tick of the world.
- deltaTick: bigint
  The time delta between the current tick and the last tick.
- world: World
  The world that has been ticked.
Returns WorldTickSignal
Overrides EventSignal.constructor
- Defined in packages/core/src/events/world-tick.ts:31

Properties

`Readonly`currentTick

currentTick: bigint

The current tick of the world.

`Readonly`deltaTick

deltaTick: bigint

The time delta between the current tick and the last tick.

`Readonly`identifier

identifier: WorldEvent = ...

The identifier of the signal.

`Readonly`world

world: World

The world that has been ticked.

`Static` `Readonly`identifier

identifier: WorldTick = WorldEvent.WorldTick

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