Package me.gamercoder215.battlecards.api.card

Enum CardQuest

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable 
    
public enum CardQuest
extends Enum<CardQuest>

    Represents a Quest Road for a BattleCard

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Method Summary

      Modifier and Type Method Description
      final Integer getCurrentLevel(Card card) Fetches the latest quest level completed for a Card.
      final Double getProgressPercentage(Card card, Integer level) Fetches the current percentage progress of this Quest at a specific level, between 0.0 and 1.0 for the completion until the next level.
      final String getLocalizedProgress(Card card, Integer level) Fetches the localized progress of this Quest, formatted for the Card Menu.
      final Double getExperienceReward(Card card, Integer level) Fetches the card experience reward amount for this Quest.
      final Double getTotalExperience(Card card) Fetches the total amount of experience this quest can offer.
      final CardQuest valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<CardQuest> values() Returns an array containing the constants of this enum type, in the order they're declared.
      final Material getIcon() The icon for the Card Quest.
      final Integer getMaxLevel() The maximum level for this Card Achievement.

      • Methods inherited from class kotlin.Enum

        getName, getOrdinal

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getCurrentLevel

         final Integer getCurrentLevel(Card card)

        Fetches the latest quest level completed for a Card.

        Parameters:
        card - Card to Check

      • getProgressPercentage

         final Double getProgressPercentage(Card card, Integer level)

        Fetches the current percentage progress of this Quest at a specific level, between 0.0 and 1.0 for the completion until the next level.

        Parameters:
        card - Card to Check
        level - Current Quest Level of Card, defaults to getCurrentLevel + 1

      • getExperienceReward

         final Double getExperienceReward(Card card, Integer level)

        Fetches the card experience reward amount for this Quest. Experience Rewards can be Card-Specific and can factor in things like rarity.

        Parameters:
        card - Card to Use
        level - Level to Use, Defaults to Next Unlocked Level

      • getTotalExperience

         final Double getTotalExperience(Card card)

        Fetches the total amount of experience this quest can offer.

        Parameters:
        card - Card to Use

      • valueOf

         final CardQuest valueOf(String value)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

      • values

         final Array<CardQuest> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.

      • getIcon

         final Material getIcon()

        The icon for the Card Quest.