Class GameTime

StaticSYNC_INTERVAL_MS

averageLatency

• get averageLatency(): number

  The average one-way latency between client and server in milliseconds.

  Returns number

calendar

• get calendar(): CalendarData<TimeComponents>

  The calendar instance for in-world timekeeping.

  Returns CalendarData<TimeComponents>

components

• get components(): TimeComponents

  The current World time expressed as components.

  Returns TimeComponents

earthCalendar

• get earthCalendar(): CalendarData<TimeComponents>

  The "Earth" calendar instance for IRL timekeeping.

  Returns CalendarData<TimeComponents>

serverTime

• get serverTime(): number

  The current server time based on the last synchronization point and the approximated one-way latency.

  Returns number

worldTime

• get worldTime(): number
  • The current World time expressed in seconds.

  Returns number

advance

• advance(delta: number | TimeComponents, options?: object): Promise<number>

  Advance or rewind the world time according to a delta amount expressed either in seconds or as components.

  Parameters

  • delta: number | TimeComponents

    The number of seconds to advance (or rewind if negative) by

  • Optionaloptions: object

    Additional options passed to game.settings.set

  Returns Promise<number>

  The new game time

initializeCalendar

• initializeCalendar(): void

  Initialize a calendar configuration. This is called once automatically upon construction, but can be called manually if CONFIG.time changes.

  Returns void

onUpdateWorldTime

• onUpdateWorldTime(
      worldTime: number,
      options: object,
      userId: string,
  ): Promise<void>

  Handle follow-up actions when the official World time is changed

  Parameters

  • worldTime: number

    The new canonical World time.

  • options: object

    Options passed from the requesting client where the change was made

  • userId: string

    The ID of the User who advanced the time

  Returns Promise<void>

set

• set(time: number | TimeComponents, options?: object): Promise<number>

  Directly set the world time to a certain value expressed either in seconds or as components.

  Parameters

  • time: number | TimeComponents

    The desired world time

  • Optionaloptions: object

    Additional options passed to game.settings.set

  Returns Promise<number>

  The new game time

sync

• sync(): Promise<GameTime>

  Synchronize the local client game time with the official time kept by the server

  Returns Promise<GameTime>