Package fr.royalpha.sheepwars.api

Class SheepWarsKit.SheepWarsKitLevel

  • All Implemented Interfaces:
    org.bukkit.event.Listener
    Enclosing class:
    SheepWarsKit
    public abstract static class SheepWarsKit.SheepWarsKitLevel
extends java.lang.Object
implements org.bukkit.event.Listener
    Used to create different levels for a kit.
    Example :
    • MoreSheep kit
      • Level 1 - gives you one more sheep
      • Level 2 - gives you two more sheep
      • Level 3 - gives you three more sheep
    Each class representing one level of a kit have to extend KitLevel.
    Author:
    Roytreo28

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private fr.royalpha.sheepwars.core.message.Message description  
      private int id  
      private fr.royalpha.sheepwars.core.message.Message name  
      private SheepWarsKit parentKit  
      private java.lang.String permission  
      private java.lang.Double price  
      private int wins  

    • Constructor Summary

      Constructors 
      Constructor Description
      SheepWarsKitLevel​(fr.royalpha.sheepwars.core.message.Message.Messages levelName, fr.royalpha.sheepwars.core.message.Message.Messages description, java.lang.String permission, double price, int requiredWins)  
      SheepWarsKitLevel​(fr.royalpha.sheepwars.core.message.Message.Messages description, java.lang.String permission, double price, int requiredWins)  
      SheepWarsKitLevel​(fr.royalpha.sheepwars.core.message.Message.Messages levelName, java.lang.String description, java.lang.String permission, double price, int requiredWins)  
      SheepWarsKitLevel​(fr.royalpha.sheepwars.core.message.Message levelName, fr.royalpha.sheepwars.core.message.Message description, java.lang.String permission, double price, int requiredWins)  
      SheepWarsKitLevel​(java.lang.String levelName, fr.royalpha.sheepwars.core.message.Message.Messages description, java.lang.String permission, double price, int requiredWins)  
      SheepWarsKitLevel​(java.lang.String description, java.lang.String permission, double price, int requiredWins)  
      SheepWarsKitLevel​(java.lang.String levelName, java.lang.String description, java.lang.String permission, double price, int requiredWins)  

    • Method Summary

      Modifier and Type Method Description
      java.util.List<SheepWarsKit.KitResult> canUseLevel​(org.bukkit.entity.Player player)  
      java.lang.String getDescription​(Language lang)  
      int getKitId()  
      int getLevelId()
      Get kit level.
      java.lang.String getName​(Language lang)  
      SheepWarsKit getParentKit()  
      java.lang.String getPermission()
      Get the permission needed to use this level if permissions are enabled in UltimateSheepWars's config file.
      org.bukkit.plugin.Plugin getPlugin()  
      java.lang.Double getPrice()
      Get the price of this level if ingame-shop is enabled in the UltimateSheepWars's config file.
      int getRequiredWins()
      Get the amount of required wins to use this level if required wins is enabled in the UltimateSheepWars's config file.
      abstract boolean onEquip​(org.bukkit.entity.Player player)
      Triggered when the game begins.
      private java.lang.String replaceAllPlaceholders​(java.lang.String input, Language lang)
      Used to replace %LEVEL_NAME% and %LEVEL_ID% by their respective values.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • id

        private int id

      • name

        private final fr.royalpha.sheepwars.core.message.Message name

      • description

        private final fr.royalpha.sheepwars.core.message.Message description

      • permission

        private final java.lang.String permission

      • price

        private java.lang.Double price

      • wins

        private int wins

    • Constructor Detail

      • SheepWarsKitLevel

        public SheepWarsKitLevel​(java.lang.String description,
                         java.lang.String permission,
                         double price,
                         int requiredWins)

      • SheepWarsKitLevel

        public SheepWarsKitLevel​(java.lang.String levelName,
                         java.lang.String description,
                         java.lang.String permission,
                         double price,
                         int requiredWins)

      • SheepWarsKitLevel

        public SheepWarsKitLevel​(java.lang.String levelName,
                         fr.royalpha.sheepwars.core.message.Message.Messages description,
                         java.lang.String permission,
                         double price,
                         int requiredWins)

      • SheepWarsKitLevel

        public SheepWarsKitLevel​(fr.royalpha.sheepwars.core.message.Message.Messages levelName,
                         java.lang.String description,
                         java.lang.String permission,
                         double price,
                         int requiredWins)

      • SheepWarsKitLevel

        public SheepWarsKitLevel​(fr.royalpha.sheepwars.core.message.Message.Messages description,
                         java.lang.String permission,
                         double price,
                         int requiredWins)

      • SheepWarsKitLevel

        public SheepWarsKitLevel​(fr.royalpha.sheepwars.core.message.Message.Messages levelName,
                         fr.royalpha.sheepwars.core.message.Message.Messages description,
                         java.lang.String permission,
                         double price,
                         int requiredWins)

      • SheepWarsKitLevel

        public SheepWarsKitLevel​(fr.royalpha.sheepwars.core.message.Message levelName,
                         fr.royalpha.sheepwars.core.message.Message description,
                         java.lang.String permission,
                         double price,
                         int requiredWins)

    • Method Detail

      • getDescription

        public java.lang.String getDescription​(Language lang)
        Returns:
        the level description according to the input (player's) language.

      • getName

        public java.lang.String getName​(Language lang)
        Returns:
        the level name according to the input (player's) language.

      • replaceAllPlaceholders

        private java.lang.String replaceAllPlaceholders​(java.lang.String input,
                                                Language lang)
        Used to replace %LEVEL_NAME% and %LEVEL_ID% by their respective values.

      • getParentKit

        public SheepWarsKit getParentKit()
        Returns:
        the parent kit

      • getPermission

        public java.lang.String getPermission()
        Get the permission needed to use this level if permissions are enabled in UltimateSheepWars's config file.

      • getRequiredWins

        public int getRequiredWins()
        Get the amount of required wins to use this level if required wins is enabled in the UltimateSheepWars's config file.

      • getKitId

        public int getKitId()
        Returns:
        parent kit's id

      • getPlugin

        public org.bukkit.plugin.Plugin getPlugin()
        Returns:
        parent kit's owning plugin

      • getPrice

        public java.lang.Double getPrice()
        Get the price of this level if ingame-shop is enabled in the UltimateSheepWars's config file.

      • getLevelId

        public int getLevelId()
        Get kit level.

      • onEquip

        public abstract boolean onEquip​(org.bukkit.entity.Player player)
        Triggered when the game begins.
        Parameters:
        player - Player who chose this kit.
        Returns:
        true if you want to let the plugin equiping all the default things to the player (leather armor, sword, bow, etc.). false if you want to set a special inventory content to the player.

      • canUseLevel

        public java.util.List<SheepWarsKit.KitResult> canUseLevel​(org.bukkit.entity.Player player)
        Returns:
        if a player can use this level of the kit.