Package net.blueva.arcade.api.team
Interface TeamsAPI<P,M>
public interface TeamsAPI<P,M>
API for team-based game sessions.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanassignPlayer(P player, String teamId) Assign a player to a specific team.booleanautoAssignPlayer(P player) Assign a player to the best available team automatically.voidclear()Clear all teams for the current session.Resolve a team by its id.intgetTeams()intbooleanvoidremovePlayer(P player) Remove a player from their current team.voidsetWinningTeam(String teamId) Mark the winning team for summaries.voidsetWinningTeams(List<String> teamIds) Mark multiple winning teams (ties) for summaries.
-
Method Details
-
isEnabled
boolean isEnabled()- Returns:
trueif the current game session uses teams.
-
getTeamCount
int getTeamCount()- Returns:
- number of teams configured for the current game.
-
getTeamSize
int getTeamSize()- Returns:
- max size per team.
-
getTeams
- Returns:
- all available teams.
-
getTeam
Resolve a team by its id.- Parameters:
teamId- Team identifier- Returns:
- team info or
nullif not found
-
getTeam
- Parameters:
player- player to check- Returns:
- team info or
nullif the player is not assigned
-
assignPlayer
Assign a player to a specific team.- Parameters:
player- player to assignteamId- team identifier- Returns:
trueif the assignment succeeded
-
autoAssignPlayer
Assign a player to the best available team automatically.- Parameters:
player- player to assign- Returns:
trueif the assignment succeeded
-
removePlayer
Remove a player from their current team.- Parameters:
player- player to remove
-
clear
void clear()Clear all teams for the current session. -
setWinningTeam
Mark the winning team for summaries.- Parameters:
teamId- team identifier
-
setWinningTeams
Mark multiple winning teams (ties) for summaries.- Parameters:
teamIds- team identifiers
-
getWinningTeams
- Returns:
- list of winning teams for the current session.
-