Class ItemCooldownComponentBeta

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

Hierarchy (View Summary)

Properties

cooldownCategory cooldownTicks typeId componentId

Methods

isValid startCooldown

Properties

Readonly BetacooldownCategory

cooldownCategory: string

Remarks

Represents the cooldown category that this item is associated with.

Throws

This property can throw when used.

Readonly BetacooldownTicks

cooldownTicks: number

Remarks

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

Throws

This property can throw when used.

Readonly BetatypeId

typeId: string

Remarks

Identifier of the component.

Static Readonly BetacomponentId

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

Methods

isValid

  • isValid(): boolean
    Beta

    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
    Beta

    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