Some cleanup (Card-Forge#9413)

Author: tool4ever

docs/Card-scripting-API/AbilityFactory.md

@@ -15,7 +15,7 @@ Syntax definitions like the above will use different symbols to separate the var
 - curly brackets to denote the type of a parameter
 
 >*NOTE:*
-> - these factories are refactored from time to time (often to adapt to new sets), so while some entries could be slightly outdated, the base information should still be correct
+> - these factories are refactored from time to time (often to adapt to new mechanics), so while some entries could be slightly outdated, the base information should still be correct
 > - when in doubt you can always cross-check with the [available APIs](https://github.com/Card-Forge/forge/tree/master/forge-game/src/main/java/forge/game/ability/effects) code
 > - a few factories also have _*All_ variants, these are slowly being phased out
 > - some parameters are only added for very exotic cards, these won't be included here to keep the focus on understanding the general concepts of scripting
@@ -27,7 +27,7 @@ Syntax definitions like the above will use different symbols to separate the var
 ## Cost / UnlessCost
 `Cost$ {AbilityCost}` is the appropriate way to set the cost of the ability. Currently for spells, any additional costs including the original Mana cost need to appear in the Cost param in the AbilityFactory. For each card that uses it, the order in which the cost is paid will always be the same.
 
-Secondary abilities such as the DB executed by triggers or replacements (usually) don't need costs. (This is one reason to use DB over AB in these cases.)
+Secondary abilities such as those executed by triggers or replacements (usually) don't need costs. (This is one reason to use DB over AB in these cases.)
 
 Read more about it in [Costs](Costs.md)
 
@@ -305,6 +305,8 @@ Parameters:
 
 ## Fight
 
+## FlipACoin
+
 ## Fog
 This AF is based on the original *Fog* spell: "Prevent all combat damage that would be dealt this turn." While this could be done with an Effect, the specialized nature of the AI gives it its own AF.
 
@@ -406,7 +408,7 @@ SVar:DBExchange:DB$ ExchangeControl | Defined$ ParentTarget | ValidTgts$ Land.Op
 ```
 
 ## Regenerate
-Regenerate is for creating regeneration shields.
+Creating regeneration shields.
 
 ## Reveal
 
@@ -468,7 +470,7 @@ The trigger-specific params are defined in [Triggers](Triggers.md).
 
 ### ImmediateTrigger
 Parameters:
-- `TriggerAmount$ {Integer}`
+- `TriggerAmount$ {Integer}` (Default: 1)
 
 ## Turn structure
 

forge-ai/src/main/java/forge/ai/ComputerUtilCost.java

@@ -89,7 +89,7 @@ public static boolean checkRemoveCounterCost(final Cost cost, final Card source,
                 // ignore Loyality abilities with Zero as Cost
                 if (!type.is(CounterEnumType.LOYALTY)) {
                     PaymentDecision pay = decision.visit(remCounter);
-                    if (pay == null || pay.c <= 0) {
+                    if (pay == null || pay.counterTable.totalValues() <= 0) {
                         return false;
                     }
                 }

forge-ai/src/main/java/forge/ai/ability/ChangeZoneAi.java

@@ -321,7 +321,7 @@ private static AiAbilityDecision hiddenOriginCanPlayAI(final Player ai, final Sp
             }
         }
 
-        Iterable<Player> pDefined = Lists.newArrayList(source.getController());
+        Iterable<Player> pDefined;
         final TargetRestrictions tgt = sa.getTargetRestrictions();
         if (tgt != null && tgt.canTgtPlayer()) {
             sa.resetTargets();
@@ -335,12 +335,10 @@ private static AiAbilityDecision hiddenOriginCanPlayAI(final Player ai, final Sp
                 return new AiAbilityDecision(0, AiPlayDecision.TargetingFailed);
             }
             pDefined = sa.getTargets().getTargetPlayers();
+        } else if (sa.hasParam("DefinedPlayer")) {
+            pDefined = AbilityUtils.getDefinedPlayers(source, sa.getParam("DefinedPlayer"), sa);
         } else {
-            if (sa.hasParam("DefinedPlayer")) {
-                pDefined = AbilityUtils.getDefinedPlayers(source, sa.getParam("DefinedPlayer"), sa);
-            } else {
-                pDefined = AbilityUtils.getDefinedPlayers(source, sa.getParam("Defined"), sa);
-            }
+            pDefined = AbilityUtils.getDefinedPlayers(source, sa.getParam("Defined"), sa);
         }
 
         String type = sa.getParam("ChangeType");

forge-ai/src/main/java/forge/ai/ability/ChooseCardAi.java

@@ -170,12 +170,12 @@ public Card chooseSingleCard(final Player ai, final SpellAbility sa, Iterable<Ca
                 ownChoices = CardLists.filter(options, CardPredicates.isControlledByAnyOf(ai.getAllies()));
             }
             choice = ComputerUtilCard.getBestAI(ownChoices);
-        } else if (logic.equals("BestBlocker")) {
+        } else if ("BestBlocker".equals(logic)) {
             if (IterableUtil.any(options, CardPredicates.UNTAPPED)) {
                 options = CardLists.filter(options, CardPredicates.UNTAPPED);
             }
             choice = ComputerUtilCard.getBestCreatureAI(options);
-        } else if (logic.equals("Clone")) {
+        } else if ("Clone".equals(logic)) {
             final String filter = "Permanent.YouDontCtrl,Permanent.nonLegendary";
             CardCollection newOptions = CardLists.getValidCards(options, filter, ctrl, host, sa);
             if (!newOptions.isEmpty()) {
@@ -185,7 +185,7 @@ public Card chooseSingleCard(final Player ai, final SpellAbility sa, Iterable<Ca
         } else if ("RandomNonLand".equals(logic)) {
             options = CardLists.getValidCards(options, "Card.nonLand", host.getController(), host, sa);
             choice = Aggregates.random(options);
-        } else if (logic.equals("NeedsPrevention")) {
+        } else if ("NeedsPrevention".equals(logic)) {
             final Game game = ai.getGame();
             final Combat combat = game.getCombat();
             CardCollectionView better = CardLists.filter(options, c -> {
@@ -242,7 +242,7 @@ public Card chooseSingleCard(final Player ai, final SpellAbility sa, Iterable<Ca
             } else {
                 choice = ComputerUtilCard.getWorstPermanentAI(options, false, false, false, false);
             }
-        } else if (logic.equals("Duneblast")) {
+        } else if ("Duneblast".equals(logic)) {
             CardCollectionView aiCreatures = ai.getCreaturesInPlay();
             aiCreatures = CardLists.getNotKeyword(aiCreatures, Keyword.INDESTRUCTIBLE);
 
@@ -252,15 +252,15 @@ public Card chooseSingleCard(final Player ai, final SpellAbility sa, Iterable<Ca
 
             Card chosen = ComputerUtilCard.getBestCreatureAI(aiCreatures);
             return chosen;
-        } else if (logic.equals("OrzhovAdvokist")) {
+        } else if ("OrzhovAdvokist".equals(logic)) {
             if (ai.equals(sa.getActivatingPlayer()) || // who cares if you can't attack yourself
                     (ai.getOpponents().size() > 1 && // if there is another opponent good to attack, take the counters
                     !AiAttackController.choosePreferredDefenderPlayer(ai).equals(sa.getActivatingPlayer()))) {
                 choice = ComputerUtilCard.getBestAI(options);
                 // TODO: would also be nice to take the counters if not in a good position to attack anyway
                 //  – might also be good to do a separate AI for Noble Heritage
             }
-        } else if (logic.equals("Phylactery")) {
+        } else if ("Phylactery".equals(logic)) {
             CardCollection aiArtifacts = CardLists.filter(ai.getCardsIn(ZoneType.Battlefield), CardPredicates.ARTIFACTS);
             CardCollection indestructibles = CardLists.filter(aiArtifacts, CardPredicates.hasKeyword(Keyword.INDESTRUCTIBLE));
             CardCollection nonCreatures = CardLists.filter(aiArtifacts, CardPredicates.NON_CREATURES);
@@ -276,7 +276,7 @@ public Card chooseSingleCard(final Player ai, final SpellAbility sa, Iterable<Ca
                 // Choose the best (hopefully the fattest, whatever) creature so that hopefully it won't die too easily
                 choice = ComputerUtilCard.getBestAI(creatures);
             }
-        } else if (logic.equals("NextTurnAttacker")) {
+        } else if ("NextTurnAttacker".equals(logic)) {
             choice = ComputerUtilCard.getBestCreatureToAttackNextTurnAI(ai, options);
         } else {
             choice = ComputerUtilCard.getBestAI(options);

forge-core/src/main/java/forge/item/SealedProduct.java

@@ -101,7 +101,6 @@ public String toString() {
 
     protected List<PaperCard> generate() {
         return BoosterGenerator.getBoosterPack(contents);
-
     }
 
     protected PaperCard getRandomBasicLand(final String setCode) {

forge-game/src/main/java/forge/game/Game.java

@@ -372,7 +372,6 @@ public Game(Iterable<RegisteredPlayer> players0, GameRules rules0, Match match0,
 
         sbaCheckedCommandList = new ArrayList<>();
 
-        // update players
         view.updatePlayers(this);
 
         subscribeToEvents(gameLog.getEventVisitor());

forge-game/src/main/java/forge/game/ability/AbilityUtils.java

@@ -73,11 +73,6 @@ public static CardCollection getDefinedCards(final Card hostCard, final String d
             player = hostCard.getController();
         }
 
-        if (defined.contains("AndSelf")) {
-            cards.add(hostCard);
-            defined = defined.replace("AndSelf", "");
-        }
-
         if (defined.equals("Self")) {
             c = hostCard;
         } else if (defined.equals("CorrectedSelf")) {

forge-game/src/main/java/forge/game/cost/CostRemoveAnyCounter.java

@@ -129,8 +129,8 @@ public boolean payAsDecided(Player ai, PaymentDecision decision, SpellAbility ab
                 removed += v.getValue();
                 e.getKey().subtractCounter(v.getKey(), v.getValue(), ai);
             }
-            if (e.getKey() instanceof Card) {
-                e.getKey().getGame().updateLastStateForCard((Card) e.getKey());
+            if (e.getKey() instanceof Card c) {
+                e.getKey().getGame().updateLastStateForCard(c);
             }
         }
 

forge-game/src/main/java/forge/game/cost/CostRemoveCounter.java

@@ -187,8 +187,8 @@ public boolean payAsDecided(Player ai, PaymentDecision decision, SpellAbility ab
                 removed += v.getValue();
                 e.getKey().subtractCounter(v.getKey(), v.getValue(), ai);
             }
-            if (e.getKey() instanceof Card) {
-                e.getKey().getGame().updateLastStateForCard((Card) e.getKey());
+            if (e.getKey() instanceof Card c) {
+                e.getKey().getGame().updateLastStateForCard(c);
             }
         }
 

forge-game/src/main/java/forge/game/staticability/StaticAbilityContinuous.java

@@ -491,7 +491,7 @@ public static CardCollectionView applyContinuousAbility(final StaticAbility stAb
 
             if (params.containsKey("IgnoreEffectCost")) {
                 String cost = params.get("IgnoreEffectCost");
-                buildIgnorEffectAbility(stAb, cost, affectedPlayers, affectedCards);
+                buildIgnoreEffectAbility(stAb, cost, affectedPlayers, affectedCards);
             }
         }
 
@@ -940,7 +940,7 @@ private static ColorSet getColorsFromParam(StaticAbility stAb, final String colo
         return addColors;
     }
 
-    private static void buildIgnorEffectAbility(final StaticAbility stAb, final String costString, final List<Player> players, final CardCollectionView cards) {
+    private static void buildIgnoreEffectAbility(final StaticAbility stAb, final String costString, final List<Player> players, final CardCollectionView cards) {
         final List<Player> validActivator = new ArrayList<>(players);
         for (final Card c : cards) {
             validActivator.add(c.getController());