ItemCooldownComponent

Class in @minecraft/server

Extends ItemComponent

An item’s cooldown: once used, items of its category wait before they can be used again.

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

Example

TypeScript JavaScript

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

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

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

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

Properties

componentId

static read-only

static readonly componentId = "minecraft:cooldown";

cooldownCategory

read-only

readonly cooldownCategory: string;

cooldownTicks

read-only

readonly cooldownTicks: number;

Ticks a use makes the category wait.

Methods

getCooldownTicksRemaining

getCooldownTicksRemaining(player: Player): number;

Ticks the player still waits on this category, 0 for none.

Parameters

player

Player

Returns

number

Types

Player

isCooldownCategory

isCooldownCategory(cooldownCategory: string): boolean;

Parameters

cooldownCategory

string

Returns

boolean

startCooldown

startCooldown(player: Player): void;

Starts the cooldown for a player, greying the category’s items out on their screen.

Parameters

player

Player

Types

Player

Used by

ItemComponentTypeMap.cooldown, ItemComponentTypeMap.minecraft:cooldown

Inherited

From ItemComponent: typeId, isValid