Bukkit
Public
Commits
md_5 authored 36b11391a2c
| 6 6 | import org.jetbrains.annotations.Nullable; |
| 7 7 | |
| 8 8 | /** |
| 9 9 | * Represents a component which determines the cooldown applied to use of this |
| 10 10 | * item. |
| 11 11 | */ |
| 12 12 | .Experimental |
| 13 13 | public interface UseCooldownComponent extends ConfigurationSerializable { |
| 14 14 | |
| 15 15 | /** |
| 16 - | * Gets the time in seconds it will take for this item to be eaten. |
| 16 + | * Gets the time in seconds it will take for an item in this cooldown group |
| 17 + | * to be available to use again. |
| 17 18 | * |
| 18 - | * @return eat time |
| 19 + | * @return cooldown time |
| 19 20 | */ |
| 20 21 | float getCooldownSeconds(); |
| 21 22 | |
| 22 23 | /** |
| 23 - | * Sets the time in seconds it will take for this item to be eaten. |
| 24 + | * Sets the time in seconds it will take for an item in this cooldown group |
| 25 + | * to be available to use again. |
| 24 26 | * |
| 25 - | * @param eatSeconds new eat time, must be positive |
| 27 + | * @param cooldown new eat time, must be greater than 0 |
| 26 28 | */ |
| 27 - | void setCooldownSeconds(float eatSeconds); |
| 29 + | void setCooldownSeconds(float cooldown); |
| 28 30 | |
| 29 31 | /** |
| 30 32 | * Gets the custom cooldown group to be used for similar items, if set. |
| 31 33 | * |
| 32 34 | * @return the cooldown group |
| 33 35 | */ |
| 34 36 | |
| 35 37 | NamespacedKey getCooldownGroup(); |
| 36 38 | |
| 37 39 | /** |