Package com.github.rumsfield.konquest.api.model

Interface KonquestUpgrade

public interface KonquestUpgrade
An upgrade for a town. Upgrades have a cost in favor, and a population requirement. Upgrades can have multiple levels.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Gets the description of this upgrade.
    org.bukkit.Material
    getIcon()
    Gets the material used for menu icons.
    String
    getLevelDescription(int level)
    Gets the level description, starting at 1.
    int
    getMaxLevel()
    Gets the maximum levels for this upgrade.

  • Method Details

    • getMaxLevel

      int getMaxLevel()
      Gets the maximum levels for this upgrade.
      Returns:
      The maximum levels

    • getIcon

      org.bukkit.Material getIcon()
      Gets the material used for menu icons.
      Returns:
      The material

    • getDescription

      String getDescription()
      Gets the description of this upgrade.
      Returns:
      The description

    • getLevelDescription

      String getLevelDescription(int level)
      Gets the level description, starting at 1. Level 0 returns empty string. Levels higher than the max level returns an empty string.
      Parameters:
      level - The level
      Returns:
      The level description