diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order5.java b/src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order5.java index 0f5f5dc..364d1e6 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order5.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Orders/Order5.java @@ -7,11 +7,32 @@ import java.util.ArrayList; import java.util.NoSuchElementException; public class Order5 extends OrderLogicCard { + + /** + * Creates an Order5 logic card for a five-player game. + * + * @param players the list of players associated with this order card + * @throws NoSuchElementException if the number of players is not equal to 5 + */ public Order5(ArrayList players) throws NoSuchElementException{ if(players.size()!=5) throw new NoSuchElementException(); super(players); } + + /** + * Applies the effect associated with the specified position index for the given player. + * If {@code index == 0}, the player gains 3 Food and the building effect is applied. + * If {@code index == 1}, the player gains 1 Food and the building effect is applied. + * If {@code index == 2}, no effect is applied. + * If {@code index == 3}, no effect is applied. + * If {@code index == 4}, the player tries to remove 1 Food; if the removal succeeds, + * the player loses 2 Prestige. + * + * @param player the player to whom the effect is applied + * @param index the position index of the effect to apply + * @throws IndexOutOfBoundsException if {@code index < 0} or {@code index >= 5} + */ @Override protected void effect(Player player,int index) throws IndexOutOfBoundsException {