Class ItemTypeIconComponent

Hierarchy (View Summary)

ItemTypeComponent
- ItemTypeIconComponent

Index

Constructors

Properties

collection identifier type identifier

Accessors

Methods

getDefaultIcon getDyedIcon setDefaultIcon setDyedIcon

Constructors

constructor

new ItemTypeIconComponent(
type: ItemType,
options?: Partial<ItemTypeIconComponentOptions>,
): ItemTypeIconComponent
Creates a new icon component.
Parameters
- type: ItemType
  The type of the item.
- Optionaloptions: Partial<ItemTypeIconComponentOptions>
  The options for the icon component.
Returns ItemTypeIconComponent
Overrides ItemTypeComponent.constructor
- Defined in packages/core/src/item/identity/components/icon.ts:28

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:icon"

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

getDefaultIcon

getDefaultIcon(): string
Get the default icon of the item.

Returns string
The icon of the item.
- Defined in packages/core/src/item/identity/components/icon.ts:50

getDyedIcon

getDyedIcon(): string
Get the dyed icon of the item.

Returns string
The dyed icon of the item.
- Defined in packages/core/src/item/identity/components/icon.ts:74

setDefaultIcon

setDefaultIcon(value: string): void
Set the default icon of the item.
Parameters
- value: string
  The icon of the item.
Returns void
- Defined in packages/core/src/item/identity/components/icon.ts:62

setDyedIcon

setDyedIcon(value: string): void
Set the dyed icon of the item.
Parameters
- value: string
  The dyed icon of the item.
Returns void
- Defined in packages/core/src/item/identity/components/icon.ts:86