Class WorldClockRegistryBeta

registerClock

• registerClock(
      name: string,
      registrationOptions?: WorldClockRegistrationOptions,
  ): void

  Parameters

  • name: string

    The name that represents this world clock. Must have a namespace and use only valid identifier characters. (e.g., 'mypack:my_clock').

  • OptionalregistrationOptions: WorldClockRegistrationOptions

    Additional options for registering a world clock, such as including time markers at registration time.

  Returns void

  Remarks

  Registers a new custom world clock. Must be called during the system startup event.

  Privilege

  early-execution-allowed - This function can be called in early-execution mode.

  Throws

  This function can throw errors.

  WorldClockInvalidRegistryError

  WorldClockRegistrationError

  WorldClockReloadNewWorldClockError

  WorldClockReloadTimeMarkerError