Add: Added Missing Javadoc For Player.java.
This commit is contained in:
@@ -79,12 +79,40 @@ public class Player implements Serializable {
|
|||||||
case GATHERER -> gatherers.size();
|
case GATHERER -> gatherers.size();
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The current {@link BuildingCard Building Cards} in the player's deck.
|
||||||
|
*/
|
||||||
private final ArrayList<BuildingCard> buildingCards;
|
private final ArrayList<BuildingCard> buildingCards;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The current {@link Artist Artist} cards in the player's deck.
|
||||||
|
*/
|
||||||
private final ArrayList<Artist> artists;
|
private final ArrayList<Artist> artists;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The current {@link Builder Builder} cards in the player's deck.
|
||||||
|
*/
|
||||||
private final ArrayList<Builder> builders;
|
private final ArrayList<Builder> builders;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The current {@link Inventor Inventor} cards in the player's deck.
|
||||||
|
*/
|
||||||
private final ArrayList<Inventor> inventors;
|
private final ArrayList<Inventor> inventors;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The current {@link Gatherer Gatherer} cards in the player's deck.
|
||||||
|
*/
|
||||||
private final ArrayList<Gatherer> gatherers;
|
private final ArrayList<Gatherer> gatherers;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The current {@link Shaman Shaman} cards in the player's deck.
|
||||||
|
*/
|
||||||
private final ArrayList<Shaman> shamans;
|
private final ArrayList<Shaman> shamans;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The current {@link Hunter Hunter} cards in the player's deck.
|
||||||
|
*/
|
||||||
private final ArrayList<Hunter> hunters;
|
private final ArrayList<Hunter> hunters;
|
||||||
|
|
||||||
/** @return this player's building cards. */
|
/** @return this player's building cards. */
|
||||||
@@ -129,8 +157,6 @@ public class Player implements Serializable {
|
|||||||
return prestigeValue;
|
return prestigeValue;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds {@code value} amount of Food to the Player.
|
* Adds {@code value} amount of Food to the Player.
|
||||||
* @param value The amount of Food to be added. Should be non-negative.
|
* @param value The amount of Food to be added. Should be non-negative.
|
||||||
@@ -216,7 +242,6 @@ public class Player implements Serializable {
|
|||||||
this.totem = null;
|
this.totem = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks equality between this {@code Player} and another object.
|
* Checks equality between this {@code Player} and another object.
|
||||||
* Two players are equal if and only if they share the same {@code userName}.
|
* Two players are equal if and only if they share the same {@code userName}.
|
||||||
|
|||||||
Reference in New Issue
Block a user