PlayerControllerHuman: use translated MagicColor enum (Card-Forge#9224)

Hanmac · web-flow · commit 8b2532f0fcb5 · 2025-11-23T10:34:19.000+01:00
* PlayerControllerHuman: use translated MagicColor enum

* Desktop ListChooser: allow Icon for MagicColor
diff --git a/forge-ai/src/main/java/forge/ai/AiCostDecision.java b/forge-ai/src/main/java/forge/ai/AiCostDecision.java
@@ -4,7 +4,7 @@
 
 import forge.ai.AiCardMemory.MemorySet;
 import forge.card.CardType;
-import forge.card.MagicColor;
+import forge.card.ColorSet;
 import forge.game.Game;
 import forge.game.GameEntityCounterTable;
 import forge.game.ability.AbilityUtils;
@@ -60,9 +60,7 @@ public PaymentDecision visit(CostBehold cost) {
     @Override
     public PaymentDecision visit(CostChooseColor cost) {
         int c = cost.getAbilityAmount(ability);
-        List<String> choices = player.getController().chooseColors("Color", ability, c, c,
-                new ArrayList<>(MagicColor.Constant.ONLY_COLORS));
-        return PaymentDecision.colors(choices);
+        return PaymentDecision.colors(player.getController().chooseColors("Color", ability, c, c, ColorSet.WUBRG));
     }
 
     @Override
diff --git a/forge-ai/src/main/java/forge/ai/PlayerControllerAi.java b/forge-ai/src/main/java/forge/ai/PlayerControllerAi.java
@@ -49,6 +49,7 @@
 
 import java.util.*;
 import java.util.function.Predicate;
+import java.util.stream.Collectors;
 
 
 /**
@@ -1051,8 +1052,8 @@ public byte chooseColor(String message, SpellAbility sa, ColorSet colors) {
     }
 
     @Override
-    public List<String> chooseColors(String message, SpellAbility sa, int min, int max, List<String> options) {
-        return ComputerUtilCard.chooseColor(sa, min, max, options);
+    public ColorSet chooseColors(String message, SpellAbility sa, int min, int max, ColorSet options) {
+        return ColorSet.fromNames(ComputerUtilCard.chooseColor(sa, min, max, options.stream().map(MagicColor.Color::getName).collect(Collectors.toList())));
     }
 
     /*
diff --git a/forge-core/src/main/java/forge/card/ColorSet.java b/forge-core/src/main/java/forge/card/ColorSet.java
@@ -94,6 +94,13 @@ public static ColorSet fromEnums(final Color... colors) {
         }
         return fromMask(mask);
     }
+    public static ColorSet fromEnums(final Iterable<Color> colors) {
+        byte mask = 0;
+        for (Color e : colors) {
+            mask |= e.getColorMask();
+        }
+        return fromMask(mask);
+    }
 
     public static ColorSet fromNames(final String... colors) {
         byte mask = 0;
diff --git a/forge-core/src/main/java/forge/deck/DeckRecognizer.java b/forge-core/src/main/java/forge/deck/DeckRecognizer.java
@@ -1013,36 +1013,6 @@ private static MagicColor.Color getMagicColor(String colorName){
         return MagicColor.Color.fromByte(MagicColor.fromName(colorName.toLowerCase()));
     }
 
-    public static String getLocalisedMagicColorName(String colorName){
-        Localizer localizer = Localizer.getInstance();
-        return switch (colorName.toLowerCase()) {
-            case MagicColor.Constant.WHITE -> localizer.getMessage("lblWhite");
-            case MagicColor.Constant.BLUE -> localizer.getMessage("lblBlue");
-            case MagicColor.Constant.BLACK -> localizer.getMessage("lblBlack");
-            case MagicColor.Constant.RED -> localizer.getMessage("lblRed");
-            case MagicColor.Constant.GREEN -> localizer.getMessage("lblGreen");
-            case MagicColor.Constant.COLORLESS -> localizer.getMessage("lblColorless");
-            case "multicolour", "multicolor" -> localizer.getMessage("lblMulticolor");
-            default -> "";
-        };
-    }
-
-    /**
-     * Get the magic color by the localised/translated name.
-     * @param localisedName String of localised color name.
-     * @return The string of the magic color.
-     */
-    public static String getColorNameByLocalisedName(String localisedName) {
-        Localizer localizer = Localizer.getInstance();
-
-        if(localisedName.equals(localizer.getMessage("lblWhite"))) return MagicColor.Constant.WHITE;
-        if(localisedName.equals(localizer.getMessage("lblBlue"))) return MagicColor.Constant.BLUE;
-        if(localisedName.equals(localizer.getMessage("lblBlack"))) return MagicColor.Constant.BLACK;
-        if(localisedName.equals(localizer.getMessage("lblRed"))) return MagicColor.Constant.RED;
-        if(localisedName.equals(localizer.getMessage("lblGreen"))) return MagicColor.Constant.GREEN;
-
-        return "";
-    }
     public static boolean isDeckName(final String lineAsIs) {
         if (lineAsIs == null)
             return false;
diff --git a/forge-game/src/main/java/forge/game/GameAction.java b/forge-game/src/main/java/forge/game/GameAction.java
@@ -24,7 +24,6 @@
 import forge.card.CardType.Supertype;
 import forge.card.ColorSet;
 import forge.card.GamePieceType;
-import forge.card.MagicColor;
 import forge.deck.DeckSection;
 import forge.game.ability.AbilityFactory;
 import forge.game.ability.AbilityKey;
@@ -2440,8 +2439,7 @@ private void runPreOpeningHandActions(final Player first) {
                                 Localizer.getInstance().getMessage("lblChooseNColors", Lang.getNumeral(2));
                         SpellAbility sa = new SpellAbility.EmptySa(ApiType.ChooseColor, c, takesAction);
                         sa.putParam("AILogic", "MostProminentInComputerDeck");
-                        ColorSet chosenColors = ColorSet.fromNames(takesAction.getController().chooseColors(prompt, sa, 2, 2, MagicColor.Constant.ONLY_COLORS));
-                        c.setMarkedColors(chosenColors);
+                        c.setMarkedColors(takesAction.getController().chooseColors(prompt, sa, 2, 2, ColorSet.WUBRG));
                     }
                 }
             }
diff --git a/forge-game/src/main/java/forge/game/ability/effects/ChooseColorEffect.java b/forge-game/src/main/java/forge/game/ability/effects/ChooseColorEffect.java
@@ -2,7 +2,6 @@
 
 import forge.card.ColorSet;
 import forge.card.MagicColor;
-import forge.deck.DeckRecognizer;
 import forge.game.ability.AbilityUtils;
 import forge.game.ability.SpellAbilityEffect;
 import forge.game.card.Card;
@@ -61,7 +60,7 @@ public void resolve(SpellAbility sa) {
             if (!p.isInGame()) {
                 p = getNewChooser(sa, p);
             }
-            List<String> chosenColors = new ArrayList<>();
+
             int cntMin = sa.hasParam("UpTo") ? 0 : sa.hasParam("TwoColors") ? 2 : 1;
             int cntMax = sa.hasParam("TwoColors") ? 2 : sa.hasParam("OrColors") ? colorChoices.size() : 1;
             String prompt = null;
@@ -76,24 +75,25 @@ public void resolve(SpellAbility sa) {
             } else {
                 prompt = Localizer.getInstance().getMessage("lblChooseNColors", Lang.getNumeral(cntMax));
             }
+            ColorSet chosenColors = ColorSet.C;
             Player noNotify = p;
             if (sa.hasParam("Random")) {
                 String choice;
                 for (int i=0; i<cntMin; i++) {
                     choice = Aggregates.random(colorChoices);
                     colorChoices.remove(choice);
-                    chosenColors.add(choice);
+                    chosenColors = ColorSet.combine(chosenColors, ColorSet.fromNames(choice));
                 }
                 noNotify = null;
             } else {
-                chosenColors = p.getController().chooseColors(prompt, sa, cntMin, cntMax, colorChoices);
+                chosenColors = p.getController().chooseColors(prompt, sa, cntMin, cntMax, ColorSet.fromNames(colorChoices));
             }
-            if (chosenColors.isEmpty()) {
+            if (chosenColors.isColorless()) {
                 return;
             }
-            card.setChosenColors(chosenColors);
-            chosenColors = chosenColors.stream().map(DeckRecognizer::getLocalisedMagicColorName).collect(Collectors.toList());
-            p.getGame().getAction().notifyOfValue(sa, p, Lang.joinHomogenous(chosenColors), noNotify);
+            card.setChosenColors(chosenColors.stream().map(MagicColor.Color::getName).collect(Collectors.toList()));
+            String desc = Lang.joinHomogenous(chosenColors.stream().map(MagicColor.Color::getTranslatedName).collect(Collectors.toList()));
+            p.getGame().getAction().notifyOfValue(sa, p, desc, noNotify);
         }
     }
 }
