Class WorldClockBeta

World mutationisPaused

World mutationtime

addTimeMarker

• addTimeMarker(timeMarkerOptions: TimeMarkerOptions): void
  World mutation

  Parameters

  • timeMarkerOptions: TimeMarkerOptions

    Options for creating a time marker.

  Returns void

  Remarks

  Adds a new time marker to the world clock.

  Throws

  This function can throw errors.

  WorldClockAddTimeMarkerError

removeTimeMarker

• removeTimeMarker(timeMarker: string | TimeMarker): void
  World mutation

  Parameters

  • timeMarker: string | TimeMarker

    The time marker or time marker name to remove.

  Returns void

  Remarks

  Removes an existing time marker from the world clock.

  Throws

  WorldClockTimeMarkerNotFoundError: If the time marker does not exist on the world clock. WorldClockRemoveMinecraftTimeMarkerError: If the time marker uses the 'minecraft' namespace.

  WorldClockRemoveMinecraftTimeMarkerError

  WorldClockTimeMarkerNotFoundError

rewindTo

• rewindTo(timeMarker: string | TimeMarker): void
  World mutation

  Parameters

  • timeMarker: string | TimeMarker

    The time marker or time marker name to rewind the world clock's time to.

  Returns void

  Remarks

  Rewinds the world clock's time to the previous occurrence of the specified time marker.

  Throws

  WorldClockTimeMarkerNotFoundError: If the time marker does not exist on the world clock. WorldClockRewindError: If the world clock's current time is before the time marker's first occurrence.

  WorldClockRewindError

  WorldClockTimeMarkerNotFoundError

set

• set(timeMarker: string | TimeMarker): void
  World mutation

  Parameters

  • timeMarker: string | TimeMarker

    The time marker or time marker name to set the world clock's time to.

  Returns void

  Remarks

  Sets the world clock's time to the specified time marker.

  Throws

  WorldClockTimeMarkerNotFoundError: If the time marker does not exist on the world clock.

  WorldClockTimeMarkerNotFoundError

skipTo

• skipTo(timeMarker: string | TimeMarker): void
  World mutation

  Parameters

  • timeMarker: string | TimeMarker

    The time marker or time marker name to skip the world clock's time to.

  Returns void

  Remarks

  Skips the world clock's time to the next occurrence of the specified time marker. If the next occurrence overflows the world clock's time, the time is reset to the first occurrence.

  Throws

  WorldClockTimeMarkerNotFoundError: If the time marker does not exist on the world clock.

  WorldClockTimeMarkerNotFoundError