Add: Added Javadoc For "toStringBoard" Method And "icon" Field In Shaman.java.
This commit is contained in:
@@ -7,6 +7,14 @@ import it.polimi.ingsw.gc14.Model.Player;
|
||||
|
||||
public class Shaman extends Character {
|
||||
|
||||
|
||||
/**
|
||||
* The number of star {@code Icons} the card possesses.
|
||||
* During the {@link it.polimi.ingsw.gc14.Model.Cards.TribeCards.Events.ShamanicRitual Shamanic Ritual Event}, having the
|
||||
* majority of these icons provides Prestige Points;
|
||||
* having the minority, on the other hand, results in
|
||||
* losing Prestige Points.
|
||||
*/
|
||||
private int icon;
|
||||
|
||||
/**
|
||||
@@ -51,12 +59,22 @@ public class Shaman extends Character {
|
||||
public String toString() {
|
||||
return super.toString() + " *:" + String.valueOf(icon);
|
||||
}
|
||||
|
||||
/**
|
||||
* Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
|
||||
* toString to print a more detailed version.
|
||||
* <p>Includes:
|
||||
* <li>{@link #icon Number of stars}
|
||||
* </p>
|
||||
* @return {@code String} - a string representation of this {@code TribeCard}.
|
||||
* @see it.polimi.ingsw.gc14.Model.Cards.TribeCard TribeCard
|
||||
* @see it.polimi.ingsw.gc14.Model.Game Game
|
||||
*/
|
||||
@Override
|
||||
public String toStringBoard() {
|
||||
return super.toStringBoard() + " *:" + String.valueOf(icon);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Creates and returns a copy of this Shaman card.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user