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

Interface DialogListType

All Superinterfaces:
DialogType
@NonExtendable public non-sealed interface DialogListType extends DialogType
Represents a dialog that displays a list of dialogs.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    DialogListType.Builder
    A builder for creating a dialog list type.

  • Method Summary

    Modifier and Type
    Method
    Description
    @org.jetbrains.annotations.Range(from=1L, to=1024L) int
    buttonWidth()
    Returns the width of each button in the dialog list.
    @org.checkerframework.checker.index.qual.Positive int
    columns()
    Returns the number of columns to display in the dialog list.
    RegistrySet<Dialog>
    dialogs()
    Returns the set of dialogs to display in the dialog list.
    @Nullable ActionButton
    exitAction()
    Returns the action button to exit the dialog, or null if there is no exit action.

  • Method Details

    • dialogs

      @Contract(pure=true) RegistrySet<Dialog> dialogs()
      Returns the set of dialogs to display in the dialog list.
      Returns:
      the set of dialogs

    • exitAction

      @Contract(pure=true) @Nullable ActionButton exitAction()
      Returns the action button to exit the dialog, or null if there is no exit action.
      Returns:
      the exit action button, or null

    • columns

      @Contract(pure=true) @org.checkerframework.checker.index.qual.Positive int columns()
      Returns the number of columns to display in the dialog list.
      Returns:
      the number of columns

    • buttonWidth

      @Contract(pure=true) @org.jetbrains.annotations.Range(from=1L, to=1024L) int buttonWidth()
      Returns the width of each button in the dialog list.
      Returns:
      the width of the buttons