Package dev.itsharshxd.zentrix.api.scenario.hook

Class GameplayHooks.DeathmatchDestinationRequest

java.lang.Object

dev.itsharshxd.zentrix.api.scenario.hook.GameplayHooks.DeathmatchDestinationRequest

Enclosing class:

GameplayHooks

public static final class GameplayHooks.DeathmatchDestinationRequest
extends Object

The deathmatch Zentrix is about to start, described as it would run it on its own.

Everything here is the configured deathmatch as it stands, which is what a scenario needs in order to reproduce it somewhere else: remap the bounds and the spawns into its own world, hand back a DeathmatchDestination, and the rest of the deathmatch runs unchanged.

Since:

1.6.0

Constructor Summary

Constructors

Constructor	Description
DeathmatchDestinationRequest(@NotNull String templateWorldName, @NotNull String spawnType, @Nullable org.bukkit.Location borderCorner1, @Nullable org.bukkit.Location borderCorner2, @NotNull Collection<org.bukkit.Location> configuredSpawns, int participantCount)

Method Summary

Modifier and Type	Method	Description
@NotNull Optional<org.bukkit.Location>	borderCorner1()	One configured corner of the deathmatch border, in template-world coordinates.
@NotNull Optional<org.bukkit.Location>	borderCorner2()	The opposite configured corner, in template-world coordinates.
@NotNull List<org.bukkit.Location>	configuredSpawns()	The configured custom spawns, in template-world coordinates; empty for random spawns.
int	participantCount()	How many players are about to be moved into the deathmatch.
@NotNull String	spawnType()	How the configuration places players: RANDOM or CUSTOM.
@NotNull String	templateWorldName()	The template world Zentrix would copy.

Methods inherited from class java.lang.Object

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

Constructor Details

DeathmatchDestinationRequest

public DeathmatchDestinationRequest(@NotNull
 @NotNull String templateWorldName,
 @NotNull
 @NotNull String spawnType,
 @Nullable
 @Nullable org.bukkit.Location borderCorner1,
 @Nullable
 @Nullable org.bukkit.Location borderCorner2,
 @NotNull
 @NotNull Collection<org.bukkit.Location> configuredSpawns,
 int participantCount)

Method Details

templateWorldName

@NotNull
public @NotNull String templateWorldName()

The template world Zentrix would copy.

spawnType

@NotNull
public @NotNull String spawnType()

How the configuration places players: RANDOM or CUSTOM.

borderCorner1

@NotNull
public @NotNull Optional<org.bukkit.Location> borderCorner1()

One configured corner of the deathmatch border, in template-world coordinates.

Empty when the deathmatch is configured without bounds, in which case a destination that wants a border has to decide on one itself.

borderCorner2

@NotNull
public @NotNull Optional<org.bukkit.Location> borderCorner2()

The opposite configured corner, in template-world coordinates.

configuredSpawns

@NotNull
public @NotNull List<org.bukkit.Location> configuredSpawns()

The configured custom spawns, in template-world coordinates; empty for random spawns.

participantCount

public int participantCount()

How many players are about to be moved into the deathmatch.