MagmaCore/com.magmaguy.magmacore.match/Match

Match

public abstract class Match

Base class for every match. The lifecycle lives here; subclasses add game logic through the protected hooks. Call open once the subclass is fully constructed.

Constructors

Match

protected void Match(MatchSettings settings)

Properties

outcome

public MatchOutcome outcome

phase

public MatchPhase phase

runtimeId

public final UUID runtimeId

settings

public final MatchSettings settings

startingRoster

public final Set<UUID> startingRoster

Functions

abortAdmission

protected void abortAdmission()

Releases a reservation when admission could not finish.

acceptsPlayers

protected boolean acceptsPlayers()

Whether the match takes players right now, on top of the core's own checks.

acceptsSpectator

protected boolean acceptsSpectator(Player player)

Whether an outsider may join as a spectator.

admit

public final AdmissionResult admit(Collection<? extends Player> players)

Admits the players together or not at all.

public final AdmissionResult admit(Collection<? extends Player> players, BooleanSupplier stillAuthorized)

As admit, rechecking stillAuthorized around the cancellable callbacks so an external reservation, such as a party ready check, can withdraw admission.

admitSpectator

public final AdmissionResult admitSpectator(Player player)

Admits an outsider as a spectator at the start location, in spectator mode.

contains

public final boolean contains(Location location)

createPlayer

protected MatchPlayer createPlayer(Player player)

destroy

public final void destroy()

Removes every participant and tears the space down.

destroyForShutdown

public final void destroyForShutdown()

Destroys the match because its plugin or the server is stopping.

end

public final void end(MatchOutcome outcome)

Ends the match once.

entryDestination

protected Location entryDestination(MatchPlayer player)

exitDestination

protected Location exitDestination(MatchPlayer player)

Settings exit, else where the player came from, else the main world spawn.

getActivePlayers

public final List<MatchPlayer> getActivePlayers()

getMatchPlayer

public final MatchPlayer getMatchPlayer(Player player)

This match's participant for the player, or null.

getMatchPlayers

public final List<MatchPlayer> getMatchPlayers()

getOutcome

public final MatchOutcome getOutcome()

getPhase

public final MatchPhase getPhase()

getRuntimeId

public UUID getRuntimeId()

getSettings

public final MatchSettings getSettings()

getStartingRoster

public final Set<UUID> getStartingRoster()

The active players when the match went ongoing.

handleDeath

protected final void handleDeath(Player player)

Treats the player as killed: the same handling lethal damage gets.

hasJoinPermission

protected boolean hasJoinPermission(Player player)

Whether this player may join past requiredPermission; hosts can add their own exemptions.

intruderDestination

protected Location intruderDestination(Player player)

Where non-participants found inside a running match are sent.

isDestroyed

public final boolean isDestroyed()

isOpen

public final boolean isOpen()

leave

public final boolean leave(Player player, LeaveReason reason)

Removes a participant.

moveParticipant

public final boolean moveParticipant(Player player, Location destination)

Moves one of this match's players anywhere inside its space, across its worlds.

onAdmissionRolledBack

protected void onAdmissionRolledBack(MatchPlayer player)

Admission failed after this player was created; undo anything createPlayer recorded.

onDeath

protected void onDeath(MatchPlayer player)

onDestroy

protected void onDestroy()

Runs once, after every participant has left and before the space is torn down, so what the plugin placed inside temporary worlds can still be removed from them.

onEnd

protected void onEnd(MatchOutcome outcome)

onJoin

protected void onJoin(MatchPlayer player)

onLeave

protected void onLeave(MatchPlayer player, LeaveReason reason)

Runs while the player is still a participant and the match state is intact.

onReset

protected void onReset()

A reusable match finished a run and is waiting again.

onRevive

protected void onRevive(MatchPlayer player)

A spectating player was revived and is active again.

onSpectating

protected void onSpectating(MatchPlayer player)

The death policy turned an active player into a spectator.

onStart

protected void onStart()

open

public final boolean open()

Registers the match after asking the plugin API.

releaseReviveBanner

protected final boolean releaseReviveBanner(Player dead, boolean revive)

Clears the dead player's revive banner, reviving them when revive is true.

requestEnd

protected void requestEnd(MatchOutcome outcome)

Every ending the core decides on its own goes through here: defeat when the last active player leaves or dies, a neutral end when a countdown loses its minimum.

requiredPermission

protected String requiredPermission()

The permission players need to join; spectators do not need it.

reserveAdmission

protected boolean reserveAdmission()

Taken after every admission check passes, before anyone is registered.

retire

public final void retire()

Destroys the match for good, reusable or not.

scheduleDestroy

protected final void scheduleDestroy(long ticks)

Destroys the match after ticks, replacing any destroy already scheduled.