net.caseif.flint.round

Interface Round

All Superinterfaces:

Component<Arena>, ComponentOwner, MetadataHolder

public interface Round
extends MetadataHolder, ComponentOwner, Component<Arena>

Represents an active minigame Round backed by Flint.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Challenger	_INVALID_addChallenger(UUID uuid) Deprecated. Violates basic principle of exceptions - use addChallenger(UUID)
JoinResult	addChallenger(UUID uuid) Adds the player by the given UUID to this Round.
void	broadcast(String message) Broadcasts the string message to all Challengers in this Round.
Team	createTeam(String id) Creates a Team in this Round with the given identifer.
void	end() Ends this Round by resetting its timer, removing all Challengers and returning them to their original locations, and rolling back its arena.
void	end(boolean rollback) Ends this Round by resetting its timer, removing all Challengers and returning them to thieir original locations, and, if rollback is true, rolling back its arena.
Arena	getArena() Gets the Arena this Round is owned by.
Optional<Challenger>	getChallenger(UUID uuid) Gets the Challenger from this Round with the given UUID.
ImmutableList<Challenger>	getChallengers() Returns an ImmutableList of Challengers in this Round.
<T> T	getConfigValue(RoundConfigNode<T> node) Gets the value of the given RoundConfigNode for this Round, or the server value if it is not set.
LifecycleStage	getLifecycleStage() Gets this Round's current LifecycleStage.
LifecycleStage	getLifecycleStage(int index) Gets the LifecycleStage at the given index for this Round.
Optional<LifecycleStage>	getLifecycleStage(String id) Gets the LifecycleStage by the given ID in this Round.
ImmutableSet<LifecycleStage>	getLifecycleStages() Gets an immutable ImmutableSet of this Round's defined lifecycle stages.
Optional<LifecycleStage>	getNextLifecycleStage() Gets this Round's next LifecycleStage, if applicable.
Team	getOrCreateTeam(String id) Gets the Team from this Round with the given identifer, or creates it if it does not already exist.
long	getRemainingTime() Gets the time in seconds until this Round is due to change its lifecycle stage.
ImmutableList<Challenger>	getSpectators() Returns the subset of Challengers in this Round who are marked as spectating.
Optional<Team>	getTeam(String id) Gets the Team from this Round with the given identifier.
ImmutableList<Team>	getTeams() Returns an ImmutableList of Teams in this Round.
long	getTime() Gets the current state of this Round's timer in seconds.
boolean	isEnding() Returns whether this Round is currently ending.
boolean	isTimerTicking() Returns whether this Round's timer is currently ticking.
void	nextLifecycleStage() Progresses this Round to its next LifecycleStage.
Location3D	nextSpawnPoint() Retrieves the next available spawn point.
void	removeChallenger(Challenger challenger) Removes the given Challenger from this Round, returning them to their original location before joining.
void	removeChallenger(UUID uuid) Removes the player by the given UUID from this Round.
void	removeTeam(String id) Removes the Team with the given identifier from this Round.
void	removeTeam(Team team) Removes the given Team from this Round.
void	resetTimer() Sets this Round's lifecycle stage to its initial state and resets and stops the timer.
<T> void	setConfigValue(RoundConfigNode<T> node, T value) Sets the value of the given RoundConfigNode for this Round.
void	setLifecycleStage(LifecycleStage stage) Sets this Round's current LifecycleStage.
void	setLifecycleStage(LifecycleStage stage, boolean resetTimer) Sets this Round's current LifecycleStage.
void	setTime(long time) Sets the current state of this Round's timer in seconds.
void	setTimerTicking(boolean ticking) Sets whether this Round's timer is currently ticking.

Methods inherited from interface net.caseif.flint.metadata.MetadataHolder

getMetadata

Methods inherited from interface net.caseif.flint.component.Component

getOwner

Method Detail

getArena

Arena getArena()
        throws OrphanedComponentException

Gets the Arena this Round is owned by.

Note: This a convenience method for Component.getOwner().

Returns:

The Arena this Round is owned by

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getChallengers

ImmutableList<Challenger> getChallengers()
                                  throws OrphanedComponentException

Returns an ImmutableList of Challengers in this Round.

Returns:

An ImmutableList of Challengers in this Round

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getChallenger

Optional<Challenger> getChallenger(UUID uuid)
                            throws OrphanedComponentException

Gets the Challenger from this Round with the given UUID.

Parameters:

uuid - The UUID to look up

Returns:

The Challenger from this Round with the given UUID.

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

_INVALID_addChallenger

@Deprecated
Challenger _INVALID_addChallenger(UUID uuid)
                                        throws RoundJoinException,
                                               OrphanedComponentException

Deprecated. Violates basic principle of exceptions - use addChallenger(UUID)

This method will not exist at runtime - do not use it!

