Package com.cmiurca.saintseiyadeckbuilding.saintseiya

Class PlayMat

java.lang.Object
com.cmiurca.saintseiyadeckbuilding.saintseiya.PlayMat
public class PlayMat extends Object
PlayMat class, where the playmat is created
Since:
2023-02-04

  • Constructor Details

    • PlayMat

      public PlayMat(Card[] cardLocation, ArrayList<Card> commonDiscard, ArrayList<Card> cardReserve, Effect onGoingEffect, int flameOfTheClockRemaining, Game currentGame)
      Constructor for PlayMat class
      Parameters:
      cardLocation - card location of the playmat
      commonDiscard - common discard of the playmat
      cardReserve - card reserve of the playmat
      onGoingEffect - on going effect of the playmat
      flameOfTheClockRemaining - number of flameOfTheClock Remaining
      currentGame - current game

    • PlayMat

      public PlayMat(Game currentGame)
      Constructor for PlayMat class
      Parameters:
      currentGame - current game

  • Method Details

    • getCardLocation

      public Card[] getCardLocation()
      Getter for cardLocation
      Returns:
      Card[] cardLocation

    • getCardInLocationFromIndex

      public Card getCardInLocationFromIndex(int index)
      Getter for card in cardLocation at index
      Parameters:
      index - index of the card in cardLocation
      Returns:
      Card in cardLocation

    • removeCardFromLocationFromIndex

      public void removeCardFromLocationFromIndex(int index)
      Method to remove a card from cardLocation by index
      Parameters:
      index - index of the card in cardLocation

    • setCardLocation

      public void setCardLocation(Card[] cardLocation)
      Setter for cardLocation
      Parameters:
      cardLocation - card location of the playmat

    • getCommonDiscard

      public ArrayList<Card> getCommonDiscard()
      Getter for commonDiscard
      Returns:
      Card[] commonDiscard

    • setCommonDiscard

      public void setCommonDiscard(ArrayList<Card> commonDiscard)
      Setter for commonDiscard
      Parameters:
      commonDiscard - common discard of the playmat

    • getCardReserve

      public ArrayList<Card> getCardReserve()
      Getter for cardReserve
      Returns:
      Card[] cardReserve

    • setCardReserve

      public void setCardReserve(ArrayList<Card> cardReserve)
      Setter for cardReserve
      Parameters:
      cardReserve - card reserve of the playmat

    • getOnGoingEffect

      public Effect getOnGoingEffect()
      Getter for onGoingEffect
      Returns:
      Effect onGoingEffect

    • setOnGoingEffect

      public void setOnGoingEffect(Effect onGoingEffect)
      Setter for onGoingEffect
      Parameters:
      onGoingEffect - on going effect of the playmat

    • getFlameOfTheClockRemaining

      public int getFlameOfTheClockRemaining()
      Getter for flameOfTheClockRemaining
      Returns:
      int flameOfTheClockRemaining

    • setFlameOfTheClockRemaining

      public void setFlameOfTheClockRemaining(int flameOfTheClockRemaining)
      Setter for flameOfTheClockRemaining
      Parameters:
      flameOfTheClockRemaining - number of flameOfTheClock Remaining

    • getCurrentGame

      public Game getCurrentGame()
      Getter for currentGame
      Returns:
      Game currentGame

    • setCurrentGame

      public void setCurrentGame(Game currentGame)
      Setter for currentGame
      Parameters:
      currentGame - current game

    • addCardToLocation

      public void addCardToLocation(Card card, int location)
      Method to add a card to the card location
      Parameters:
      card - card to be added
      location - location of the card

    • addCardToCommonDiscard

      public void addCardToCommonDiscard(Card card)
      Method to add a card to the common discard
      Parameters:
      card - card to be added

    • addCardToCardReserve

      public void addCardToCardReserve(Card card)
      Method to add a card to the card reserve
      Parameters:
      card - card to be added

    • removeCardFromLocation

      public void removeCardFromLocation(int location)
      Method to remove a card from the card location
      Parameters:
      location - location of the card

    • removeCardFromCommonDiscard

      public void removeCardFromCommonDiscard(Card card)
      Method to remove a card from the common discard
      Parameters:
      card - card to be removed

    • removeCardFromCommonDiscard

      public void removeCardFromCommonDiscard(int id)
      Method to remove a card from common discard
      Parameters:
      id - of the card to be removed from the common discard

    • removeCardFromCardReserve

      public void removeCardFromCardReserve(Card card)
      Method to remove a card from the card reserve
      Parameters:
      card - card to be removed

    • removeFlameOfTheClock

      public void removeFlameOfTheClock(int amount, Game currentGame)
      Method to remove flame of the clock
      Parameters:
      amount - of flame of the clock to be removed
      currentGame - current game

    • addFlameOfTheClock

      public void addFlameOfTheClock(int amount)
      Method to add flame of the clock
      Parameters:
      amount - amount of flame of the clock to be added

    • isCardLocationEmpty

      public boolean isCardLocationEmpty(int location)
      Method to check if the card location is empty
      Parameters:
      location - location of the card
      Returns:
      boolean true if the card location is empty

    • isCommonDiscardEmpty

      public boolean isCommonDiscardEmpty()
      Method to check if the common discard is empty
      Returns:
      boolean true if the common discard is empty

    • isCardReserveEmpty

      public boolean isCardReserveEmpty()
      Method to check if the card reserve is empty
      Returns:
      boolean true if the card reserve is empty

    • isCardLocationFull

      public boolean isCardLocationFull(int location)
      Method to check if the card location is full
      Parameters:
      location - location of the card
      Returns:
      boolean true if the card location is full

    • isCommonDiscardFull

      public boolean isCommonDiscardFull()
      Method to check if the common discard is full
      Returns:
      boolean true if the common discard is full

    • isCardReserveFull

      public boolean isCardReserveFull()
      Method to check if the card reserve is full
      Returns:
      boolean true if the card reserve is full

    • toString

      public String toString()
      To string method
      Overrides:
      toString in class Object
      Returns:
      string representation of the play mat