Package org.bukkit.inventory.meta.components

Interface UseCooldownComponent

All Superinterfaces:

ConfigurationSerializable

@Experimental
public interface UseCooldownComponent
extends ConfigurationSerializable

Represents a component which determines the cooldown applied to use of this item.

Method Summary

Modifier and Type	Method	Description
NamespacedKey	getCooldownGroup()	Gets the custom cooldown group to be used for similar items, if set.
float	getCooldownSeconds()	Gets the time in seconds it will take for this item to be eaten.
void	setCooldownGroup(NamespacedKey song)	Sets the custom cooldown group to be used for similar items.
void	setCooldownSeconds(float eatSeconds)	Sets the time in seconds it will take for this item to be eaten.

Methods inherited from interface org.bukkit.configuration.serialization.ConfigurationSerializable

serialize

Method Details

getCooldownSeconds

float getCooldownSeconds()

Gets the time in seconds it will take for this item to be eaten.

Returns:

eat time

setCooldownSeconds

void setCooldownSeconds(float eatSeconds)

Sets the time in seconds it will take for this item to be eaten.

Parameters:

eatSeconds - new eat time, must be positive

getCooldownGroup

@Nullable
NamespacedKey getCooldownGroup()

Gets the custom cooldown group to be used for similar items, if set.

Returns:

the cooldown group

setCooldownGroup

void setCooldownGroup(@Nullable
 NamespacedKey song)

Sets the custom cooldown group to be used for similar items.

Parameters:

song - the cooldown group