Merge branch 'newBranch' into 'master'

Add feature request

See merge request core-developers/forge!2179

forge-game/src/main/java/forge/game/card/Card.java

@@ -3659,6 +3659,8 @@ public class Card extends GameEntity implements Comparable<Card> {
 
         if (updateView) {
             updateKeywords();
+            if (isToken())
+                game.fireEvent(new GameEventTokenStateUpdate(this));
         }
     }
 
@@ -3713,6 +3715,8 @@ public class Card extends GameEntity implements Comparable<Card> {
         KeywordsChange change = changedCardKeywords.remove(timestamp);
         if (change != null && updateView) {
             updateKeywords();
+            if (isToken())
+                game.fireEvent(new GameEventTokenStateUpdate(this));
         }
         return change;
     }
@@ -5460,6 +5464,14 @@ public class Card extends GameEntity implements Comparable<Card> {
         }
         return hexproofKey;
     }
+    public String getKeywordKey() {
+        List<String> ability = new ArrayList<>();
+        for (final KeywordInterface inst : getKeywords()) {
+            ability.add(inst.getOriginal());
+        }
+        Collections.sort(ability);
+        return String.join(",", ability);
+    }
     public Zone getZone() {
         return currentZone;
     }

forge-game/src/main/java/forge/game/card/CardView.java

@@ -1017,6 +1017,7 @@ public class CardView extends GameEntityView {
             foilIndexOverride = index0;
         }
 
+        public String getKeywordKey() { return get(TrackableProperty.KeywordKey); }
         public String getProtectionKey() { return get(TrackableProperty.ProtectionKey); }
         public String getHexproofKey() { return get(TrackableProperty.HexproofKey); }
         public boolean hasDeathtouch() { return get(TrackableProperty.HasDeathtouch); }
@@ -1076,6 +1077,8 @@ public class CardView extends GameEntityView {
             set(TrackableProperty.ProtectionKey, c.getProtectionKey());
             //set hexproofKeys for Icons
             set(TrackableProperty.HexproofKey, c.getHexproofKey());
+            //keywordkey
+            set(TrackableProperty.KeywordKey, c.getKeywordKey());
         }
 
         public boolean isBasicLand() {

forge-game/src/main/java/forge/game/event/GameEventTokenStateUpdate.java

@@ -0,0 +1,24 @@
+package forge.game.event;
+
+import forge.game.card.Card;
+
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+
+public class GameEventTokenStateUpdate extends GameEvent {
+
+    public final Collection<Card> cards;
+    public GameEventTokenStateUpdate(Card affected) {
+        cards = Arrays.asList(affected);
+    }
+
+    public GameEventTokenStateUpdate(List<Card> affected) {
+        cards = affected;
+    }
+
+    @Override
+    public <T> T visit(IGameEventVisitor<T> visitor) {
+        return visitor.visit(this);
+    }
+}

forge-game/src/main/java/forge/game/event/IGameEventVisitor.java

@@ -37,6 +37,7 @@ public interface IGameEventVisitor<T> {
     T visit(GameEventPlayerPoisoned event);
     T visit(GameEventPlayerPriority event);
     T visit(GameEventPlayerStatsChanged event);
+    T visit(GameEventTokenStateUpdate event);
     T visit(GameEventScry event);
     T visit(GameEventShuffle event);
     T visit(GameEventSpellAbilityCast gameEventSpellAbilityCast);
@@ -83,6 +84,7 @@ public interface IGameEventVisitor<T> {
         public T visit(GameEventPlayerPoisoned event) { return null; }
         public T visit(GameEventPlayerPriority event) { return null; }
         public T visit(GameEventPlayerStatsChanged event) { return null; }
+        public T visit(GameEventTokenStateUpdate event) { return null; }
         public T visit(GameEventScry event) { return null; }
         public T visit(GameEventShuffle event) { return null; }
         public T visit(GameEventSpellResolved event) { return null; }

forge-game/src/main/java/forge/game/phase/PhaseHandler.java

@@ -189,6 +189,8 @@ public class PhaseHandler implements java.io.Serializable {
             final List<Card> lands = CardLists.filter(playerTurn.getLandsInPlay(), Presets.UNTAPPED);
             playerTurn.setNumPowerSurgeLands(lands.size());
         }
+        //update tokens
+        game.fireEvent(new GameEventTokenStateUpdate(playerTurn.getTokensInPlay()));
 
         game.fireEvent(new GameEventTurnPhase(playerTurn, phase, phaseType));
     }

forge-game/src/main/java/forge/game/player/Player.java

@@ -2362,6 +2362,13 @@ public class Player extends GameEntity implements Comparable<Player> {
         return CardLists.filter(getCardsIn(ZoneType.Battlefield), Presets.CREATURES);
     }
 
+    /**
+     * use to get a list of tokens in play for a given player.
+     */
+    public CardCollection getTokensInPlay() {
+        return CardLists.filter(getCardsIn(ZoneType.Battlefield), Presets.TOKEN);
+    }
+
     /**
      * use to get a list of all lands a given player has on the battlefield.
      */

forge-game/src/main/java/forge/trackable/TrackableProperty.java

@@ -82,6 +82,7 @@ public enum TrackableProperty {
     ChangedColorWords(TrackableTypes.StringMapType),
     ChangedTypes(TrackableTypes.StringMapType),
 
+    KeywordKey(TrackableTypes.StringType),
     HasDeathtouch(TrackableTypes.BooleanType),
     HasDefender(TrackableTypes.BooleanType),
     HasDoubleStrike(TrackableTypes.BooleanType),

forge-gui-mobile/src/forge/screens/match/views/VField.java

@@ -110,6 +110,9 @@ public class VField extends FContainer {
             if (!c.hasCardAttachments() &&
                     cardName.equals(c.getCurrentState().getName()) &&
                     card.hasSameCounters(c) &&
+                    card.getCurrentState().getKeywordKey().equals(c.getCurrentState().getKeywordKey()) &&
+                    card.isTapped() == c.isTapped() && // don't stack tapped tokens on untapped tokens
+                    card.isSick() == c.isSick() && //don't stack sick tokens on non sick
                     card.isToken() == c.isToken()) { //don't stack tokens on top of non-tokens
                 CardAreaPanel cPanel = CardAreaPanel.get(c);
                 while (cPanel.getNextPanelInStack() != null) {

forge-gui/src/main/java/forge/control/FControlGameEventHandler.java

@@ -357,6 +357,12 @@ public class FControlGameEventHandler extends IGameEventVisitor.Base<Void> {
         return processCards(cards, cardsRefreshDetails);
     }
 
+    @Override
+    public Void visit(final GameEventTokenStateUpdate event) {
+        processCards(event.cards, cardsRefreshDetails);
+        return processCards(event.cards, cardsUpdate);
+    }
+
     @Override
     public Void visit(final GameEventShuffle event) {
         //pfps the change to the library has already been performed by a setCards call