From cc9629ed514749f0c56756cf3d4d73131f3a1dd0 Mon Sep 17 00:00:00 2001 From: dilnu Date: Sat, 1 Feb 2020 15:14:15 -0500 Subject: [PATCH 1/2] Fix the Divine Visitation replacement effect. This also gives the CREATE_TOKEN game events access to the Token being created and updates the GatherSpecimens replacement effect to use that access. --- .../src/mage/cards/d/DivineVisitation.java | 11 +- .../src/mage/cards/g/GatherSpecimens.java | 2 +- .../main/java/mage/game/events/GameEvent.java | 17 ++- .../mage/game/permanent/token/TokenImpl.java | 111 ++++++++++-------- 4 files changed, 81 insertions(+), 60 deletions(-) diff --git a/Mage.Sets/src/mage/cards/d/DivineVisitation.java b/Mage.Sets/src/mage/cards/d/DivineVisitation.java index f7914a8e972..6476f60c2df 100644 --- a/Mage.Sets/src/mage/cards/d/DivineVisitation.java +++ b/Mage.Sets/src/mage/cards/d/DivineVisitation.java @@ -27,7 +27,6 @@ public final class DivineVisitation extends CardImpl { public DivineVisitation(UUID ownerId, CardSetInfo setInfo) { super(ownerId, setInfo, new CardType[]{CardType.ENCHANTMENT}, "{3}{W}{W}"); - // TODO: This implementation is not entirely correct, see https://twitter.com/EliShffrn/status/1042145606582591490 // If one or more creature tokens would be created under your control, that many 4/4 white Angel creature tokens with flying and vigilance are created instead. this.addAbility(new SimpleStaticAbility( Zone.BATTLEFIELD, new DivineVisitationEffect() @@ -59,21 +58,17 @@ class DivineVisitationEffect extends ReplacementEffectImpl { @Override public boolean checksEventType(GameEvent event, Game game) { - return event.getType() == GameEvent.EventType.ENTERS_THE_BATTLEFIELD; + return event.getType() == GameEvent.EventType.CREATE_TOKEN; } @Override public boolean applies(GameEvent event, Ability source, Game game) { - Permanent perm = ((EntersTheBattlefieldEvent) event).getTarget(); - return perm != null - && perm.isCreature() - && perm instanceof PermanentToken - && perm.isControlledBy(source.getControllerId()); + return event.getPlayerId().equals(source.getControllerId()); } @Override public boolean replaceEvent(GameEvent event, Ability source, Game game) { - game.addEffect(new CopyEffect(Duration.Custom, new AngelVigilanceToken(), event.getTargetId()), source); + event.setToken(new AngelVigilanceToken()); return false; } diff --git a/Mage.Sets/src/mage/cards/g/GatherSpecimens.java b/Mage.Sets/src/mage/cards/g/GatherSpecimens.java index 9efc66b27bd..b257d242c74 100644 --- a/Mage.Sets/src/mage/cards/g/GatherSpecimens.java +++ b/Mage.Sets/src/mage/cards/g/GatherSpecimens.java @@ -76,7 +76,7 @@ class GatherSpecimensReplacementEffect extends ReplacementEffectImpl { } } } - if (event.getType() == GameEvent.EventType.CREATE_TOKEN && event.getFlag()) { // flag indicates if it's a creature token + if (event.getType() == GameEvent.EventType.CREATE_TOKEN && event.getToken().isCreature()) { Player controller = game.getPlayer(source.getControllerId()); return controller != null && controller.hasOpponent(event.getPlayerId(), game); } diff --git a/Mage/src/main/java/mage/game/events/GameEvent.java b/Mage/src/main/java/mage/game/events/GameEvent.java index fb854bcdf1c..c79e326a752 100644 --- a/Mage/src/main/java/mage/game/events/GameEvent.java +++ b/Mage/src/main/java/mage/game/events/GameEvent.java @@ -2,6 +2,7 @@ package mage.game.events; import mage.MageObjectReference; import mage.constants.Zone; +import mage.game.permanent.token.Token; import java.io.Serializable; import java.util.ArrayList; @@ -13,6 +14,7 @@ import java.util.UUID; */ public class GameEvent implements Serializable { + protected Token token; protected EventType type; protected UUID targetId; protected UUID sourceId; @@ -339,13 +341,17 @@ public class GameEvent implements Serializable { } public GameEvent(EventType type, UUID targetId, UUID sourceId, UUID playerId, MageObjectReference reference) { - this(type, null, targetId, sourceId, playerId, 0, false, reference); + this(type, null, targetId, sourceId, playerId, 0, false, reference, null); } public GameEvent(EventType type, UUID targetId, UUID sourceId, UUID playerId, int amount, boolean flag) { this(type, null, targetId, sourceId, playerId, amount, flag); } + public GameEvent(EventType type, UUID sourceId, UUID playerId, int amount, Token token) { + this(type, null, null, sourceId, playerId, amount, false, null, token); + } + public GameEvent(UUID customEventType, UUID targetId, UUID sourceId, UUID playerId) { this(EventType.CUSTOM_EVENT, customEventType, targetId, sourceId, playerId, 0, false); } @@ -398,11 +404,11 @@ public class GameEvent implements Serializable { private GameEvent(EventType type, UUID customEventType, UUID targetId, UUID sourceId, UUID playerId, int amount, boolean flag) { - this(type, customEventType, targetId, sourceId, playerId, amount, flag, null); + this(type, customEventType, targetId, sourceId, playerId, amount, flag, null, null); } private GameEvent(EventType type, UUID customEventType, - UUID targetId, UUID sourceId, UUID playerId, int amount, boolean flag, MageObjectReference reference) { + UUID targetId, UUID sourceId, UUID playerId, int amount, boolean flag, MageObjectReference reference, Token token) { this.type = type; this.customEventType = customEventType; this.targetId = targetId; @@ -411,6 +417,7 @@ public class GameEvent implements Serializable { this.playerId = playerId; this.flag = flag; this.reference = reference; + this.token = token; } public EventType getType() { @@ -445,6 +452,10 @@ public class GameEvent implements Serializable { this.amount = amount; } + public Token getToken() { return token; } + + public void setToken(Token token) { this.token = token; } + public void setAmountForCounters(int amount, boolean isEffect) { this.amount = amount; diff --git a/Mage/src/main/java/mage/game/permanent/token/TokenImpl.java b/Mage/src/main/java/mage/game/permanent/token/TokenImpl.java index 222b063c816..41008895f43 100644 --- a/Mage/src/main/java/mage/game/permanent/token/TokenImpl.java +++ b/Mage/src/main/java/mage/game/permanent/token/TokenImpl.java @@ -2,6 +2,7 @@ package mage.game.permanent.token; import mage.MageObject; import mage.MageObjectImpl; +import mage.MageObjectReference; import mage.abilities.Ability; import mage.cards.Card; import mage.constants.Zone; @@ -31,7 +32,7 @@ public abstract class TokenImpl extends MageObjectImpl implements Token { private boolean expansionSetCodeChecked; private Card copySourceCard; // the card the Token is a copy from - // list of set codes tokene images are available for + // list of set codes token images are available for protected List availableImageSetCodes = new ArrayList<>(); public enum Type { @@ -131,14 +132,7 @@ public abstract class TokenImpl extends MageObjectImpl implements Token { return putOntoBattlefield(amount, game, sourceId, controllerId, tapped, attacking, null); } - @Override - public boolean putOntoBattlefield(int amount, Game game, UUID sourceId, UUID controllerId, boolean tapped, boolean attacking, UUID attackedPlayer) { - Player controller = game.getPlayer(controllerId); - if (controller == null) { - return false; - } - lastAddedTokenIds.clear(); - + private String getSetCode(Game game, UUID sourceId) { // moved here from CreateTokenEffect because not all cards that create tokens use CreateTokenEffect // they use putOntoBattlefield directly // TODO: Check this setCode handling because it makes no sense if token put into play with e.g. "Feldon of the third Path" @@ -156,55 +150,76 @@ public abstract class TokenImpl extends MageObjectImpl implements Token { } } } + if (!expansionSetCodeChecked) { expansionSetCodeChecked = this.updateExpansionSetCode(setCode); } + return setCode; + } - GameEvent event = new GameEvent(EventType.CREATE_TOKEN, null, sourceId, controllerId, amount, this.isCreature()); + @Override + public boolean putOntoBattlefield(int amount, Game game, UUID sourceId, UUID controllerId, boolean tapped, boolean attacking, UUID attackedPlayer) { + Player controller = game.getPlayer(controllerId); + if (controller == null) { + return false; + } + lastAddedTokenIds.clear(); + + GameEvent event = new GameEvent(EventType.CREATE_TOKEN, sourceId, controllerId, amount, this); if (!game.replaceEvent(event)) { - amount = event.getAmount(); - - List permanents = new ArrayList<>(); - List permanentsEntered = new ArrayList<>(); - - for (int i = 0; i < amount; i++) { - PermanentToken newToken = new PermanentToken(this, event.getPlayerId(), setCode, game); // use event.getPlayerId() because it can be replaced by replacement effect - game.getState().addCard(newToken); - permanents.add(newToken); - game.getPermanentsEntering().put(newToken.getId(), newToken); - newToken.setTapped(tapped); - } - game.setScopeRelevant(true); - for (Permanent permanent : permanents) { - if (permanent.entersBattlefield(sourceId, game, Zone.OUTSIDE, true)) { - permanentsEntered.add(permanent); - } else { - game.getPermanentsEntering().remove(permanent.getId()); - } - } - game.setScopeRelevant(false); - for (Permanent permanent : permanentsEntered) { - game.addPermanent(permanent); - permanent.setZone(Zone.BATTLEFIELD, game); - game.getPermanentsEntering().remove(permanent.getId()); - - this.lastAddedTokenIds.add(permanent.getId()); - this.lastAddedTokenId = permanent.getId(); - game.addSimultaneousEvent(new ZoneChangeEvent(permanent, permanent.getControllerId(), Zone.OUTSIDE, Zone.BATTLEFIELD)); - if (attacking && game.getCombat() != null && game.getActivePlayerId().equals(permanent.getControllerId())) { - game.getCombat().addAttackingCreature(permanent.getId(), game, attackedPlayer); - } - if (!game.isSimulation()) { - game.informPlayers(controller.getLogName() + " creates a " + permanent.getLogName() + " token"); - } - - } - game.getState().applyEffects(game); // Needed to do it here without LKIReset i.e. do get SwordOfTheMeekTest running correctly. + putOntoBattlefieldHelper(event, game, tapped, attacking, attackedPlayer); return true; } return false; } + private static void putOntoBattlefieldHelper(GameEvent event, Game game, boolean tapped, boolean attacking, UUID attackedPlayer) { + Player controller = game.getPlayer(event.getPlayerId()); + Token token = event.getToken(); + int amount = event.getAmount(); + + List permanents = new ArrayList<>(); + List permanentsEntered = new ArrayList<>(); + + String setCode = token instanceof TokenImpl ? ((TokenImpl) token).getSetCode(game, event.getSourceId()) : null; + + for (int i = 0; i < amount; i++) { + PermanentToken newToken = new PermanentToken(token, event.getPlayerId(), setCode, game); // use event.getPlayerId() because it can be replaced by replacement effect + game.getState().addCard(newToken); + permanents.add(newToken); + game.getPermanentsEntering().put(newToken.getId(), newToken); + newToken.setTapped(tapped); + } + game.setScopeRelevant(true); + for (Permanent permanent : permanents) { + if (permanent.entersBattlefield(event.getSourceId(), game, Zone.OUTSIDE, true)) { + permanentsEntered.add(permanent); + } else { + game.getPermanentsEntering().remove(permanent.getId()); + } + } + game.setScopeRelevant(false); + for (Permanent permanent : permanentsEntered) { + game.addPermanent(permanent); + permanent.setZone(Zone.BATTLEFIELD, game); + game.getPermanentsEntering().remove(permanent.getId()); + + if (token instanceof TokenImpl) { + ((TokenImpl) token).lastAddedTokenIds.add(permanent.getId()); + ((TokenImpl) token).lastAddedTokenId = permanent.getId(); + } + game.addSimultaneousEvent(new ZoneChangeEvent(permanent, permanent.getControllerId(), Zone.OUTSIDE, Zone.BATTLEFIELD)); + if (attacking && game.getCombat() != null && game.getActivePlayerId().equals(permanent.getControllerId())) { + game.getCombat().addAttackingCreature(permanent.getId(), game, attackedPlayer); + } + if (!game.isSimulation()) { + game.informPlayers(controller.getLogName() + " creates a " + permanent.getLogName() + " token"); + } + + } + game.getState().applyEffects(game); // Needed to do it here without LKIReset i.e. do get SwordOfTheMeekTest running correctly. + } + @Override public void setPower(int power) { this.power.setValue(power); From 0d382d3875f65cebda842245b22a0f574d9bee4f Mon Sep 17 00:00:00 2001 From: dilnu Date: Mon, 3 Feb 2020 21:57:10 -0500 Subject: [PATCH 2/2] Move the Token field added from GameEvent to a subclass. --- .../src/mage/cards/d/DivineVisitation.java | 3 ++- .../src/mage/cards/g/GatherSpecimens.java | 3 ++- .../mage/game/events/CreateTokenEvent.java | 23 +++++++++++++++++++ .../main/java/mage/game/events/GameEvent.java | 17 +++----------- .../mage/game/permanent/token/TokenImpl.java | 5 ++-- 5 files changed, 33 insertions(+), 18 deletions(-) create mode 100644 Mage/src/main/java/mage/game/events/CreateTokenEvent.java diff --git a/Mage.Sets/src/mage/cards/d/DivineVisitation.java b/Mage.Sets/src/mage/cards/d/DivineVisitation.java index 6476f60c2df..a503985c70b 100644 --- a/Mage.Sets/src/mage/cards/d/DivineVisitation.java +++ b/Mage.Sets/src/mage/cards/d/DivineVisitation.java @@ -12,6 +12,7 @@ import mage.constants.Duration; import mage.constants.Outcome; import mage.constants.Zone; import mage.game.Game; +import mage.game.events.CreateTokenEvent; import mage.game.events.EntersTheBattlefieldEvent; import mage.game.events.GameEvent; import mage.game.permanent.Permanent; @@ -68,7 +69,7 @@ class DivineVisitationEffect extends ReplacementEffectImpl { @Override public boolean replaceEvent(GameEvent event, Ability source, Game game) { - event.setToken(new AngelVigilanceToken()); + ((CreateTokenEvent) event).setToken(new AngelVigilanceToken()); return false; } diff --git a/Mage.Sets/src/mage/cards/g/GatherSpecimens.java b/Mage.Sets/src/mage/cards/g/GatherSpecimens.java index b257d242c74..241e028bce9 100644 --- a/Mage.Sets/src/mage/cards/g/GatherSpecimens.java +++ b/Mage.Sets/src/mage/cards/g/GatherSpecimens.java @@ -10,6 +10,7 @@ import mage.constants.Duration; import mage.constants.Outcome; import mage.constants.Zone; import mage.game.Game; +import mage.game.events.CreateTokenEvent; import mage.game.events.GameEvent; import mage.game.events.ZoneChangeEvent; import mage.players.Player; @@ -76,7 +77,7 @@ class GatherSpecimensReplacementEffect extends ReplacementEffectImpl { } } } - if (event.getType() == GameEvent.EventType.CREATE_TOKEN && event.getToken().isCreature()) { + if (event.getType() == GameEvent.EventType.CREATE_TOKEN && ((CreateTokenEvent) event).getToken().isCreature()) { Player controller = game.getPlayer(source.getControllerId()); return controller != null && controller.hasOpponent(event.getPlayerId(), game); } diff --git a/Mage/src/main/java/mage/game/events/CreateTokenEvent.java b/Mage/src/main/java/mage/game/events/CreateTokenEvent.java new file mode 100644 index 00000000000..1e5022a3efe --- /dev/null +++ b/Mage/src/main/java/mage/game/events/CreateTokenEvent.java @@ -0,0 +1,23 @@ +package mage.game.events; + +import mage.game.Game; +import mage.game.permanent.token.Token; + +import java.util.UUID; + +public class CreateTokenEvent extends GameEvent { + private Token token; + + public CreateTokenEvent(UUID sourceId, UUID controllerId, int amount, Token token) { + super(EventType.CREATE_TOKEN, null, sourceId, controllerId, amount, false); + this.token = token; + } + + public Token getToken() { + return token; + } + + public void setToken(Token token) { + this.token = token; + } +} diff --git a/Mage/src/main/java/mage/game/events/GameEvent.java b/Mage/src/main/java/mage/game/events/GameEvent.java index c79e326a752..fb854bcdf1c 100644 --- a/Mage/src/main/java/mage/game/events/GameEvent.java +++ b/Mage/src/main/java/mage/game/events/GameEvent.java @@ -2,7 +2,6 @@ package mage.game.events; import mage.MageObjectReference; import mage.constants.Zone; -import mage.game.permanent.token.Token; import java.io.Serializable; import java.util.ArrayList; @@ -14,7 +13,6 @@ import java.util.UUID; */ public class GameEvent implements Serializable { - protected Token token; protected EventType type; protected UUID targetId; protected UUID sourceId; @@ -341,17 +339,13 @@ public class GameEvent implements Serializable { } public GameEvent(EventType type, UUID targetId, UUID sourceId, UUID playerId, MageObjectReference reference) { - this(type, null, targetId, sourceId, playerId, 0, false, reference, null); + this(type, null, targetId, sourceId, playerId, 0, false, reference); } public GameEvent(EventType type, UUID targetId, UUID sourceId, UUID playerId, int amount, boolean flag) { this(type, null, targetId, sourceId, playerId, amount, flag); } - public GameEvent(EventType type, UUID sourceId, UUID playerId, int amount, Token token) { - this(type, null, null, sourceId, playerId, amount, false, null, token); - } - public GameEvent(UUID customEventType, UUID targetId, UUID sourceId, UUID playerId) { this(EventType.CUSTOM_EVENT, customEventType, targetId, sourceId, playerId, 0, false); } @@ -404,11 +398,11 @@ public class GameEvent implements Serializable { private GameEvent(EventType type, UUID customEventType, UUID targetId, UUID sourceId, UUID playerId, int amount, boolean flag) { - this(type, customEventType, targetId, sourceId, playerId, amount, flag, null, null); + this(type, customEventType, targetId, sourceId, playerId, amount, flag, null); } private GameEvent(EventType type, UUID customEventType, - UUID targetId, UUID sourceId, UUID playerId, int amount, boolean flag, MageObjectReference reference, Token token) { + UUID targetId, UUID sourceId, UUID playerId, int amount, boolean flag, MageObjectReference reference) { this.type = type; this.customEventType = customEventType; this.targetId = targetId; @@ -417,7 +411,6 @@ public class GameEvent implements Serializable { this.playerId = playerId; this.flag = flag; this.reference = reference; - this.token = token; } public EventType getType() { @@ -452,10 +445,6 @@ public class GameEvent implements Serializable { this.amount = amount; } - public Token getToken() { return token; } - - public void setToken(Token token) { this.token = token; } - public void setAmountForCounters(int amount, boolean isEffect) { this.amount = amount; diff --git a/Mage/src/main/java/mage/game/permanent/token/TokenImpl.java b/Mage/src/main/java/mage/game/permanent/token/TokenImpl.java index 41008895f43..38c814c2b62 100644 --- a/Mage/src/main/java/mage/game/permanent/token/TokenImpl.java +++ b/Mage/src/main/java/mage/game/permanent/token/TokenImpl.java @@ -7,6 +7,7 @@ import mage.abilities.Ability; import mage.cards.Card; import mage.constants.Zone; import mage.game.Game; +import mage.game.events.CreateTokenEvent; import mage.game.events.GameEvent; import mage.game.events.GameEvent.EventType; import mage.game.events.ZoneChangeEvent; @@ -165,7 +166,7 @@ public abstract class TokenImpl extends MageObjectImpl implements Token { } lastAddedTokenIds.clear(); - GameEvent event = new GameEvent(EventType.CREATE_TOKEN, sourceId, controllerId, amount, this); + CreateTokenEvent event = new CreateTokenEvent(sourceId, controllerId, amount, this); if (!game.replaceEvent(event)) { putOntoBattlefieldHelper(event, game, tapped, attacking, attackedPlayer); return true; @@ -173,7 +174,7 @@ public abstract class TokenImpl extends MageObjectImpl implements Token { return false; } - private static void putOntoBattlefieldHelper(GameEvent event, Game game, boolean tapped, boolean attacking, UUID attackedPlayer) { + private static void putOntoBattlefieldHelper(CreateTokenEvent event, Game game, boolean tapped, boolean attacking, UUID attackedPlayer) { Player controller = game.getPlayer(event.getPlayerId()); Token token = event.getToken(); int amount = event.getAmount();