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

Interface TextDialogInput

All Superinterfaces:
DialogInput
@NonExtendable public non-sealed interface TextDialogInput extends DialogInput
A text dialog input.

Created via DialogInput.text(String, int, Component, boolean, String, int, MultilineOptions)

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    TextDialogInput.Builder
    A builder for a text dialog input.
    static interface 
    TextDialogInput.MultilineOptions
    Represents the multiline options for a text dialog input.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    initial()
    The initial value of the input.
    net.kyori.adventure.text.Component
    label()
    The label for the input.
    boolean
    labelVisible()
    Whether the label should be visible.
    @org.checkerframework.checker.index.qual.Positive int
    maxLength()
    The format for the label (a translation key or format string).
    @Nullable TextDialogInput.MultilineOptions
    multiline()
    The multiline options 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 of the input

    • label

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

    • labelVisible

      @Contract(pure=true) boolean labelVisible()
      Whether the label should be visible.
      Returns:
      true if the label is visible, false otherwise

    • initial

      @Contract(pure=true) String initial()
      The initial value of the input.
      Returns:
      the initial text

    • maxLength

      @Contract(pure=true) @org.checkerframework.checker.index.qual.Positive int maxLength()
      The format for the label (a translation key or format string).
      Returns:
      the label format

    • multiline

      @Contract(pure=true) @Nullable TextDialogInput.MultilineOptions multiline()
      The multiline options for the input, or null if not set.
      Returns:
      the multiline options