Package dev.itsharshxd.zentrix.api.scenario

Class ScenarioSetting.Builder

java.lang.Object

dev.itsharshxd.zentrix.api.scenario.ScenarioSetting.Builder

Enclosing class:

ScenarioSetting

public static final class ScenarioSetting.Builder
extends Object

Fluent builder for ScenarioSetting.

Method Summary

Modifier and Type	Method	Description
@NotNull ScenarioSetting.Builder	allowed(@NotNull String... values)	The accepted values of an ScenarioSettingType.ENUM setting.
@NotNull ScenarioSetting	build()
@NotNull ScenarioSetting.Builder	description(@NotNull String... lines)	The description lines shown in the management GUI.
@NotNull ScenarioSetting.Builder	displayName(@Nullable String displayName)	The label shown in the management GUI.
@NotNull ScenarioSetting.Builder	range(double minimum, double maximum)	Bounds for a numeric setting.
@NotNull ScenarioSetting.Builder	schema(@Nullable ScenarioEntrySchema entrySchema)	The shape of one entry, required by a ScenarioSettingType.STRUCTURED_LIST.

Methods inherited from class java.lang.Object

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

Method Details

range

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

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

allowed

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

The accepted values of an ScenarioSettingType.ENUM setting.

displayName

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

The label shown in the management GUI.

description

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

The description lines shown in the management GUI.

schema

@NotNull
public @NotNull ScenarioSetting.Builder schema(@Nullable
 @Nullable ScenarioEntrySchema entrySchema)

The shape of one entry, required by a ScenarioSettingType.STRUCTURED_LIST.

build

@NotNull
public @NotNull ScenarioSetting build()