Adds the player by the given UUID to this Round.

Parameters:

uuid - The unique ID of the player to add to this Round

Returns:

The newly created Challenger object

Throws:

IllegalStateException - If no spawn points are configured for this Round's Arena

RoundJoinException - If the player fails to be added to the Round for any given reason (obtainable through RoundJoinException.getReason())

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

addChallenger

JoinResult addChallenger(UUID uuid)
                  throws OrphanedComponentException

Adds the player by the given UUID to this Round.

Parameters:

uuid - The unique ID of the player to add to this Round

Returns:

The result of the join

Throws:

IllegalStateException - If no spawn points are configured for this Round's Arena

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.1

removeChallenger

void removeChallenger(UUID uuid)
               throws IllegalArgumentException,
                      OrphanedComponentException

Removes the player by the given UUID from this Round.

Note that this will orphan the Challenger object associated with the given UUID, causing all of its methods to throw OrphanedComponentExceptions.

Parameters:

uuid - The UUID of the player to remove

Throws:

IllegalArgumentException - If this Round does not contain a player by the given UUID

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

removeChallenger

void removeChallenger(Challenger challenger)
               throws IllegalArgumentException,
                      OrphanedComponentException

Removes the given Challenger from this Round, returning them to their original location before joining.

Note that this will orphan the passed Challenger object, causing all of its methods to throw OrphanedComponentExceptions.

Parameters:

challenger - The Challenger to remove

Throws:

IllegalArgumentException - If this Round is not the one containing challenger

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

nextSpawnPoint

Location3D nextSpawnPoint()

Retrieves the next available spawn point.

If the round's spawning mode is set to SpawningMode.RANDOM, a random point will be selected. Otherwise, if it is set to SpawningMode.SEQUENTIAL, the next point in sequence will be selected and the selection counter will be incremented.

Returns:

The next available spawn point.

Since:

1.1

getTeams

ImmutableList<Team> getTeams()
                      throws OrphanedComponentException

Returns an ImmutableList of Teams in this Round.

Returns:

An ImmutableList of Teams in this Round

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getTeam

Optional<Team> getTeam(String id)
                throws OrphanedComponentException

Gets the Team from this Round with the given identifier.

Parameters:

id - The identifier to look up

Returns:

The Team with the given identifier

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

createTeam

Team createTeam(String id)
         throws IllegalArgumentException,
                OrphanedComponentException

Creates a Team in this Round with the given identifer.

Parameters:

id - The identifier of the new Team

Returns:

The newly created Team.

Throws:

IllegalArgumentException - If a Team with the given identifer already exists

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getOrCreateTeam

Team getOrCreateTeam(String id)
              throws OrphanedComponentException

Gets the Team from this Round with the given identifer, or creates it if it does not already exist.

Parameters:

id - The identifier to look up

Returns:

The fetched or newly created Team.

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

removeTeam

void removeTeam(String id)
         throws IllegalArgumentException,
                OrphanedComponentException

Removes the Team with the given identifier from this Round.

Note that calling this method will orphan the Team object associated with the given ID, causing all of its methods to throw OrphanedComponentExceptions.

Parameters:

id - The identifier of the Team to remove

Throws:

IllegalArgumentException - If this Round does not contain a Team by the given ID

OrphanedComponentException

Since:

1.0

removeTeam

void removeTeam(Team team)
         throws IllegalArgumentException,
                OrphanedComponentException

Removes the given Team from this Round.

Note that calling this method will orphan the passed Team object, causing all of its methods to throw OrphanedComponentExceptions.

Parameters:

team - The Team to remove

Throws:

IllegalArgumentException - If the given Team object is parented by a different Round or has already been removed from this one

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getSpectators

ImmutableList<Challenger> getSpectators()
                                 throws OrphanedComponentException

Returns the subset of Challengers in this Round who are marked as spectating.

Returns:

The subset of Challengers in this Round who are marked as spectating

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

broadcast

void broadcast(String message)
        throws OrphanedComponentException

Broadcasts the string message to all Challengers in this Round.

Parameters:

message - The string to broadcast

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getLifecycleStages

ImmutableSet<LifecycleStage> getLifecycleStages()
                                         throws OrphanedComponentException

Gets an immutable ImmutableSet of this Round's defined lifecycle stages.

Returns:

This Round's defined lifecycle stages

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getLifecycleStage

LifecycleStage getLifecycleStage()
                          throws OrphanedComponentException

Gets this Round's current LifecycleStage.

Returns:

This Round's current LifecycleStage

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

setLifecycleStage

void setLifecycleStage(LifecycleStage stage,
                       boolean resetTimer)
                throws IllegalArgumentException,
                       OrphanedComponentException

Sets this Round's current LifecycleStage.

Parameters:

stage - The new LifecycleStage for the Round

resetTimer - Whether to reset the timer to 0 (defaults to false if omitted)

