Package dev.itsharshxd.zentrix.api.events.scenario

Class ScenarioSelectionLockEvent

java.lang.Object

org.bukkit.event.Event

dev.itsharshxd.zentrix.api.events.ZentrixEvent

dev.itsharshxd.zentrix.api.events.ZentrixGameEvent

dev.itsharshxd.zentrix.api.events.scenario.ScenarioSelectionLockEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public final class ScenarioSelectionLockEvent
extends ZentrixGameEvent
implements org.bukkit.event.Cancellable

A match is about to lock its scenarios in.

This is the last moment the set can be changed. Listeners may add or remove IDs through getScenarioIds(); Zentrix validates whatever is left, so a change that breaks a dependency or introduces a conflict is corrected rather than honoured blindly.

Cancelling makes the match run no scenarios at all. It never stops the match itself.

Since:

1.6.0

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
ScenarioSelectionLockEvent(@NotNull ZentrixGame game, @NotNull ScenarioSelection proposed)

Method Summary

Modifier and Type	Method	Description
void	add(@NotNull String scenarioId)	Adds a scenario to the set.
static @NotNull org.bukkit.event.HandlerList	getHandlerList()
@NotNull org.bukkit.event.HandlerList	getHandlers()	Gets the handler list for this event.
@NotNull ScenarioSelection	getProposed()	The selection Zentrix arrived at, before any listener changed it.
@NotNull List<String>	getScenarioIds()	The mutable set that will be locked in, subject to validation.
boolean	isCancelled()
boolean	remove(@NotNull String scenarioId)	Removes a scenario from the set.
void	setCancelled(boolean cancelled)

Methods inherited from class dev.itsharshxd.zentrix.api.events.ZentrixGameEvent

getArenaName, getGame, getGameId, getGameState, getGameTypeName, getPlayerCount, getRuntimeId, getSourceArenaName

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

ScenarioSelectionLockEvent

public ScenarioSelectionLockEvent(@NotNull
 @NotNull ZentrixGame game,
 @NotNull
 @NotNull ScenarioSelection proposed)

Method Details

getProposed

@NotNull
public @NotNull ScenarioSelection getProposed()

The selection Zentrix arrived at, before any listener changed it.

getScenarioIds

@NotNull
public @NotNull List<String> getScenarioIds()

The mutable set that will be locked in, subject to validation.

add

public void add(@NotNull
 @NotNull String scenarioId)

Adds a scenario to the set.

remove

public boolean remove(@NotNull
 @NotNull String scenarioId)

Removes a scenario from the set.

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

setCancelled

public void setCancelled(boolean cancelled)

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

getHandlers

@NotNull
public @NotNull org.bukkit.event.HandlerList getHandlers()

Description copied from class: ZentrixGameEvent

Gets the handler list for this event.

Overrides:

getHandlers in class ZentrixGameEvent

Returns:

The handler list

getHandlerList

@NotNull
public static @NotNull org.bukkit.event.HandlerList getHandlerList()