diff --git a/forge-game/src/main/java/forge/game/cost/CostChooseColor.java b/forge-game/src/main/java/forge/game/cost/CostChooseColor.java
@@ -17,6 +17,9 @@
  */
 package forge.game.cost;
 
+import java.util.stream.Collectors;
+
+import forge.card.MagicColor;
 import forge.game.card.Card;
 import forge.game.player.Player;
 import forge.game.spellability.SpellAbility;
@@ -55,7 +58,7 @@ public final boolean canPay(final SpellAbility ability, final Player payer, fina
 
     @Override
     public boolean payAsDecided(Player payer, PaymentDecision pd, SpellAbility sa, final boolean effect) {
-        sa.getHostCard().setChosenColors(pd.colors);
+        sa.getHostCard().setChosenColors(pd.colors.stream().map(MagicColor.Color::getName).collect(Collectors.toList()));
         return true;
     }
 
diff --git a/forge-game/src/main/java/forge/game/cost/PaymentDecision.java b/forge-game/src/main/java/forge/game/cost/PaymentDecision.java
@@ -1,5 +1,6 @@
 package forge.game.cost;
 
+import forge.card.ColorSet;
 import forge.game.GameEntityCounterTable;
 import forge.game.card.Card;
 import forge.game.card.CardCollection;
@@ -14,7 +15,7 @@
 public class PaymentDecision {
     public int c = 0;
     public String type;
-    public List<String> colors;
+    public ColorSet colors;
 
     public final CardCollection cards = new CardCollection();
     public final List<Mana> mana;
@@ -51,7 +52,7 @@ public PaymentDecision(String choice) {
         type = choice;
     }
 
-    public PaymentDecision(List<String> choices) {
+    public PaymentDecision(ColorSet choices) {
         this(null, null, null, null, null);
         colors = choices;
     }
@@ -96,7 +97,7 @@ public static PaymentDecision type(String choice) {
         return new PaymentDecision(choice);
     }
 
-    public static PaymentDecision colors(List<String> choices) {
+    public static PaymentDecision colors(ColorSet choices) {
         return new PaymentDecision(choices);
     }
 
diff --git a/forge-game/src/main/java/forge/game/player/PlayerController.java b/forge-game/src/main/java/forge/game/player/PlayerController.java
@@ -267,7 +267,7 @@ public int chooseNumber(SpellAbility sa, String string, int min, int max, Map<St
 
     public abstract byte chooseColor(String message, SpellAbility sa, ColorSet colors);
     public abstract byte chooseColorAllowColorless(String message, Card c, ColorSet colors);
-    public abstract List<String> chooseColors(String message, SpellAbility sa, int min, int max, List<String> options);
+    public abstract ColorSet chooseColors(String message, SpellAbility sa, int min, int max, ColorSet options);
 
     public abstract ICardFace chooseSingleCardFace(SpellAbility sa, String message, Predicate<ICardFace> cpp, String name);
     public abstract ICardFace chooseSingleCardFace(SpellAbility sa, List<ICardFace> faces, String message);
diff --git a/forge-gui-desktop/src/main/java/forge/gui/ListChooser.java b/forge-gui-desktop/src/main/java/forge/gui/ListChooser.java
@@ -40,10 +40,13 @@
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Lists;
 
+import forge.card.MagicColor;
+import forge.localinstance.skin.FSkinProp;
 import forge.toolbox.FList;
 import forge.toolbox.FMouseAdapter;
 import forge.toolbox.FOptionPane;
 import forge.toolbox.FScrollPane;
+import forge.toolbox.FSkin;
 import forge.util.Localizer;
 
 /**
@@ -305,8 +308,11 @@ public TransformedCellRenderer(final Function<T, String> t1) {
          */
         @Override
         public Component getListCellRendererComponent(final JList<? extends T> list, final T value, final int index, final boolean isSelected, final boolean cellHasFocus) {
-            // TODO Auto-generated method stub
-            return defRenderer.getListCellRendererComponent(list, transformer.apply(value), index, isSelected, cellHasFocus);
+            Component result = defRenderer.getListCellRendererComponent(list, transformer.apply(value), index, isSelected, cellHasFocus);
+            if (value instanceof MagicColor.Color c) {
+                defRenderer.setIcon(FSkin.getImage(FSkinProp.iconFromColor(c), 24, 24).getIcon());
+            }
+            return result;
         }
     }
 }
diff --git a/forge-gui-desktop/src/main/java/forge/toolbox/FSkin.java b/forge-gui-desktop/src/main/java/forge/toolbox/FSkin.java
@@ -699,7 +699,7 @@ protected int getHeight() {
             return this.image.getHeight(null);
         }
 
-        protected ImageIcon getIcon() {
+        public ImageIcon getIcon() {
             if (this.imageIcon == null) {
                 /*float screenScale = GuiBase.getInterface().getScreenScale();
                 int iconWidth = Math.round(image.getWidth(null) / screenScale);
@@ -872,7 +872,7 @@ protected int getHeight() {
         }
 
         @Override
-        protected ImageIcon getIcon() { //can skip null check since imageIcon will always be set
+        public ImageIcon getIcon() { //can skip null check since imageIcon will always be set
             return this.imageIcon;
         }
     }
diff --git a/forge-gui-desktop/src/test/java/forge/gamesimulationtests/util/PlayerControllerForTests.java b/forge-gui-desktop/src/test/java/forge/gamesimulationtests/util/PlayerControllerForTests.java
@@ -550,7 +550,7 @@ public Object vote(SpellAbility sa, String prompt, List<Object> options, ListMul
     }
 
     @Override
-    public List<String> chooseColors(String message, SpellAbility sa, int min, int max, List<String> options) {
+    public ColorSet chooseColors(String message, SpellAbility sa, int min, int max, ColorSet options) {
         throw new UnsupportedOperationException("No idea how a test player controller would choose colors");
     }
 
diff --git a/forge-gui-mobile/src/forge/toolbox/FChoiceList.java b/forge-gui-mobile/src/forge/toolbox/FChoiceList.java
@@ -6,6 +6,7 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import java.util.function.Function;
 
 import com.badlogic.gdx.graphics.Texture;
 import com.badlogic.gdx.utils.Align;
@@ -24,6 +25,7 @@
 import forge.card.CardRenderer.CardStackPosition;
 import forge.card.CardZoom;
 import forge.card.CardZoom.ActivateHandler;
+import forge.card.MagicColor;
 import forge.card.mana.ManaCost;
 import forge.card.mana.ManaCostParser;
 import forge.game.card.CardView;
@@ -105,6 +107,8 @@ protected FChoiceList(Iterable<? extends T> items, int minChoices0, int maxChoic
             renderer = new IHasCardViewItemRenderer();
         } else if (item instanceof PlayerView) {
             renderer = new PlayerItemRenderer();
+        } else if (item instanceof MagicColor.Color) {
+            renderer = new MagicColorRenderer();
         } else if (item instanceof Integer || item == FilterOperator.EQUALS) { //allow numeric operators to be selected horizontally
             renderer = new NumberRenderer();
         } else if (item instanceof IHasSkinProp) {
@@ -649,12 +653,19 @@ public void drawValue(Graphics g, T value, FSkinFont font, FSkinColor foreColor,
         }
     }
 
-    protected class IHasSkinPropRenderer extends DefaultItemRenderer {
+    protected class AbstractIHasSkinPropRenderer extends DefaultItemRenderer {
         private final TextRenderer textRenderer = new TextRenderer(true);
+        private final Function<T, String> displayFunction;
+        private final Function<T, FSkinProp> skinFunction;
+
+        public AbstractIHasSkinPropRenderer(Function<T, String> displayFunction, Function<T, FSkinProp> skinFunction) {
+            this.displayFunction = displayFunction;
+            this.skinFunction = skinFunction;
+        }
 
         @Override
         public void drawValue(Graphics g, T value, FSkinFont font, FSkinColor foreColor, boolean pressed, float x, float y, float w, float h) {
-            FSkinProp skinProp = ((IHasSkinProp) value).getSkinProp();
+            FSkinProp skinProp = skinFunction.apply(value);
             if (skinProp != null) {
                 float iconSize = h * 0.8f;
                 float offset = (h - iconSize) / 2;
@@ -665,7 +676,19 @@ public void drawValue(Graphics g, T value, FSkinFont font, FSkinColor foreColor,
                 x += dx;
                 w -= dx;
             }
-            textRenderer.drawText(g, value.toString(), font, foreColor, x, y, w, h, y, h, true, Align.left, true);
+            textRenderer.drawText(g, displayFunction.apply(value), font, foreColor, x, y, w, h, y, h, true, Align.left, true);
+        }
+    }
+
+    protected class IHasSkinPropRenderer extends AbstractIHasSkinPropRenderer {
+        public IHasSkinPropRenderer() {
+            super(v -> v.toString(), v -> ((IHasSkinProp)v).getSkinProp());
+        }
+    }
+
+    protected class MagicColorRenderer extends AbstractIHasSkinPropRenderer {
+        public MagicColorRenderer() {
+            super(v -> ((MagicColor.Color)v).getTranslatedName(), v -> FSkinProp.iconFromColor((MagicColor.Color)v));
         }
     }
 
diff --git a/forge-gui/src/main/java/forge/gamemodes/match/AbstractGuiGame.java b/forge-gui/src/main/java/forge/gamemodes/match/AbstractGuiGame.java
@@ -26,6 +26,7 @@
 
 import java.io.Serializable;
 import java.util.*;
+import java.util.function.Function;
 
 public abstract class AbstractGuiGame implements IGuiGame, IMayViewCards {
     private PlayerView currentPlayer = null;
@@ -616,14 +617,17 @@ public <T> T oneOrNone(final String message, final List<T> choices) {
      */
     @Override
     public <T> T one(final String message, final List<T> choices) {
+        return one(message, choices, null);
+    }
+    public <T> T one(final String message, final List<T> choices, Function<T, String> display) {
         if (choices == null || choices.isEmpty()) {
             return null;
         }
         if (choices.size() == 1) {
             return Iterables.getFirst(choices, null);
         }
 
-        final List<T> choice = getChoices(message, 1, 1, choices);
+        final List<T> choice = getChoices(message, 1, 1, choices, null, display);
         assert choice.size() == 1;
         return choice.get(0);
     }
diff --git a/forge-gui/src/main/java/forge/gui/card/CardDetailUtil.java b/forge-gui/src/main/java/forge/gui/card/CardDetailUtil.java
@@ -5,7 +5,6 @@
 import forge.card.CardStateName;
 import forge.card.ColorSet;
 import forge.card.MagicColor;
-import forge.deck.DeckRecognizer;
 import forge.game.GameView;
 import forge.game.card.Card;
 import forge.game.card.CardView;
@@ -459,7 +458,7 @@ public static String composeCardText(final CardStateView state, final GameView g
         if (card.getChosenColors() != null && !card.getChosenColors().isEmpty()) {
             area.append("\n");
             area.append("(").append(Localizer.getInstance().getMessage("lblChosenColors")).append(" ");
-            area.append(Lang.joinHomogenous(card.getChosenColors().stream().map(DeckRecognizer::getLocalisedMagicColorName).collect(Collectors.toList())));
+            area.append(Lang.joinHomogenous(ColorSet.fromNames(card.getChosenColors()).stream().map(MagicColor.Color::getTranslatedName).collect(Collectors.toList())));
             area.append(")");
         }
 
diff --git a/forge-gui/src/main/java/forge/gui/interfaces/IGuiGame.java b/forge-gui/src/main/java/forge/gui/interfaces/IGuiGame.java
@@ -184,6 +184,7 @@ public interface IGuiGame {
      * @return One of {@code choices}. Can only be {@code null} if {@code choices} is empty.
      */
     <T> T one(String message, List<T> choices);
+    <T> T one(String message, List<T> choices, Function<T, String> display);
 
     <T> void reveal(String message, List<T> items);
 
diff --git a/forge-gui/src/main/java/forge/player/HumanCostDecision.java b/forge-gui/src/main/java/forge/player/HumanCostDecision.java
diff --git a/forge-gui/src/main/java/forge/player/PlayerControllerHuman.java b/forge-gui/src/main/java/forge/player/PlayerControllerHuman.java

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@`
`49`	`49`
`50`	`50`	`import java.util.*;`
`51`	`51`	`import java.util.function.Predicate;`
	`52`	`+import java.util.stream.Collectors;`
`52`	`53`
`53`	`54`
`54`	`55`	`/**`
`@@ -1051,8 +1052,8 @@ public byte chooseColor(String message, SpellAbility sa, ColorSet colors) {`
`1051`	`1052`	`}`
`1052`	`1053`
`1053`	`1054`	`@Override`
`1054`		`- public List<String> chooseColors(String message, SpellAbility sa, int min, int max, List<String> options) {`
`1055`		`- return ComputerUtilCard.chooseColor(sa, min, max, options);`
	`1055`	`+ public ColorSet chooseColors(String message, SpellAbility sa, int min, int max, ColorSet options) {`
	`1056`	`+ return ColorSet.fromNames(ComputerUtilCard.chooseColor(sa, min, max, options.stream().map(MagicColor.Color::getName).collect(Collectors.toList())));`
`1056`	`1057`	`}`
`1057`	`1058`
`1058`	`1059`	`/*`
Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,13 @@ public static ColorSet fromEnums(final Color... colors) {`
`94`	`94`	`}`
`95`	`95`	`return fromMask(mask);`
`96`	`96`	`}`
	`97`	`+ public static ColorSet fromEnums(final Iterable<Color> colors) {`
	`98`	`+ byte mask = 0;`
	`99`	`+ for (Color e : colors) {`
	`100`	`+ mask \|= e.getColorMask();`
	`101`	`+ }`
	`102`	`+ return fromMask(mask);`
	`103`	`+ }`
`97`	`104`
`98`	`105`	`public static ColorSet fromNames(final String... colors) {`
`99`	`106`	`byte mask = 0;`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@`
`24`	`24`	`import forge.card.CardType.Supertype;`
`25`	`25`	`import forge.card.ColorSet;`
`26`	`26`	`import forge.card.GamePieceType;`
`27`		`-import forge.card.MagicColor;`
`28`	`27`	`import forge.deck.DeckSection;`
`29`	`28`	`import forge.game.ability.AbilityFactory;`
`30`	`29`	`import forge.game.ability.AbilityKey;`
`@@ -2440,8 +2439,7 @@ private void runPreOpeningHandActions(final Player first) {`
`2440`	`2439`	`Localizer.getInstance().getMessage("lblChooseNColors", Lang.getNumeral(2));`
`2441`	`2440`	`SpellAbility sa = new SpellAbility.EmptySa(ApiType.ChooseColor, c, takesAction);`
`2442`	`2441`	`sa.putParam("AILogic", "MostProminentInComputerDeck");`
`2443`		`- ColorSet chosenColors = ColorSet.fromNames(takesAction.getController().chooseColors(prompt, sa, 2, 2, MagicColor.Constant.ONLY_COLORS));`
`2444`		`- c.setMarkedColors(chosenColors);`
	`2442`	`+ c.setMarkedColors(takesAction.getController().chooseColors(prompt, sa, 2, 2, ColorSet.WUBRG));`
`2445`	`2443`	`}`
`2446`	`2444`	`}`
`2447`	`2445`	`}`