EliteMobs/com.magmaguy.elitemobs.advancedcombat.challenges/ClassChallengeInstance

ClassChallengeInstance

public final class ClassChallengeInstance extends MatchInstance implements Listener

One solo run borrowing a league's physical container, without its waves or rewards.

Inherited properties

cancelled

protected boolean cancelled

deathBanners

protected final HashMap<Block, InstanceDeathLocation> deathBanners

destroyingMatch

protected boolean destroyingMatch

exitLocation

protected Location exitLocation

instances

protected final static HashSet<MatchInstance> instances

lobbyLocation

protected Location lobbyLocation

maxPlayers

protected int maxPlayers

minPlayers

protected int minPlayers

outcome

public MatchOutcome outcome

participants

protected HashSet<Player> participants

permission

protected String permission

phase

public MatchPhase phase

playerLives

protected HashMap<Player, Integer> playerLives

players

protected HashSet<Player> players

previousPlayerLocations

protected final Map<Player, Location> previousPlayerLocations

runtimeId

public final UUID runtimeId

settings

public final MatchSettings settings

spectators

protected HashSet<Player> spectators

startingParticipantIds

protected final HashSet<UUID> startingParticipantIds

startingRoster

public final Set<UUID> startingRoster

startLocation

protected Location startLocation

state

protected MatchInstance.InstancedRegionState state

world

protected World world

Functions

abortAdmission

protected void abortAdmission()

admit

public static void admit(Player player, String formId, double quotedFee)

destroyMatch

protected void destroyMatch()

Removes everyone and returns the instance to WAITING.

endMatch

protected void endMatch()

fee

public static double fee(ClassFormDefinition form)

instructorDefeated

public void instructorDefeated(EliteMobDeathEvent event)

isAcceptingNewPlayers

public boolean isAcceptingNewPlayers()

The single admission predicate.

isAcceptingSpectator

protected boolean isAcceptingSpectator(Player player, boolean wasPlayer)

isInRegion

protected boolean isInRegion(Location location)

participantExitLocation

protected Location participantExitLocation(Player player)

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

protectBystanders

public void protectBystanders(PlayerDamagedByEliteMobEvent event)

protectTrial

public void protectTrial(EliteMobDamagedByPlayerEvent event)

reserveAdmission

protected boolean reserveAdmission()

runId

public UUID runId()

startMatch

protected void startMatch()

Inherited functions

acceptsPlayers

protected boolean acceptsPlayers()

acceptsSpectator

protected boolean acceptsSpectator(Player player)

addNewPlayer

public boolean addNewPlayer(Player player)

addSpectator

public void addSpectator(Player player, boolean wasPlayer)

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

admit

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

admitSpectator

public final AdmissionResult admitSpectator(Player player)

announce

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.

contains

public final boolean contains(Location location)

countdownMatch

public void countdownMatch()

createPlayer

protected MatchPlayer createPlayer(Player player)

defeat

protected void defeat()

destroy

public final void destroy()

destroyForShutdown

public final void destroyForShutdown()

end

public final void end(MatchOutcome outcome)

entryDestination

protected Location entryDestination(MatchPlayer participant)

protected Location entryDestination(MatchPlayer player)

exitDestination

protected Location exitDestination(MatchPlayer participant)

protected Location exitDestination(MatchPlayer player)

getActivePlayers

public final List<MatchPlayer> getActivePlayers()

getAnyPlayerInstance

public static MatchInstance getAnyPlayerInstance(Player player)

getDeathBanners

public HashMap<Block, InstanceDeathLocation> getDeathBanners()

getDeathLocationByPlayer

protected InstanceDeathLocation getDeathLocationByPlayer(Player player)

getMatchPlayer

public final MatchPlayer getMatchPlayer(Player player)

getMatchPlayers

public final List<MatchPlayer> getMatchPlayers()

getOutcome

public final MatchOutcome getOutcome()

getParticipants

public HashSet<Player> getParticipants()

getPermission

public String getPermission()

getPhase

public final MatchPhase getPhase()

getPlayerInstance

public static MatchInstance getPlayerInstance(Player player)

getPlayers

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.

getRuntimeId

public UUID getRuntimeId()

getSettings

public final MatchSettings getSettings()

getSpectatorInstance

public static MatchInstance getSpectatorInstance(Player player)

getStartingParticipantIds

public HashSet<UUID> getStartingParticipantIds()

getStartingRoster

public final Set<UUID> getStartingRoster()

getState

public MatchInstance.InstancedRegionState getState()

guardsEntryDuring

protected boolean guardsEntryDuring(MatchPhase phase)

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

handleDeath

protected final void handleDeath(Player player)

hasJoinPermission

protected boolean hasJoinPermission(Player player)

hasMatchDestroyEventFired

protected boolean hasMatchDestroyEventFired()

intruderDestination

protected Location intruderDestination(Player player)

isCancelled

public boolean isCancelled()

isDefunct

public boolean isDefunct()

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

isDestroyed

public final boolean isDestroyed()

isDestroyingMatch

public boolean isDestroyingMatch()

isOpen

public final boolean isOpen()

isSpectator

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.

leave

public final boolean leave(Player player, LeaveReason reason)

moveParticipant

public final boolean moveParticipant(Player player, Location destination)

onAdmissionRolledBack

protected void onAdmissionRolledBack(MatchPlayer participant)

protected void onAdmissionRolledBack(MatchPlayer player)

onDeath

protected void onDeath(MatchPlayer participant)

protected void onDeath(MatchPlayer player)

onDestroy

protected void onDestroy()

onEnd

protected void onEnd(MatchOutcome outcome)

onJoin

protected void onJoin(MatchPlayer player)

onLeave

protected void onLeave(MatchPlayer player, LeaveReason reason)

onReset

protected void onReset()

onRevive

protected void onRevive(MatchPlayer participant)

protected void onRevive(MatchPlayer player)

onSpectating

protected void onSpectating(MatchPlayer participant)

protected void onSpectating(MatchPlayer player)

onStart

protected void onStart()

open

public final boolean open()

playerDeath

public void playerDeath(Player player)

previousLocationOrExit

protected Location previousLocationOrExit(Player player)

releaseReviveBanner

protected final boolean releaseReviveBanner(Player dead, boolean revive)

removeAnyKind

public void removeAnyKind(Player player)

removePlayer

public void removePlayer(Player player)

removeSpectator

public void removeSpectator(Player player)

requestEnd

protected void requestEnd(MatchOutcome outcome)

Automatic endings go through the overridable methods EliteMobs subclasses intercept.

protected void requestEnd(MatchOutcome outcome)

requiredPermission

protected String requiredPermission()

retire

public final void retire()

retireInstance

protected final void retireInstance()

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

revivePlayer

public void revivePlayer(Player player, InstanceDeathLocation deathLocation)

scheduleDestroy

protected final void scheduleDestroy(long ticks)

shutdown

public static void shutdown()

spectatorDestination

protected Location spectatorDestination(MatchPlayer player)

start

public final StartResult start()

startDestination

protected Location startDestination()

victory

protected void victory()