Package org.bukkit.inventory.meta.components

Interface UseEffectsComponent

All Superinterfaces:
ConfigurationSerializable
@Experimental public interface UseEffectsComponent extends ConfigurationSerializable
Represents a component which determines the attributes while using this item.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canSprint()
    Gets whether the player can sprint while using this item.
    float
    getSpeedMultiplier()
    Gets the speed multiplier applied to the player while using this item.
    boolean
    isInteractVibrations()
    Gets whether using this item will trigger vibrations.
    void
    setCanSprint(boolean sprint)
    Sets whether the player can sprint while using this item.
    void
    setInteractVibrations(boolean interactVibrations)
    Sets whether using this item will trigger vibrations.
    void
    setSpeedMultiplier(float multiplier)
    Sets the speed multiplier applied to the player while using this item.

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

    serialize

  • Method Details

    • canSprint

      boolean canSprint()
      Gets whether the player can sprint while using this item.
      Returns:
      whether player can sprint

    • setCanSprint

      void setCanSprint(boolean sprint)
      Sets whether the player can sprint while using this item.
      Parameters:
      sprint - whether player can sprint

    • isInteractVibrations

      boolean isInteractVibrations()
      Gets whether using this item will trigger vibrations.
      Returns:
      whether use will trigger vibrations

    • setInteractVibrations

      void setInteractVibrations(boolean interactVibrations)
      Sets whether using this item will trigger vibrations.
      Parameters:
      interactVibrations - whether use will trigger vibrations

    • getSpeedMultiplier

      float getSpeedMultiplier()
      Gets the speed multiplier applied to the player while using this item.
      Returns:
      speed multiplier

    • setSpeedMultiplier

      void setSpeedMultiplier(float multiplier)
      Sets the speed multiplier applied to the player while using this item.
      Parameters:
      multiplier - new multiplier