Package us.talabrek.ultimateskyblock.api.model

Interface IslandScore

public interface IslandScore
The summary of island calculation.
Since:
v2.1.2

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getScore()
    Returns the calculated score.
    int
    getSize()
    Returns the total size of the top-list.
    List<BlockScore>
    getTop(int num)
    Returns an ordered list of the BlockScore influencing the score-calculation.
    List<BlockScore>
    getTop(int offset, int num)
    Returns an ordered list of the BlockScore influencing the score-calculation.

  • Method Details

    • getScore

      double getScore()
      Returns the calculated score.
      Returns:
      the calculated score.
      Since:
      v2.1.2

    • getTop

      List<BlockScore> getTop(int num)
      Returns an ordered list of the BlockScore influencing the score-calculation.
      Parameters:
      num - The number of entries to return.
      Returns:
      an ordered list of the BlockScore influencing the score-calculation.
      Since:
      v2.1.2

    • getTop

      List<BlockScore> getTop(int offset, int num)
      Returns an ordered list of the BlockScore influencing the score-calculation.
      Parameters:
      offset - the offset (for paged queries).
      num - The number of entries to return.
      Returns:
      an ordered list of the BlockScore influencing the score-calculation.
      Since:
      v2.3-HF3

    • getSize

      int getSize()
      Returns the total size of the top-list.
      Returns:
      the total size of the top-list.
      Since:
      v2.3-HF3