twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-07-31 04:02:06 -07:00
Code Issues Packages Projects Releases Wiki Activity

Expand cooldown API (#12435)

Browse Source
This commit is contained in:
Jakub Zacek
2025-04-22 11:30:00 +02:00
committed by GitHub
parent def0532ffc
commit d22644aada
2 changed files with 50 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
paper-api/src/main/java/org/bukkit/entity/HumanEntity.java
View File

@@ -3,6 +3,8 @@ package org.bukkit.entity;
import java.util.Collection;
import java.util.Set;
import java.util.function.Consumer;
import io.papermc.paper.datacomponent.item.UseCooldown;
import net.kyori.adventure.key.Key;
import org.bukkit.GameMode;
import org.bukkit.Location;
import org.bukkit.Material;
@@ -368,7 +370,7 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, InventoryHolder
/**
* Set a cooldown on the specified material for a certain amount of ticks.
* ticks. 0 ticks will result in the removal of the cooldown.
* 0 ticks will result in the removal of the cooldown.
* <p>
* Cooldowns are used by the server for items such as ender pearls and
* shields to prevent them from being used repeatedly.
@@ -415,7 +417,7 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, InventoryHolder
/**
* Set a cooldown on the specified item for a certain amount of ticks.
* ticks. 0 ticks will result in the removal of the cooldown.
* 0 ticks will result in the removal of the cooldown.
* <p>
* Cooldowns are used by the server for items such as ender pearls and
* shields to prevent them from being used repeatedly.
@@ -428,6 +430,31 @@ public interface HumanEntity extends LivingEntity, AnimalTamer, InventoryHolder
*/
public void setCooldown(ItemStack item, int ticks);
/**
* Get the cooldown time in ticks remaining for the specified cooldown group.
*
* @param key the cooldown group to check
* @return the remaining cooldown time in ticks
* @see UseCooldown#cooldownGroup()
*/
public int getCooldown(Key key);
/**
* Set a cooldown on items with the specified cooldown group for a certain amount of ticks.
* 0 ticks will result in the removal of the cooldown.
* <p>
* Cooldowns are used by the server for items such as ender pearls and
* shields to prevent them from being used repeatedly.
* <p>
* Note that cooldowns will not by themselves stop an item from being used
* for attacking.
*
* @param key cooldown group to set the cooldown for
* @param ticks the amount of ticks to set or 0 to remove
* @see UseCooldown#cooldownGroup()
*/
public void setCooldown(Key key, int ticks);
/**
* Get the sleep ticks of the player. This value may be capped.
*