EliteMobs/com.magmaguy.elitemobs.instanced/MatchInstance

MatchInstance

public abstract class MatchInstance extends Match

EliteMobs' instance API, running on MagmaCore's match core. The core owns admission, movement, rescue, death and teardown; this class keeps every member add-ons and EliteMobs' own subclasses use, mirroring the core's state into the familiar fields and firing EliteMobs' events at the moments they always fired.

Inheritors

ClassChallengeInstance

DungeonInstance

Constructors

public void MatchInstance(Location startLocation, Location exitLocation, int minPlayers, int maxPlayers)

Types

InstancedRegionState

public enum InstancedRegionState

MatchInstanceEvents

public class MatchInstanceEvents implements Listener

Kept so existing registrations compile.

Properties

protected boolean cancelled

protected final HashMap<Block, InstanceDeathLocation> deathBanners

destroyingMatch

protected boolean destroyingMatch

protected Location exitLocation

protected final static HashSet<MatchInstance> instances

protected Location lobbyLocation

protected int maxPlayers

protected int minPlayers

protected HashSet<Player> participants

protected String permission

protected HashMap<Player, Integer> playerLives

protected HashSet<Player> players

previousPlayerLocations

protected final Map<Player, Location> previousPlayerLocations

protected HashSet<Player> spectators

startingParticipantIds

protected final HashSet<UUID> startingParticipantIds

protected Location startLocation

protected MatchInstance.InstancedRegionState state

protected World world

Inherited properties

public MatchOutcome outcome

public MatchPhase phase

public final UUID runtimeId

public final MatchSettings settings

public final Set<UUID> startingRoster

Functions

protected boolean acceptsPlayers()

acceptsSpectator

protected boolean acceptsSpectator(Player player)

public boolean addNewPlayer(Player player)

public void addSpectator(Player player, boolean wasPlayer)

Spectating after death is the core's job; this admits outsiders who want to watch.

protected void announce(String message)

authorizesCombatTarget

public final boolean authorizesCombatTarget(Player player, Location targetLocation)

True only when both the active participant and a prospective combat target remain inside this ongoing instance.

cancelScheduledTasks

protected void cancelScheduledTasks()

Subclasses cancel their own tasks here; the match core owns the watchdog and countdown.

public void countdownMatch()

protected MatchPlayer createPlayer(Player player)

protected void defeat()

protected void destroyMatch()

Removes everyone and returns the instance to WAITING.

protected void endMatch()

entryDestination

protected Location entryDestination(MatchPlayer participant)

exitDestination

protected Location exitDestination(MatchPlayer participant)

getAnyPlayerInstance

public static MatchInstance getAnyPlayerInstance(Player player)

getDeathBanners

public HashMap<Block, InstanceDeathLocation> getDeathBanners()

getDeathLocationByPlayer

protected InstanceDeathLocation getDeathLocationByPlayer(Player player)

getParticipants

public HashSet<Player> getParticipants()

public String getPermission()

getPlayerInstance

public static MatchInstance getPlayerInstance(Player player)

public HashSet<Player> getPlayers()

getPreviousPlayerLocations

public Map<Player, Location> getPreviousPlayerLocations()

getRemainingLives

public Integer getRemainingLives(Player player)

Returns this participant's remaining dungeon/arena lives, or null when no counter is active.

getSpectatorInstance

public static MatchInstance getSpectatorInstance(Player player)

getStartingParticipantIds

public HashSet<UUID> getStartingParticipantIds()

public MatchInstance.InstancedRegionState getState()

guardsEntryDuring

protected boolean guardsEntryDuring(MatchPhase phase)

Whether non-participants are kept from teleporting into this instance during the phase.

hasJoinPermission

protected boolean hasJoinPermission(Player player)

hasMatchDestroyEventFired

protected boolean hasMatchDestroyEventFired()

intruderDestination

protected Location intruderDestination(Player player)

isAcceptingNewPlayers

public boolean isAcceptingNewPlayers()

The single admission predicate.

isAcceptingSpectator

protected boolean isAcceptingSpectator(Player player, boolean wasPlayer)

public boolean isCancelled()

public boolean isDefunct()

True when this match object is a corpse: cancelled at construction, or already evicted from instances.

isDestroyingMatch

public boolean isDestroyingMatch()

protected abstract boolean isInRegion(Location location)

public boolean isSpectator(Player player)

True for a player currently waiting in this match's spectator/downed state.

isWaitingPlayer

public final boolean isWaitingPlayer(Player player)

Admitted players whose entry task has reached the lobby, including the start countdown.

onAdmissionRolledBack

protected void onAdmissionRolledBack(MatchPlayer participant)

protected void onDeath(MatchPlayer participant)

protected void onReset()

protected void onRevive(MatchPlayer participant)

protected void onSpectating(MatchPlayer participant)

protected void onStart()

participantExitLocation

protected Location participantExitLocation(Player player)

Participant exits are independent of the boundary used to eject intruders.

public void playerDeath(Player player)

previousLocationOrExit

protected Location previousLocationOrExit(Player player)

public void removeAnyKind(Player player)

public void removePlayer(Player player)

removeSpectator

public void removeSpectator(Player player)

protected void requestEnd(MatchOutcome outcome)

Automatic endings go through the overridable methods EliteMobs subclasses intercept.

requiredPermission

protected String requiredPermission()

protected final void retireInstance()

Takes the instance out of EliteMobs' registry and destroys its match for good.

public void revivePlayer(Player player, InstanceDeathLocation deathLocation)

public static void shutdown()

startDestination

protected Location startDestination()

protected void startMatch()

protected void victory()

Inherited functions

protected void abortAdmission()

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

public final AdmissionResult admitSpectator(Player player)

public final boolean contains(Location location)

public final void destroy()

destroyForShutdown

public final void destroyForShutdown()

public final void end(MatchOutcome outcome)

getActivePlayers

public final List<MatchPlayer> getActivePlayers()

public final MatchPlayer getMatchPlayer(Player player)

getMatchPlayers

public final List<MatchPlayer> getMatchPlayers()

public final MatchOutcome getOutcome()

public final MatchPhase getPhase()

public UUID getRuntimeId()

public final MatchSettings getSettings()

getStartingRoster

public final Set<UUID> getStartingRoster()

protected final void handleDeath(Player player)

public final boolean isDestroyed()

public final boolean isOpen()

public final boolean leave(Player player, LeaveReason reason)

moveParticipant

public final boolean moveParticipant(Player player, Location destination)

protected void onDestroy()

protected void onEnd(MatchOutcome outcome)

protected void onJoin(MatchPlayer player)

protected void onLeave(MatchPlayer player, LeaveReason reason)

public final boolean open()

releaseReviveBanner

protected final boolean releaseReviveBanner(Player dead, boolean revive)

reserveAdmission

protected boolean reserveAdmission()

public final void retire()

scheduleDestroy

protected final void scheduleDestroy(long ticks)

spectatorDestination

protected Location spectatorDestination(MatchPlayer player)

public final StartResult start()