Class ItemTypeDisplayNameComponent

Hierarchy (View Summary)

ItemTypeComponent
- ItemTypeDisplayNameComponent

Index

Constructors

Properties

collection identifier type identifier

Accessors

Methods

getDisplayName setDisplayName

Constructors

constructor

new ItemTypeDisplayNameComponent(
type: ItemType,
value?: string,
): ItemTypeDisplayNameComponent
Create a new display name component for an item type.
Parameters
- type: ItemType
  The item type that the component will be attached to.
- Optionalvalue: string
  The display name of the item type.
Returns ItemTypeDisplayNameComponent
Overrides ItemTypeComponent.constructor
- Defined in packages/core/src/item/identity/components/display-name.ts:15

Properties

`Protected` `Readonly`collection

collection: ItemTypeComponentCollection

The component collection of the item type.

`Readonly`identifier

identifier: string = ...

The component identifier of the item type.

`Protected` `Readonly`type

The item type of the component.

`Static` `Readonly`identifier

identifier: "minecraft:display_name"

The component identifier of the item type.

Accessors

`Protected`component

get component(): CompoundTag<unknown>
The component value of the item type.

Returns CompoundTag<unknown>
Inherited from ItemTypeComponent.component
- Defined in packages/core/src/item/identity/components/component.ts:31

Methods

getDisplayName

getDisplayName(): string
Get the display name of the item type.

Returns string
The display name of the item type.
- Defined in packages/core/src/item/identity/components/display-name.ts:26

setDisplayName

setDisplayName(value: string): void
Set the display name of the item type.
Parameters
- value: string
  The display name of the item type.
Returns void
- Defined in packages/core/src/item/identity/components/display-name.ts:38