Package dev.itsharshxd.zentrix.api.nether

Interface NetherService

public interface NetherService

Per-game Nether status and access control. Status queries read Bukkit world state and should run on the main thread. setAccess(dev.itsharshxd.zentrix.api.game.ZentrixGame, dev.itsharshxd.zentrix.api.nether.NetherToggleRequest) is safe to call from any thread and completes after the request is applied or queued.

Since:

1.3.0

Method Summary

Modifier and Type	Method	Description
@NotNull NetherStatus	getStatus(@NotNull ZentrixGame game)
@NotNull Optional<org.bukkit.World>	getWorld(@NotNull ZentrixGame game)
@NotNull Optional<String>	getWorldName(@NotNull ZentrixGame game)
default boolean	isAccessEnabled(@NotNull ZentrixGame game)
default boolean	isConfigured(@NotNull ZentrixGame game)
default boolean	isPrepared(@NotNull ZentrixGame game)
default boolean	isPreparing(@NotNull ZentrixGame game)
@NotNull CompletableFuture<NetherToggleResult>	setAccess(@NotNull ZentrixGame game, @NotNull NetherToggleRequest request)

Method Details

getStatus

@NotNull
@NotNull NetherStatus getStatus(@NotNull
 @NotNull ZentrixGame game)

getWorld

@NotNull
@NotNull Optional<org.bukkit.World> getWorld(@NotNull
 @NotNull ZentrixGame game)

getWorldName

@NotNull
@NotNull Optional<String> getWorldName(@NotNull
 @NotNull ZentrixGame game)

isConfigured

default boolean isConfigured(@NotNull
 @NotNull ZentrixGame game)

isPreparing

default boolean isPreparing(@NotNull
 @NotNull ZentrixGame game)

isPrepared

default boolean isPrepared(@NotNull
 @NotNull ZentrixGame game)

isAccessEnabled

default boolean isAccessEnabled(@NotNull
 @NotNull ZentrixGame game)

setAccess

@NotNull
@NotNull CompletableFuture<NetherToggleResult> setAccess(@NotNull
 @NotNull ZentrixGame game,
 @NotNull
 @NotNull NetherToggleRequest request)