Class ItemCooldownComponent

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

Hierarchy (View Summary)

Properties

cooldownCategory cooldownTicks typeId componentId

Methods

getCooldownTicksRemaining isCooldownCategory isValid startCooldown

Properties

ReadonlycooldownCategory

cooldownCategory: string

Remarks

Represents the cooldown category that this item is associated with.

Throws

This property can throw when used.

ReadonlycooldownTicks

cooldownTicks: number

Remarks

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

Throws

This property can throw when used.

ReadonlytypeId

typeId: string

Remarks

Identifier of the component.

Static ReadonlycomponentId

componentId: "minecraft:cooldown" = 'minecraft:cooldown'

Methods

getCooldownTicksRemaining

  • getCooldownTicksRemaining(player: Player): number

  • Parameters

    Returns number

    Remarks

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

isCooldownCategory

  • isCooldownCategory(cooldownCategory: string): boolean

  • 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 read-only mode.

    Throws

    This function can throw errors.

isValid

  • isValid(): boolean

  • Returns boolean

    Whether the component is valid.

    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.

startCooldown

  • startCooldown(player: Player): void

  • Parameters

    Returns void

    Remarks

    Starts a new cooldown period for this item.

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

Settings

Member Visibility

On This Page

Properties
Methods