com.github.lazoyoung.craftgames.api.module

Interface TeamModule

public TeamModule

Constructor Detail

TeamModule

public TeamModule()

Method Detail

createTeam

@NotNull
org.bukkit.scoreboard.Team createTeam(@NotNull
                                                java.lang.String teamName,
                                                @NotNull
                                                org.bukkit.ChatColor color)

Create a new Team.

Parameters:

teamName - Name of the team.

color - ChatColor of the team and its nametag.

See Also:

Team

getScoreboard

@NotNull
org.bukkit.scoreboard.Scoreboard getScoreboard()

Returns:

The Scoreboard instance of this game.

getPlayerTeam

@Nullable
org.bukkit.scoreboard.Team getPlayerTeam(@NotNull
                                                    org.bukkit.entity.Player player)

Returns:

The Team where the given Player is associated at this moment. If the player hasn't joined any, this is null.

getPlayers

@NotNull
java.util.List<org.bukkit.entity.Player> getPlayers(@NotNull
                                                              org.bukkit.scoreboard.Team team)

Returns:

The List of Players associated in the given Team.

getTopPlayerScore

@NotNull
org.bukkit.scoreboard.Score getTopPlayerScore(@NotNull
                                                        org.bukkit.scoreboard.Objective objective)

Find which Player has the most Score compared to others.

Parameters:

objective - The objective of the scores to be compared.

Returns:

The Score of the top player.

See Also:

Player, Score

getTopTeams

@NotNull
java.util.List<org.bukkit.scoreboard.Team> getTopTeams(@NotNull
                                                                 org.bukkit.scoreboard.Objective objective)

Find which team(s) have the most Score compared to others.

Parameters:

objective - The objective of the scores to be compared.

Returns:

The top Teams.

See Also:

Score

getScoreTable

@NotNull
java.util.Map<org.bukkit.scoreboard.Team,java.lang.Integer> getScoreTable(@NotNull
                                                                                    org.bukkit.scoreboard.Objective objective)

Score table records the total score of each team.

Each entry of this Map is a pair of objects: Team (key) and score (value). Map entires are arranged into descending order, based on score. Thus, the team with the highest score is the first element.

Returns:

A Map storing each team's score.

See Also:

Map, Team, score, score

assignPlayer

void assignPlayer(@NotNull
                  org.bukkit.entity.Player player,
                  @NotNull
                  org.bukkit.scoreboard.Team team)

Assign player to team.

Player is automatically removed from the previous team if necessary.

See Also:

player, team

assignPlayers

void assignPlayers(int number,
                   @NotNull
                   org.bukkit.scoreboard.Team team)

A fixed number of players are drawn, excluding those who have a team. The selected players will be assigned to the Team.

Parameters:

number - The number of players to select.

team - The team where selected players should be assigned to.

See Also:

number, Team

assignPlayers

void assignPlayers(float ratio,
                   @NotNull
                   org.bukkit.scoreboard.Team team)

A set of players are drawn by ratio, excluding those who have a team. The selected players will be assigned to the Team.

Parameters:

ratio - The proportion among the players who don't have a team yet. (0.0 to 1.0)

team - The team where selected players should be assigned to.

See Also:

ratio, Team

setKit

void setKit(@NotNull
            org.bukkit.scoreboard.Team team,
            @NotNull
            java.lang.String... kits)

Assign kits to the team.

Parameters:

team - Team instance

kits - Array of Strings each representing the kit name

Throws:

IllegalArgumentException - is thrown if kits doesn't exist.

See Also:

kits, team

setSpawnpoint

@Deprecated
void setSpawnpoint(@NotNull
                                org.bukkit.scoreboard.Team team,
                                @NotNull
                                java.lang.String spawnTag)

Deprecated.

Set spawnpoint for the team.

Parameters:

team - The target Team.

spawnTag - Name of the coordinate tag which captures spawnpoints.

Throws:

IllegalArgumentException - is thrown if spawnTag is not in this game.

setSpawnpoint

void setSpawnpoint(@NotNull
                   org.bukkit.scoreboard.Team team,
                   @NotNull
                   CoordTag tag)

Set spawnpoint for the team.

Parameters:

team - The target Team.

tag - Coordinate tag which captures spawnpoints.

Throws:

IllegalArgumentException - is thrown if tag mode is neither TagMode.SPAWN nor TagMode.AREA.