#Class: ItemCooldownComponent

component

Beta

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

#Extends

• ItemComponent

#Properties

#cooldownCategory

readonly cooldownCategory: string

Beta

#Remarks

Represents the cooldown category that this item is associated with.

#Throws

This property can throw when used.

---

#cooldownTicks

readonly cooldownTicks: number

Beta

#Remarks

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

#Throws

This property can throw when used.

---

#isValid

readonly isValid: boolean

Beta

#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

Beta

#Remarks

组件的标识符。

Identifier of the component.

#Inherited from

ItemComponent.typeId

---

#componentId

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

Beta

#Methods

#getCooldownTicksRemaining()

getCooldownTicksRemaining(player): number

World Mutation Beta

#Parameters

#player

Player

#Returns

number

#Remarks

#Throws

This function can throw errors.

---

#isCooldownCategory()

isCooldownCategory(cooldownCategory): boolean

World Mutation Beta

#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.

#Throws

This function can throw errors.

---

#startCooldown()

startCooldown(player): void

World Mutation Beta

#Parameters

#player

Player

#Returns

void

#Remarks

Starts a new cooldown period for this item.

#Throws

This function can throw errors.

#同领域相关

• BlockComponent
• BlockComponentBlockBreakEvent
• BlockComponentBlockStateChangeEvent
• BlockComponentEntityEvent
• BlockComponentEntityFallOnEvent
• BlockComponentOnPlaceEvent