Package dev.itsharshxd.zentrix.api.scenario

Class ScenarioProfile.Builder

java.lang.Object

dev.itsharshxd.zentrix.api.scenario.ScenarioProfile.Builder

Enclosing class:

ScenarioProfile

public static final class ScenarioProfile.Builder
extends Object

Fluent builder for ScenarioProfile.

Method Summary

Modifier and Type	Method	Description
@NotNull ScenarioProfile.Builder	adminSet(@Nullable Collection<String> scenarioIds)	The scenarios an administrator chose, used by the administrator-set mode.
@NotNull ScenarioProfile.Builder	allowVoteChanges(boolean allowed)
@NotNull ScenarioProfile.Builder	announceVoteResults(boolean announce)
@NotNull ScenarioProfile.Builder	automaticCount(int count)	How many scenarios an automatic match draws.
@NotNull ScenarioProfile.Builder	automaticPool(@Nullable Collection<String> scenarioIds)	What an automatic match draws from; an empty list means every selectable scenario.
@NotNull ScenarioProfile.Builder	blockedGameTypes(@NotNull String scenarioId, @Nullable Collection<String> gameTypes)	The game-types.yml names one scenario is kept out of.
@NotNull ScenarioProfile	build()
@NotNull ScenarioProfile.Builder	closeVoteWhenEveryoneVoted(boolean close)
@NotNull ScenarioProfile.Builder	noVoteRule(@Nullable ScenarioNoVoteRule rule)
@NotNull ScenarioProfile.Builder	raw(@NotNull String path, @Nullable Object value)	One override at an explicit configuration path.
@NotNull ScenarioProfile.Builder	scenarioEnabled(@NotNull String scenarioId, boolean enabled)	Switches one scenario on or off for matches on this arena.
@NotNull ScenarioProfile.Builder	selectionMode(@Nullable ScenarioSelectionMode mode)	How matches on this arena pick their scenarios.
@NotNull ScenarioProfile.Builder	setting(@NotNull String scenarioId, @NotNull String key, @Nullable Object value)	One scenario setting's value, in the shape the setting declares.
@NotNull ScenarioProfile.Builder	tieRule(@Nullable ScenarioTieRule rule)
@NotNull ScenarioProfile.Builder	votesPerPlayer(int votes)
@NotNull ScenarioProfile.Builder	voteVisibility(@Nullable ScenarioVoteVisibility visibility)
@NotNull ScenarioProfile.Builder	voteWinnerCount(int winners)
@NotNull ScenarioProfile.Builder	votingDuration(int seconds)	How long a lobby votes, in seconds.
@NotNull ScenarioProfile.Builder	votingEligible(@Nullable Collection<String> scenarioIds)	Which scenarios may be voted for; an empty list means every eligible scenario.

Methods inherited from class java.lang.Object

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

Method Details

selectionMode

@NotNull
public @NotNull ScenarioProfile.Builder selectionMode(@Nullable
 @Nullable ScenarioSelectionMode mode)

How matches on this arena pick their scenarios.

adminSet

@NotNull
public @NotNull ScenarioProfile.Builder adminSet(@Nullable
 @Nullable Collection<String> scenarioIds)

The scenarios an administrator chose, used by the administrator-set mode.

automaticCount

@NotNull
public @NotNull ScenarioProfile.Builder automaticCount(int count)

How many scenarios an automatic match draws.

automaticPool

@NotNull
public @NotNull ScenarioProfile.Builder automaticPool(@Nullable
 @Nullable Collection<String> scenarioIds)

What an automatic match draws from; an empty list means every selectable scenario.

votingDuration

@NotNull
public @NotNull ScenarioProfile.Builder votingDuration(int seconds)

How long a lobby votes, in seconds.

votesPerPlayer

@NotNull
public @NotNull ScenarioProfile.Builder votesPerPlayer(int votes)

voteWinnerCount

@NotNull
public @NotNull ScenarioProfile.Builder voteWinnerCount(int winners)

allowVoteChanges

@NotNull
public @NotNull ScenarioProfile.Builder allowVoteChanges(boolean allowed)

voteVisibility

@NotNull
public @NotNull ScenarioProfile.Builder voteVisibility(@Nullable
 @Nullable ScenarioVoteVisibility visibility)

tieRule

@NotNull
public @NotNull ScenarioProfile.Builder tieRule(@Nullable
 @Nullable ScenarioTieRule rule)

noVoteRule

@NotNull
public @NotNull ScenarioProfile.Builder noVoteRule(@Nullable
 @Nullable ScenarioNoVoteRule rule)

votingEligible

@NotNull
public @NotNull ScenarioProfile.Builder votingEligible(@Nullable
 @Nullable Collection<String> scenarioIds)

Which scenarios may be voted for; an empty list means every eligible scenario.

closeVoteWhenEveryoneVoted

@NotNull
public @NotNull ScenarioProfile.Builder closeVoteWhenEveryoneVoted(boolean close)

announceVoteResults

@NotNull
public @NotNull ScenarioProfile.Builder announceVoteResults(boolean announce)

scenarioEnabled

@NotNull
public @NotNull ScenarioProfile.Builder scenarioEnabled(@NotNull
 @NotNull String scenarioId,
 boolean enabled)

Switches one scenario on or off for matches on this arena.

blockedGameTypes

@NotNull
public @NotNull ScenarioProfile.Builder blockedGameTypes(@NotNull
 @NotNull String scenarioId,
 @Nullable
 @Nullable Collection<String> gameTypes)

The game-types.yml names one scenario is kept out of.

setting

@NotNull
public @NotNull ScenarioProfile.Builder setting(@NotNull
 @NotNull String scenarioId,
 @NotNull
 @NotNull String key,
 @Nullable
 @Nullable Object value)

One scenario setting's value, in the shape the setting declares.

raw

@NotNull
public @NotNull ScenarioProfile.Builder raw(@NotNull
 @NotNull String path,
 @Nullable
 @Nullable Object value)

One override at an explicit configuration path.

The escape hatch for anything the typed methods do not cover, and the natural way to copy a profile out of an addon's own YAML file. A null value removes the override.

build

@NotNull
public @NotNull ScenarioProfile build()