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

Interface BooleanDialogInput

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

Created via DialogInput.bool(String, Component, boolean, String, String)

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    BooleanDialogInput.Builder
    A builder for a boolean dialog input.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    initial()
    The initial value of the input.
    Component
    label()
    The label for the input.
    String
    onFalse()
    The input's value in a template when the value is false.
    String
    onTrue()
    The input's value in a template when the value is true.

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

    key

  • Method Details

    • label

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

    • initial

      @Contract(pure=true) boolean initial()
      The initial value of the input.
      Returns:
      true if the input is initially true, false otherwise

    • onTrue

      @Contract(pure=true) String onTrue()
      The input's value in a template when the value is true.
      Returns:
      the string to use when the input is true

    • onFalse

      @Contract(pure=true) String onFalse()
      The input's value in a template when the value is false.
      Returns:
      the string to use when the input is false