Package dev.itsharshxd.zentrix.api.scenario

Class ScenarioEntryField.Builder

java.lang.Object

dev.itsharshxd.zentrix.api.scenario.ScenarioEntryField.Builder

Enclosing class:

ScenarioEntryField

public static final class ScenarioEntryField.Builder
extends Object

Fluent builder for ScenarioEntryField. Fields are required unless made optional.

Method Summary

Modifier and Type	Method	Description
@NotNull ScenarioEntryField.Builder	allowed(@NotNull String... values)	The accepted values of a ScenarioFieldType.ENUM field.
@NotNull ScenarioEntryField	build()
@NotNull ScenarioEntryField.Builder	description(@NotNull String... lines)	The description lines shown in the management GUI.
@NotNull ScenarioEntryField.Builder	displayName(@Nullable String displayName)	The label shown in the management GUI.
@NotNull ScenarioEntryField.Builder	optional(@NotNull Object defaultValue)	Makes the field optional, falling back to defaultValue when nothing is stored.
@NotNull ScenarioEntryField.Builder	range(double minimum, double maximum)	Bounds for a numeric field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

optional

@NotNull
public @NotNull ScenarioEntryField.Builder optional(@NotNull
 @NotNull Object defaultValue)

Makes the field optional, falling back to defaultValue when nothing is stored.

range

@NotNull
public @NotNull ScenarioEntryField.Builder range(double minimum,
 double maximum)

Bounds for a numeric field. Ignored by every other type.

allowed

@NotNull
public @NotNull ScenarioEntryField.Builder allowed(@NotNull
 @NotNull String... values)

The accepted values of a ScenarioFieldType.ENUM field.

displayName

@NotNull
public @NotNull ScenarioEntryField.Builder displayName(@Nullable
 @Nullable String displayName)

The label shown in the management GUI.

description

@NotNull
public @NotNull ScenarioEntryField.Builder description(@NotNull
 @NotNull String... lines)

The description lines shown in the management GUI.

build

@NotNull
public @NotNull ScenarioEntryField build()