Package org.spongepowered.api.entity.living.player

Interface CooldownTracker

public interface CooldownTracker
Provides access to the item cooldowns of a Player.

  • Method Details

    • hasCooldown

      boolean hasCooldown(ItemStack stack)
      Checks if the specified ItemType is currently on cooldown for the player.
      Parameters:
      stack - The item type to check is on cooldown
      Returns:
      Whether or not the specified item type is cooldown

    • hasCooldown

      boolean hasCooldown(ResourceKey group)

    • cooldown

      Optional<Ticks> cooldown(ItemStack stack)
      Gets the cooldown of the specified ItemType in ticks for the player, or empty if the the item type is currently not on cooldown.
      Parameters:
      stack - The item type to get the cooldown for
      Returns:
      The cooldown remaining for this item type in ticks, if not on cooldown

    • cooldown

      Optional<Ticks> cooldown(ResourceKey group)
      Gets the cooldown for the specified group in ticks for the player, or empty if the group is not on cooldown.
      Parameters:
      group - The group to get the cooldown for
      Returns:
      The cooldown remaining for this group in ticks, if not on cooldown

    • setCooldown

      boolean setCooldown(ItemStack stack, Ticks ticks)
      Sets the cooldown for the specified ItemType for the specified amount of ticks.
      Parameters:
      stack - The item type to set the cooldown for
      ticks - The amount of ticks to set the item type on cooldown for
      Returns:
      False if setting the cooldown failed, possibly due to the event being cancelled

    • setCooldown

      boolean setCooldown(ResourceKey group, Ticks ticks)

    • resetCooldown

      boolean resetCooldown(ItemStack stack)
      Resets the cooldown of the specified ItemType for the player.
      Parameters:
      stack - The item type to reset the cooldown for
      Returns:
      False if setting the cooldown failed, possibly due to the event being cancelled

    • resetCooldown

      boolean resetCooldown(ResourceKey group)

    • fractionRemaining

      OptionalDouble fractionRemaining(ItemStack stack)
      Gets the fraction of the specified ItemType's cooldown that is remaining for the player, or empty if the the item type is currently not on cooldown.

      If present, this value will be between 0.0 and 1.0.

      Parameters:
      stack - The item type to get the cooldown fraction remaining
      Returns:
      The fraction of cooldown remaining for the specified item type

    • fractionRemaining

      OptionalDouble fractionRemaining(ResourceKey group)