Package org.geysermc.geyser.api.item.custom.v2.component.java

Interface JavaUseCooldown

public interface JavaUseCooldown
The use cooldown component is used to add an item use cooldown to items.
Since:
2.9.3

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    JavaUseCooldown.Builder
    Builder for the use cooldown component.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NonNull JavaUseCooldown.Builder
    builder()
    Creates a builder for the use cooldown component.
    @Nullable Identifier
    cooldownGroup()
    The cooldown type of the item.
    @org.checkerframework.checker.index.qual.Positive float
    seconds()
    The duration of time in seconds items with a matching category will spend cooling down before being usable again.

  • Method Details

    • seconds

      @org.checkerframework.checker.index.qual.Positive float seconds()
      The duration of time in seconds items with a matching category will spend cooling down before being usable again.
      Returns:
      the cooldown duration
      Since:
      2.9.3

    • cooldownGroup

      @Nullable Identifier cooldownGroup()
      The cooldown type of the item. Other items in this group will also have the cooldown applied when any item of this group is used. null will result in the item identifier being used.
      Returns:
      the cooldown identifier
      Since:
      2.9.3

    • builder

      static @NonNull JavaUseCooldown.Builder builder()
      Creates a builder for the use cooldown component.
      Returns:
      a new builder
      Since:
      2.9.3