Package io.papermc.paper.registry.data.dialog.input

Interface NumberRangeDialogInput

All Superinterfaces:
DialogInput
@NonExtendable public non-sealed interface NumberRangeDialogInput extends DialogInput
A number range dialog input.

Created via DialogInput.numberRange(String, int, Component, String, float, float, Float, Float)

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    NumberRangeDialogInput.Builder
    A builder for creating instances of NumberRangeDialogInput.

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    end()
    The end of the range.
    @Nullable Float
    initial()
    The initial value of the input, or null if not set.
    net.kyori.adventure.text.Component
    label()
    The label for the input.
    String
    labelFormat()
    The format for the label, which can be a translation key or a format string.
    float
    start()
    The start of the range.
    @Positive @Nullable Float
    step()
    The step size for the input, or null if not set.
    @org.jetbrains.annotations.Range(from=1L, to=1024L) int
    width()
    The width of the input.

    Methods inherited from interface io.papermc.paper.registry.data.dialog.input.DialogInput

    key

  • Method Details

    • width

      @Contract(pure=true) @org.jetbrains.annotations.Range(from=1L, to=1024L) int width()
      The width of the input.
      Returns:
      the width

    • label

      @Contract(pure=true) net.kyori.adventure.text.Component label()
      The label for the input.
      Returns:
      the label component

    • labelFormat

      @Contract(pure=true) String labelFormat()
      The format for the label, which can be a translation key or a format string.

      Example: "%s: %s" or "options.generic_value"

      Returns:
      the label format

    • start

      @Contract(pure=true) float start()
      The start of the range.
      Returns:
      the start value

    • end

      @Contract(pure=true) float end()
      The end of the range.
      Returns:
      the end value

    • initial

      @Contract(pure=true) @Nullable Float initial()
      The initial value of the input, or null if not set.
      Returns:
      the initial value, or null

    • step

      @Contract(pure=true) @Positive @Nullable Float step()
      The step size for the input, or null if not set.
      Returns:
      the step size, or null