net.caseif.flint.challenger

Interface Challenger

All Superinterfaces:

Component<Round>, MetadataHolder

public interface Challenger
extends MetadataHolder, Component<Round>

Represents a player actively in a minigame Round backed by Flint.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Gets the username of this Challenger.
Round	getRound() Gets the Round this Challenger is owned by.
com.google.common.base.Optional<Team>	getTeam() Gets the Team this challenger belongs to.
java.util.UUID	getUniqueId() Gets the unique ID of this Challenger.
boolean	isSpectating() Returns whether this Challenger is currently spectating.
void	removeFromRound() Removes this Challenger from its current Round.
void	setSpectating(boolean spectating) Sets whether this Challenger is currently spectating.
void	setTeam(Team team) Sets the Team this challenger belongs to.

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

getMetadata

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

getOwner

Method Detail

getRound

Round getRound()
        throws OrphanedComponentException

Gets the Round this Challenger is owned by.

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

Returns:

The Round this Challenger is owned by

Throws:

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

Since:

1.0

getName

java.lang.String getName()
                  throws OrphanedComponentException

Gets the username of this Challenger.

Returns:

The username of this Challenger

Throws:

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

Since:

1.0

getUniqueId

java.util.UUID getUniqueId()
                    throws OrphanedComponentException

Gets the unique ID of this Challenger.

Returns:

The unique ID of this Challenger

Throws:

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

Since:

1.0

removeFromRound

void removeFromRound()
              throws OrphanedComponentException

Removes this Challenger from its current Round.

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

Throws:

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

Since:

1.0

getTeam

com.google.common.base.Optional<Team> getTeam()
                                       throws OrphanedComponentException

Gets the Team this challenger belongs to.

Returns:

The Team this challenger belongs to

Throws:

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

Since:

1.0

setTeam

void setTeam(Team team)
      throws java.lang.IllegalArgumentException,
             OrphanedComponentException

Sets the Team this challenger belongs to.

Parameters:

team - The Team the challenger will be moved to

Throws:

java.lang.IllegalArgumentException - If the provided Team does not belong to this challenger's Round

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

Since:

1.1

isSpectating

boolean isSpectating()
              throws OrphanedComponentException

Returns whether this Challenger is currently spectating.

Spectators are not visible to others and may not interact with the Round they are contained by.

Returns:

Whether this Challenger is currently spectating

Throws:

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

Since:

1.0

setSpectating

void setSpectating(boolean spectating)
            throws OrphanedComponentException

Sets whether this Challenger is currently spectating.

Spectators are not visible to others and may not interact with the Round they are contained by.

Parameters:

spectating - Whether this Challenger is currently spectating

Throws:

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

Since:

1.0