Interface TeamsAPI<P,M>


public interface TeamsAPI<P,M>
API for team-based game sessions.
  • Method Details

    • isEnabled

      boolean isEnabled()
      Returns:
      true if 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

      List<TeamInfo<P,M>> getTeams()
      Returns:
      all available teams.
    • getTeam

      TeamInfo<P,M> getTeam(String teamId)
      Resolve a team by its id.
      Parameters:
      teamId - Team identifier
      Returns:
      team info or null if not found
    • getTeam

      TeamInfo<P,M> getTeam(P player)
      Parameters:
      player - player to check
      Returns:
      team info or null if the player is not assigned
    • assignPlayer

      boolean assignPlayer(P player, String teamId)
      Assign a player to a specific team.
      Parameters:
      player - player to assign
      teamId - team identifier
      Returns:
      true if the assignment succeeded
    • autoAssignPlayer

      boolean autoAssignPlayer(P player)
      Assign a player to the best available team automatically.
      Parameters:
      player - player to assign
      Returns:
      true if the assignment succeeded
    • removePlayer

      void removePlayer(P player)
      Remove a player from their current team.
      Parameters:
      player - player to remove
    • clear

      void clear()
      Clear all teams for the current session.
    • setWinningTeam

      void setWinningTeam(String teamId)
      Mark the winning team for summaries.
      Parameters:
      teamId - team identifier
    • setWinningTeams

      void setWinningTeams(List<String> teamIds)
      Mark multiple winning teams (ties) for summaries.
      Parameters:
      teamIds - team identifiers
    • getWinningTeams

      List<TeamInfo<P,M>> getWinningTeams()
      Returns:
      list of winning teams for the current session.