Package com.olziedev.playerwarps.api.warp

Class WRate

java.lang.Object
com.olziedev.playerwarps.api.warp.WRate
public abstract class WRate extends Object
Represents warp rating that can provide and manage basic rating data for the warp.

  • Constructor Details

    • WRate

      public WRate()

  • Method Details

    • getRateAverage

      public abstract double getRateAverage()
      Returns:
      The average rates that the warp has.

    • getTotalRates

      public abstract int getTotalRates()
      Returns:
      The total amount of rates added up that the warp has.

    • getPlayersRatedAmount

      public abstract int getPlayersRatedAmount()
      Returns:
      The players amount that have rated the warp.

    • setWarpRate

      public abstract void setWarpRate(UUID rater, int rate, String description)
      This will set the warp rate for that rater.
      Parameters:
      rater - The rater that is rating this warp.
      rate - The amount the rater rated.
      description - The description of the rate.

    • getRateStars

      public abstract String getRateStars()
      Returns:
      The stars depending on the warps rate average.

    • getRates

      public abstract HashMap<UUID,WRate.RateEntry> getRates()
      Returns:
      The map of the all warp rates for this warp.

    • getEarnedRateRewards

      public abstract List<String> getEarnedRateRewards()
      Returns:
      The list of all the earned rate rewards for this warp.

    • setEarnedRateRewards

      public abstract void setEarnedRateRewards(List<String> earnedRateRewards)
      Modifies the list of all the earned rate rewards for this warp.
      Parameters:
      earnedRateRewards - List of all the earned rate rewards.