Class ItemCooldownComponentBeta

Readonly BetacooldownCategory

Readonly BetacooldownTicks

Static Readonly BetacomponentId

getCooldownTicksRemaining

• getCooldownTicksRemaining(player: Player): number
  Beta

  Parameters

  • player: Player

  Returns number

  Remarks

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

  Throws

  This function can throw errors.

isCooldownCategory

• isCooldownCategory(cooldownCategory: string): boolean
  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.

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

  Throws

  This function can throw errors.

startCooldown

• startCooldown(player: Player): void
  Beta

  Parameters

  • player: Player

  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.