@minecraft/server

---

@minecraft/server / ItemCooldownComponent

Class: ItemCooldownComponent

Defined in: @minecraft/server/index.d.ts:13937

When present on an item, this item has a cooldown effect when used by entities.

Extends

• ItemComponent

Properties

cooldownCategory

readonly cooldownCategory: string

Defined in: @minecraft/server/index.d.ts:13946

Remarks

Represents the cooldown category that this item is associated with.

Throws

This property can throw when used.

---

cooldownTicks

readonly cooldownTicks: number

Defined in: @minecraft/server/index.d.ts:13954

Remarks

Amount of time, in ticks, it will take this item to cooldown.

Throws

This property can throw when used.

---

isValid

readonly isValid: boolean

Defined in: @minecraft/server/index.d.ts:6234

Remarks

Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

Inherited from

ItemComponent.isValid

---

typeId

readonly typeId: string

Defined in: @minecraft/server/index.d.ts:6240

Remarks

Identifier of the component.

Inherited from

ItemComponent.typeId

---

componentId

readonly static componentId: "minecraft:cooldown" = 'minecraft:cooldown'

Defined in: @minecraft/server/index.d.ts:13955

Methods

getCooldownTicksRemaining()

getCooldownTicksRemaining(player): number

Defined in: @minecraft/server/index.d.ts:13962

Parameters

player

Player

Returns

number

Remarks

This function can't be called in restricted-execution mode.

Throws

This function can throw errors.

---

isCooldownCategory()

isCooldownCategory(cooldownCategory): boolean

Defined in: @minecraft/server/index.d.ts:13977

Parameters

cooldownCategory

string

The cooldown category that might be associated with this item.

Returns

boolean

True if the item is the given cooldown category.

Remarks

Will return true if the item is the cooldown category passed in and false otherwise.

This function can't be called in restricted-execution mode.

Throws

This function can throw errors.

---

startCooldown()

startCooldown(player): void

Defined in: @minecraft/server/index.d.ts:13986

Parameters

player

Player

Returns

void

Remarks

Starts a new cooldown period for this item.

This function can't be called in restricted-execution mode.

Throws

This function can throw errors.