Class CustomItemComponent

Define a custom item component.

Example

~~~ts
 // Define the component
 const COMPONENT = new CustomItemComponent("lazuli:example", {
    onConsume(arg) {
      arg.source.addEffect("posion", 200);
    },
  })
  // Registry the component
  Register.componentRegistry(COMPONENT);
~~~

Constructors

constructor

Properties

components typeId

Constructors

constructor

  • new CustomItemComponent(typeId, components): CustomItemComponent

  • Parameters

    • typeId: 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.

    • components: ItemCustomComponent

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

    Returns CustomItemComponent

    Throws

    This function can throw errors.

Properties

components

components: ItemCustomComponent

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

ReadonlytypeId

typeId: 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.

Settings

Member Visibility

On This Page

Constructors
Properties