Class ItemComponentRegistry

registerCustomComponent

• registerCustomComponent(
      name: string,
      itemCustomComponent: ItemCustomComponent,
  ): void

  Parameters

  • name: string

    The id that represents this custom component. Must have a namespace. This id can be specified in a item's JSON configuration under the 'minecraft:custom_components' item component.
  • itemCustomComponent: ItemCustomComponent

    The collection of event functions that will be called when the event occurs on an item using this custom component id.

  Returns void

  Remarks

  Registers an item custom component that can be used in item JSON configuration.

  Throws

  This function can throw errors.

  CustomComponentInvalidRegistryError

  CustomComponentNameError

  minecraftcommon.EngineError

  ItemCustomComponentAlreadyRegisteredError

  ItemCustomComponentReloadNewComponentError

  ItemCustomComponentReloadNewEventError

  ItemCustomComponentReloadVersionError