Implement "Promise a gift" mechanic (#12578)

* [BLB] Implement Wear Down * [BLB] Implement Valley Rally * [BLB] Implement Dawn's Truce * add initial test * [BLB] Implement Kitnap * [BLB] Implement Long River's Pull * [BLB] Implement Peerless Recycling * [BLB] Implement Into the Flood Maw * add more tests * add verify skip * remove skip * a few requested changes * [BLB] Implement Nocturnal Hunger * add test for gifting a food token * [BLB] Implement Starforged Sword * add comment to activation ket * add test for adding extra cards
2024-07-18 09:15:45 -04:00 · 2024-07-18 09:15:45 -04:00 · 7fe6ba9c57
commit 7fe6ba9c57
parent 0d3590e579
16 changed files with 956 additions and 1 deletions
--- a/Mage/src/main/java/mage/abilities/keyword/GiftAbility.java
+++ b/Mage/src/main/java/mage/abilities/keyword/GiftAbility.java
@ -0,0 +1,175 @@
+package mage.abilities.keyword;
+
+import mage.abilities.Ability;
+import mage.abilities.SpellAbility;
+import mage.abilities.StaticAbility;
+import mage.abilities.common.EntersBattlefieldTriggeredAbility;
+import mage.abilities.condition.common.GiftWasPromisedCondition;
+import mage.abilities.costs.*;
+import mage.abilities.decorator.ConditionalInterveningIfTriggeredAbility;
+import mage.abilities.effects.OneShotEffect;
+import mage.cards.Card;
+import mage.constants.GiftType;
+import mage.constants.Outcome;
+import mage.constants.Zone;
+import mage.game.Game;
+import mage.players.Player;
+import mage.target.TargetPlayer;
+import mage.target.common.TargetOpponent;
+import mage.util.CardUtil;
+
+import java.util.UUID;
+
+/**
+ * @author TheElk801
+ */
+public class GiftAbility extends StaticAbility implements OptionalAdditionalSourceCosts {
+
+    private static final String keywordText = "Gift";
+    private static final String reminderText = "You may promise an opponent a gift as you cast this spell. If you do, ";
+    private final String rule;
+
+    // this is set to null first when the player chooses to use it then set to the playerId later once the player is chosen
+    public static final String GIFT_ACTIVATION_VALUE_KEY = "giftPromisedActivation";
+
+    protected OptionalAdditionalCost additionalCost;
+    private final GiftType giftType;
+
+    private static String makeReminderText(GiftType giftType, boolean isPermanent) {
+        return reminderText + (isPermanent ? "when it enters, " : "") + "they " +
+                giftType.getDescription() + (isPermanent ? "." : " before its other effects.");
+    }
+
+    public GiftAbility(Card card, GiftType giftType) {
+        super(Zone.STACK, null);
+        this.additionalCost = new OptionalAdditionalCostImpl(
+                keywordText + ' ' + giftType,
+                makeReminderText(giftType, card.isPermanent()),
+                new PromiseGiftCost(giftType)
+        );
+        this.additionalCost.setRepeatable(false);
+        this.giftType = giftType;
+        this.rule = additionalCost.getName() + ' ' + additionalCost.getReminderText();
+        this.setRuleAtTheTop(true);
+        if (card.isPermanent()) {
+            this.addSubAbility(new ConditionalInterveningIfTriggeredAbility(
+                    new EntersBattlefieldTriggeredAbility(new PromiseGiftEffect(giftType)),
+                    GiftWasPromisedCondition.TRUE, "When this permanent enters, " +
+                    "if the gift was promised, they " + giftType.getDescription() + '.'
+            ).setRuleVisible(false));
+        } else {
+            card.getSpellAbility().addEffect(new PromiseGiftEffect(giftType));
+        }
+    }
+
+    private GiftAbility(final GiftAbility ability) {
+        super(ability);
+        this.rule = ability.rule;
+        this.additionalCost = ability.additionalCost.copy();
+        this.giftType = ability.giftType;
+    }
+
+    @Override
+    public GiftAbility copy() {
+        return new GiftAbility(this);
+    }
+
+    @Override
+    public void addOptionalAdditionalCosts(Ability ability, Game game) {
+        if (!(ability instanceof SpellAbility)) {
+            return;
+        }
+        Player player = game.getPlayer(ability.getControllerId());
+        if (player == null) {
+            return;
+        }
+        additionalCost.reset();
+        if (!additionalCost.canPay(ability, this, ability.getControllerId(), game)
+                || !player.chooseUse(Outcome.Benefit, "Promise an opponent " + giftType.getName() + '?', ability, game)) {
+            return;
+        }
+        additionalCost.activate();
+        for (Cost cost : ((Costs<Cost>) additionalCost)) {
+            ability.getCosts().add(cost.copy());
+        }
+        ability.setCostsTag(GIFT_ACTIVATION_VALUE_KEY, null);
+    }
+
+    @Override
+    public String getCastMessageSuffix() {
+        return additionalCost.getCastSuffixMessage(0);
+    }
+
+    @Override
+    public String getRule() {
+        return rule;
+    }
+}
+
+class PromiseGiftCost extends CostImpl {
+
+    PromiseGiftCost(GiftType giftType) {
+        text = "Gift " + giftType.getName();
+    }
+
+    private PromiseGiftCost(final PromiseGiftCost cost) {
+        super(cost);
+    }
+
+    @Override
+    public boolean canPay(Ability ability, Ability source, UUID controllerId, Game game) {
+        return true;
+    }
+
+    @Override
+    public boolean pay(Ability ability, Game game, Ability source, UUID controllerId, boolean noMana, Cost costToPay) {
+        Player player = game.getPlayer(controllerId);
+        if (player == null) {
+            return paid;
+        }
+        TargetPlayer target = new TargetOpponent();
+        target.withNotTarget(true);
+        player.choose(Outcome.Detriment, target, source, game);
+        Player opponent = game.getPlayer(target.getFirstTarget());
+        if (opponent == null) {
+            return paid;
+        }
+        source.setCostsTag(GiftAbility.GIFT_ACTIVATION_VALUE_KEY, opponent.getId());
+        paid = true;
+        return paid;
+    }
+
+    @Override
+    public PromiseGiftCost copy() {
+        return new PromiseGiftCost(this);
+    }
+
+}
+
+class PromiseGiftEffect extends OneShotEffect {
+
+    private final GiftType giftType;
+
+    PromiseGiftEffect(GiftType giftType) {
+        super(Outcome.Benefit);
+        this.giftType = giftType;
+    }
+
+    private PromiseGiftEffect(final PromiseGiftEffect effect) {
+        super(effect);
+        this.giftType = effect.giftType;
+    }
+
+    @Override
+    public PromiseGiftEffect copy() {
+        return new PromiseGiftEffect(this);
+    }
+
+    @Override
+    public boolean apply(Game game, Ability source) {
+        Player player = game.getPlayer(CardUtil.getSourceCostsTag(
+                game, source, GiftAbility.GIFT_ACTIVATION_VALUE_KEY, (UUID) null
+        ));
+        return player != null && giftType.applyGift(player, game, source);
+    }
+}