Package wizardquest.entity

Interface PlayerInterface

All Superinterfaces:
EntityInterface
All Known Implementing Classes:
AbsolutePulseUnlockUpgrade, FireBallUnlockUpgrade, FireDamageResistanceUpgrade, PhysicalDamageResistanceUpgrade, Player, SlashUnlockUpgrade, ThunderDamageResistanceUpgrade, ThunderStormUnlockUpgrade, UpgradeBase, WaterDamageResistanceUpgrade, WaterJetUnlockUpgrade
public interface PlayerInterface extends EntityInterface

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    gainCoins(int amount)
    Increases a player's coin total by a given amount.
    void
    gainMagic(int amount)
    Increases a player's magic points by a given amount.
    int
    getCoins()
    Gets the amount of coins a player currently has.
    int
    getLives()
    Gets the remaining lives that a player has in a session.
    int
    getMagic()
    Gets the amount of magic points a player currently has.
    int
    getMagicRegenRate()
    Gets the rate at which a player's magic points regenerates between each stage.
    int
    getMaxMagic()
    Gets the maximum amount of magic points a player can have.
    List<UpgradeEnum>
    getUpgrades()
    List the upgrades that have been purchased between encounters by the player.
    void
    loseCoins(int amount)
    Decrements a player's coin total by a given amount.
    void
    loseLives(int amount)
    Decrements a player's remaining lives by a given amount.
    void
    loseMagic(int amount)
    Decrements a player's magic total by a given amount.
    void
    resetMagic()
    Resets the player's magic to 0.

    Methods inherited from interface wizardquest.entity.EntityInterface

    calcDamage, getAbilities, getHealth, getMaxHealth, getType, loseHealth, resetHealth

  • Method Details

    • getCoins

      int getCoins()
      Gets the amount of coins a player currently has.
      Returns:
      the player's current coin total.

    • loseCoins

      void loseCoins(int amount) throws IllegalArgumentException
      Decrements a player's coin total by a given amount.
      Parameters:
      amount - the total coins that the player will lose.
      Throws:
      IllegalArgumentException - if amount is not a non-negative number.

    • gainCoins

      void gainCoins(int amount) throws IllegalArgumentException
      Increases a player's coin total by a given amount.
      Parameters:
      amount - the total coins that the player will gain.
      Throws:
      IllegalArgumentException - if amount is not a non-negative number.

    • getMagic

      int getMagic()
      Gets the amount of magic points a player currently has.
      Returns:
      the player's current magic total.

    • getMaxMagic

      int getMaxMagic()
      Gets the maximum amount of magic points a player can have.
      Returns:
      the player's maximum magic total.

    • getMagicRegenRate

      int getMagicRegenRate()
      Gets the rate at which a player's magic points regenerates between each stage.
      Returns:
      the player's magic regeneration rate per stage.

    • gainMagic

      void gainMagic(int amount) throws IllegalArgumentException
      Increases a player's magic points by a given amount.
      Parameters:
      amount - the total magic points that the player will gain.
      Throws:
      IllegalArgumentException - if amount is not a non-negative number.

    • loseMagic

      void loseMagic(int amount) throws IllegalArgumentException
      Decrements a player's magic total by a given amount.
      Parameters:
      amount - the total magic points that the player will lose.
      Throws:
      IllegalArgumentException - if amount is not a non-negative number.

    • resetMagic

      void resetMagic()
      Resets the player's magic to 0.

    • getLives

      int getLives()
      Gets the remaining lives that a player has in a session.
      Returns:
      the player's total remaining lives.

    • loseLives

      void loseLives(int amount) throws IllegalArgumentException
      Decrements a player's remaining lives by a given amount.
      Parameters:
      amount - the total lives that the player will lose.
      Throws:
      IllegalArgumentException - if amount is not a non-negative number.

    • getUpgrades

      List<UpgradeEnum> getUpgrades()
      List the upgrades that have been purchased between encounters by the player.
      Returns:
      a list of purchased upgrades.