ItemDyeableComponent

Class in @minecraft/server

Extends ItemComponent

A leather item’s dye.

import { ItemDyeableComponent } from '@minecraft/server';

Example

TypeScript JavaScript

import { ItemStack, type ItemDyeableComponent } from '@minecraft/server';

const item = new ItemStack('minecraft:diamond_sword');
const component: ItemDyeableComponent | undefined = item.getComponent('minecraft:dyeable');
if (component) {
    console.log(item.typeId, component.typeId);
}

import { ItemStack } from '@minecraft/server';

const item = new ItemStack('minecraft:diamond_sword');
const component = item.getComponent('minecraft:dyeable');
if (component) {
    console.log(item.typeId, component.typeId);
}

Properties

componentId

static read-only

static readonly componentId = "minecraft:dyeable";

color

optional

color?: RGB;

The dye on the item, or undefined for none. Setting it changes the stack; undefined washes it off.

Types

RGB

defaultColor

read-only optional

readonly defaultColor?: RGB;

The colour of undyed leather.

Types

RGB

Used by

ItemComponentTypeMap.dyeable, ItemComponentTypeMap.minecraft:dyeable

Inherited

From ItemComponent: typeId, isValid