Throws:

IllegalArgumentException - If stage is not defined for this Round

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

setLifecycleStage

void setLifecycleStage(LifecycleStage stage)
                throws IllegalArgumentException,
                       OrphanedComponentException

Sets this Round's current LifecycleStage.

Note: Invocation of this method will not reset a round's numerical timer unless the boolean resetTimer parameter is provided.

Parameters:

stage - The new LifecycleStage for the Round

Throws:

IllegalArgumentException - If stage is not defined for this Round

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getLifecycleStage

Optional<LifecycleStage> getLifecycleStage(String id)
                                    throws OrphanedComponentException

Gets the LifecycleStage by the given ID in this Round.

Parameters:

id - The ID of the LifecycleStage to get

Returns:

The LifecycleStage by the given ID in this Round, or Optional.absent() if one does not exist

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getLifecycleStage

LifecycleStage getLifecycleStage(int index)
                          throws IndexOutOfBoundsException,
                                 OrphanedComponentException

Gets the LifecycleStage at the given index for this Round.

Parameters:

index - The index of the LifecycleStage to get

Returns:

The LifecycleStage at the given index

Throws:

IndexOutOfBoundsException - If index is greater than the highest defined index

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getNextLifecycleStage

Optional<LifecycleStage> getNextLifecycleStage()
                                        throws OrphanedComponentException

Gets this Round's next LifecycleStage, if applicable.

Returns:

This Round's next LifecycleStage, or Optional.absent() if the current stage is the final defined

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

nextLifecycleStage

void nextLifecycleStage()
                 throws IllegalStateException,
                        OrphanedComponentException

Progresses this Round to its next LifecycleStage.

Note: Unlike setLifecycleStage(LifecycleStage), invocation of this method will implicitly reset a round's numerical timer.

Throws:

IllegalStateException - If the current LifecycleStage is the last one defined

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getTime

long getTime()
      throws OrphanedComponentException

Gets the current state of this Round's timer in seconds.

Typically, this represents the time since its last lifecycle stage change, although this is not absolute.

Returns:

The current state of this Round's timer in seconds

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

setTime

void setTime(long time)
      throws OrphanedComponentException

Sets the current state of this Round's timer in seconds.

Parameters:

time - The current state of this Round's timer in seconds

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getRemainingTime

long getRemainingTime()
               throws OrphanedComponentException

Gets the time in seconds until this Round is due to change its lifecycle stage.

Returns:

The time in seconds until this Round is due to change its lifecycle stage, or -1 if the current stage is untimed

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

isTimerTicking

boolean isTimerTicking()
                throws OrphanedComponentException

Returns whether this Round's timer is currently ticking.

Returns:

Whether this Round's timer is currently ticking

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

setTimerTicking

void setTimerTicking(boolean ticking)
              throws OrphanedComponentException

Sets whether this Round's timer is currently ticking.

Parameters:

ticking - Whether this Round's timer is currently ticking

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

resetTimer

void resetTimer()
         throws OrphanedComponentException

Sets this Round's lifecycle stage to its initial state and resets and stops the timer.

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

end

void end()
  throws IllegalStateException,
         OrphanedComponentException

Ends this Round by resetting its timer, removing all Challengers and returning them to their original locations, and rolling back its arena.

Note that calling this method will orphan this Round object, causing all of its methods to throw OrphanedComponentExceptions.

Throws:

IllegalStateException - If an end method has already been called upon this Round

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

end

void end(boolean rollback)
  throws IllegalStateException,
         OrphanedComponentException

Ends this Round by resetting its timer, removing all Challengers and returning them to thieir original locations, and, if rollback is true, rolling back its arena.

Note that calling this method will orphan this Round object, causing all of its methods to throw OrphanedComponentExceptions.

Parameters:

rollback - Whether this Round's arena should be rolled back

Throws:

IllegalStateException - If an end method has already been called upon this Round

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

isEnding

boolean isEnding()
          throws OrphanedComponentException

Returns whether this Round is currently ending. This method returns true during and only during the period between the Round being requested to end, and the Round being fully ended and orphaned.

Returns:

Whether this Round is currently in the process of ending.

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.1

getConfigValue

<T> T getConfigValue(RoundConfigNode<T> node)
              throws OrphanedComponentException

Gets the value of the given RoundConfigNode for this Round, or the server value if it is not set.

Type Parameters:

T - The value type associated with node

Parameters:

node - The RoundConfigNode to look up

Returns:

The value associated with node

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

setConfigValue

<T> void setConfigValue(RoundConfigNode<T> node,
                        T value)
                 throws OrphanedComponentException

Sets the value of the given RoundConfigNode for this Round.

Type Parameters:

T - The value type associated with node

Parameters:

node - The RoundConfigNode to set

value - The new value associated with node

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0