Class WorldClockApi

Static ReadonlyDEFAULT_SCALE

Static ReadonlySNAPSHOT_INTERVAL_MS

Static_advanceForTesting

• _advanceForTesting(realMs: number): void

  Parameters

  • realMs: number

  Returns void

Static_resetForTesting

• _resetForTesting(): void

  Returns void

Static_setNowProviderForTesting

• _setNowProviderForTesting(fn: () => number): void

  Parameters

  • fn: () => number

  Returns void

Staticafter

• after(
      delay: string | Quantity<"s">,
      cb: ClockCallback,
      opts?: ScheduleOpts,
  ): ClockHandle

  Parameters

  • delay: string | Quantity<"s">
  • cb: ClockCallback
  • Optionalopts: ScheduleOpts

  Returns ClockHandle

Staticat

• at(deadline: Quantity<"s">, cb: ClockCallback, opts?: ScheduleOpts): ClockHandle

  Parameters

  • deadline: Quantity<"s">
  • cb: ClockCallback
  • Optionalopts: ScheduleOpts

  Returns ClockHandle

Staticboot

• boot(): Promise<void>

  Boot the clock: restore the persisted game-time anchor (or seed a zero clock on a fresh DB), start the crash backstop, and register any system-scope schedules. Called once from AppBootstrap.run after the bootstrap manifest.

  SystemRoot-gated: only the empty-stack process-boundary caller (the AppBootstrap.run sequence) has a null caller. Every game, eval, scheduled-callback, and network context runs under a frame (non-null caller) and is denied — nothing in-world can re-anchor the clock or restart its backstop.

  Returns Promise<void>

Staticcancel

• cancel(handle: ClockHandle): void

  Parameters

  • handle: ClockHandle

  Returns void

StaticcancelByHost

• cancelByHost(host: Stuff): number

  Parameters

  • host: Stuff

  Returns number

StaticcancelByTag

• cancelByTag(tag: string, host?: Stuff): number

  Cancel every schedule with tag; if host given, AND on host identity.

  Parameters

  • tag: string
  • Optionalhost: Stuff

  Returns number

Staticcron

• cron(
      pattern: CronPattern,
      cb: ClockCallback,
      opts?: ScheduleOpts & { calendar?: Calendar },
  ): ClockHandle

  Fire on every calendar date matching a partial pattern. Self- rescheduling: each fire recomputes the next matching deadline.

  Parameters

  • pattern: CronPattern
  • cb: ClockCallback
  • Optionalopts: ScheduleOpts & { calendar?: Calendar }

  Returns ClockHandle

Staticevery

• every(
      interval: string | Quantity<"s">,
      cb: ClockCallback,
      opts?: ScheduleOpts & { runs?: number; startAt?: Quantity<"s"> },
  ): ClockHandle

  Parameters

  • interval: string | Quantity<"s">
  • cb: ClockCallback
  • Optionalopts: ScheduleOpts & { runs?: number; startAt?: Quantity<"s"> }

  Returns ClockHandle

StaticgetNow

• getNow(): Quantity<"s">

  Returns Quantity<"s">

StaticgetScale

• getScale(): number

  Returns number

StaticisPaused

• isPaused(): boolean

  Returns boolean

StaticonDate

• onDate(
      date: string | CalendarDate,
      cb: ClockCallback,
      opts?: ScheduleOpts & { calendar?: Calendar },
  ): ClockHandle

  Fire once at an absolute calendar date. A CalendarDate is composed to a deadline; a string is parsed via the calendar's parseDate. Defaults to DefaultCalendar.

  Parameters

  • date: string | CalendarDate
  • cb: ClockCallback
  • Optionalopts: ScheduleOpts & { calendar?: Calendar }

  Returns ClockHandle

Staticpause

• pause(): void

  Returns void

Staticrestore

• restore(snap: WorldClockSnapshot): void

  Parameters

  • snap: WorldClockSnapshot

  Returns void

Staticresume

• resume(): void

  Returns void

StaticsetScale

• setScale(scale: number): void

  Parameters

  • scale: number

  Returns void

Staticshutdown

• shutdown(): Promise<void>

  Shut the clock down gracefully: pause game-time and persist the elapsed-game-time anchor so the next boot resumes continuously. SystemRoot-gated for the same reason as boot().

  Returns Promise<void>

Staticsnapshot

• snapshot(): WorldClockSnapshot

  Returns WorldClockSnapshot