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

Interface NumberRangeDialogInput.Builder

Enclosing interface:

NumberRangeDialogInput

@NonExtendable
public static interface NumberRangeDialogInput.Builder

A builder for creating instances of NumberRangeDialogInput.

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

Method Summary

Modifier and Type	Method	Description
NumberRangeDialogInput	build()	Builds the instance with the configured values.
NumberRangeDialogInput.Builder	initial(@Nullable Float initial)	Sets the initial value for the input.
NumberRangeDialogInput.Builder	labelFormat(String labelFormat)	Sets the format for the label.
NumberRangeDialogInput.Builder	step(@Positive @Nullable Float step)	Sets the step of the range.
NumberRangeDialogInput.Builder	width(@org.jetbrains.annotations.Range(from=1L, to=1024L) int width)	Sets the width of the input.

Method Details

width

@Contract(value="_ -> this",
          mutates="this")
NumberRangeDialogInput.Builder width(@org.jetbrains.annotations.Range(from=1L, to=1024L) int width)

Sets the width of the input.

Parameters:

width - the width

Returns:

this builder

labelFormat

@Contract(value="_ -> this",
          mutates="this")
NumberRangeDialogInput.Builder labelFormat(String labelFormat)

Sets the format for the label.

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

Parameters:

labelFormat - the label format

Returns:

this builder

initial

@Contract(value="_ -> this",
          pure=true)
NumberRangeDialogInput.Builder initial(@Nullable
 @Nullable Float initial)

Sets the initial value for the input.

Parameters:

initial - the initial value, or null if not set

Returns:

this builder

step

@Contract(value="_ -> this",
          pure=true)
NumberRangeDialogInput.Builder step(@Nullable
 @Positive @Nullable Float step)

Sets the step of the range.

Parameters:

step - the step size, or null if not set

Returns:

this builder

build

@Contract(pure=true,
          value="-> new")
NumberRangeDialogInput build()

Builds the instance with the configured values.

Returns:

a new instance