Class: PlotNotReadyError

An error produced when a readiness-dependent API is used before Plot has installed the complete ready state.

Synchronous reads and channel sends throw this error; state-write promises reject with it. Other API calls do not start readiness implicitly, so await Plot.ready() before trying the operation again. These APIs are already available inside a pre-registered initial snapshot callback, which runs just before the readiness promise resolves.

See

Getting started

Extends

Constructors

Constructor

new PlotNotReadyError(): PlotNotReadyError

Creates an error that directs the game to its readiness boundary.

Returns

PlotNotReadyError

Overrides

PlotError.constructor

Properties

cause?

readonly optional cause?: unknown

The lower-level error that caused this failure, when one exists.

Inherited from

PlotError.cause


code

readonly code: "not-ready"

The stable machine-readable failure reason.

Overrides

PlotError.code