foul-magics/Mage/src/main/java/mage/abilities/costs/mana/ManaCostImpl.java
Oleg Agafonov bae3089abb Reworked cost adjuster logic for better support of X and cost modification effects:
Improves:
* refactor: split CostAdjuster logic in multiple parts - prepare X, prepare cost, increase cost, reduce cost;
* refactor: improved VariableManaCost to support min/max values, playable and AI calculations, test framework;
* refactor: improved EarlyTargetCost to support mana costs too (related to #13023);
* refactor: migrated some cards with CostAdjuster and X to EarlyTargetCost (Knollspine Invocation, etc - related to #13023);
* refactor: added shared code for "As an additional cost to cast this spell, discard X creature cards";
* refactor: added shared code for "X is the converted mana cost of the exiled card";
* tests: added dozens tests with cost adjusters;

Bug fixes:
* game: fixed that some cards with CostAdjuster ignore min/max limits for X (allow to choose any X, example: Scorched Earth, Open The Way);
* game: fixed that some cards ask to announce already defined X values (example: Bargaining Table);
* game: fixed that some cards with CostAdjuster do not support combo with other cost modification effects;
* game, gui: fixed missing game logs about predefined X values;
* game, gui: fixed wrong X icon for predefined X values;

Test framework:
* test framework: added X min/max check for wrong values;
* test framework: added X min/max info in miss X value announce;
* test framework: added check to find duplicated effect bugs (see assertNoDuplicatedEffects);

Cards:
* Open The Way - fixed that it allow to choose any X without limits (close #12810);
* Unbound Flourishing - improved combo support for activated abilities with predefined X mana costs like Bargaining Table;
2025-04-08 22:39:10 +04:00

331 lines
10 KiB
Java

package mage.abilities.costs.mana;
import mage.Mana;
import mage.abilities.Ability;
import mage.abilities.AbilityImpl;
import mage.abilities.costs.Cost;
import mage.abilities.costs.CostImpl;
import mage.abilities.mana.ManaOptions;
import mage.constants.ColoredManaSymbol;
import mage.constants.ManaType;
import mage.filter.Filter;
import mage.filter.FilterMana;
import mage.game.Game;
import mage.players.ManaPool;
import mage.players.Player;
import mage.util.ManaUtil;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
public abstract class ManaCostImpl extends CostImpl implements ManaCost {
protected Mana payment;
protected Mana usedManaToPay;
protected Mana cost;
protected ManaOptions options;
protected Filter sourceFilter;
protected boolean phyrexian = false;
public ManaCostImpl() {
payment = new Mana();
usedManaToPay = new Mana();
options = new ManaOptions();
}
protected ManaCostImpl(final ManaCostImpl manaCost) {
super(manaCost);
this.payment = manaCost.payment.copy();
this.usedManaToPay = manaCost.usedManaToPay.copy();
this.cost = manaCost.cost.copy();
this.options = manaCost.options.copy();
if (manaCost.sourceFilter != null) {
this.sourceFilter = manaCost.sourceFilter.copy();
}
this.phyrexian = manaCost.phyrexian;
}
@Override
abstract public ManaCostImpl copy();
@Override
public Mana getPayment() {
return payment;
}
@Override
public Mana getUsedManaToPay() {
return usedManaToPay;
}
@Override
public Mana getMana() {
return cost;
}
@Override
public List<Mana> getManaOptions() {
List<Mana> manaList = new ArrayList<>();
manaList.add(cost);
return manaList;
}
@Override
public final ManaOptions getOptions() {
return getOptions(true);
}
@Override
public ManaOptions getOptions(boolean canPayLifeCost) {
if (!canPayLifeCost && this.isPhyrexian()) {
ManaOptions optionsFiltered = new ManaOptions();
optionsFiltered.add(this.cost);
return optionsFiltered;
} else {
return options;
}
}
@Override
public void clearPaid() {
super.clearPaid();
payment.clear();
usedManaToPay.clear();
}
@Override
public Filter getSourceFilter() {
return this.sourceFilter;
}
/*
* Restrict the allowed mana sources to pay the cost
*
* e.g. Spend only mana produced by basic lands to cast Imperiosaur.
* uses:
* private static final FilterLandPermanent filter = new FilterLandPermanent();
* static { filter.add(new SupertypePredicate("Basic")); }
*
* It will be cecked in ManaPool.pay method
*
*/
@Override
public void setSourceFilter(Filter filter) {
this.sourceFilter = filter;
}
protected boolean assignColored(Ability ability, Game game, ManaPool pool, ColoredManaSymbol mana, Cost costToPay) {
// first check special mana
switch (mana) {
case W:
if (pool.pay(ManaType.WHITE, ability, sourceFilter, game, costToPay, usedManaToPay)) {
this.payment.increaseWhite();
return true;
}
break;
case U:
if (pool.pay(ManaType.BLUE, ability, sourceFilter, game, costToPay, usedManaToPay)) {
this.payment.increaseBlue();
return true;
}
break;
case B:
if (pool.pay(ManaType.BLACK, ability, sourceFilter, game, costToPay, usedManaToPay)) {
this.payment.increaseBlack();
return true;
}
break;
case R:
if (pool.pay(ManaType.RED, ability, sourceFilter, game, costToPay, usedManaToPay)) {
this.payment.increaseRed();
return true;
}
break;
case G:
if (pool.pay(ManaType.GREEN, ability, sourceFilter, game, costToPay, usedManaToPay)) {
this.payment.increaseGreen();
return true;
}
break;
}
return false;
}
protected boolean assignColorless(Ability ability, Game game, ManaPool pool, int mana, Cost costToPay) {
int conditionalCount = pool.getConditionalCount(ability, game, null, costToPay);
if (mana > payment.count() && (pool.count() > 0 || conditionalCount > 0)
&& pool.pay(ManaType.COLORLESS, ability, sourceFilter, game, costToPay, usedManaToPay)) {
this.payment.increaseColorless();
return true;
}
return false;
}
protected boolean assignGeneric(Ability ability, Game game, ManaPool pool, int mana, FilterMana filterMana, Cost costToPay) {
int conditionalCount = pool.getConditionalCount(ability, game, filterMana, costToPay);
while (mana > payment.count() && (pool.count() > 0 || conditionalCount > 0)) {
// try to use different mana to pay (conditional mana will used in pool.pay)
// filterMana can be null, uses for spells like "spend only black mana on X"
// {C}
if ((filterMana == null || filterMana.isColorless()) && pool.pay(
ManaType.COLORLESS, ability, sourceFilter, game, costToPay, usedManaToPay
)) {
this.payment.increaseColorless();
continue;
}
// {B}
if ((filterMana == null || filterMana.isBlack()) && pool.pay(
ManaType.BLACK, ability, sourceFilter, game, costToPay, usedManaToPay
)) {
this.payment.increaseBlack();
continue;
}
// {U}
if ((filterMana == null || filterMana.isBlue()) && pool.pay(
ManaType.BLUE, ability, sourceFilter, game, costToPay, usedManaToPay
)) {
this.payment.increaseBlue();
continue;
}
// {W}
if ((filterMana == null || filterMana.isWhite()) && pool.pay(
ManaType.WHITE, ability, sourceFilter, game, costToPay, usedManaToPay
)) {
this.payment.increaseWhite();
continue;
}
// {G}
if ((filterMana == null || filterMana.isGreen()) && pool.pay(
ManaType.GREEN, ability, sourceFilter, game, costToPay, usedManaToPay
)) {
this.payment.increaseGreen();
continue;
}
// {R}
if ((filterMana == null || filterMana.isRed()) && pool.pay(
ManaType.RED, ability, sourceFilter, game, costToPay, usedManaToPay
)) {
this.payment.increaseRed();
continue;
}
// nothing to pay
break;
}
return mana > payment.count();
}
protected boolean isColoredPaid(ColoredManaSymbol mana) {
switch (mana) {
case B:
return this.payment.getBlack() > 0;
case U:
return this.payment.getBlue() > 0;
case W:
return this.payment.getWhite() > 0;
case G:
return this.payment.getGreen() > 0;
case R:
return this.payment.getRed() > 0;
}
return false;
}
protected boolean isColorlessPaid(int mana) {
return this.payment.count() >= mana;
}
@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) {
if (noMana) {
setPaid();
return true;
}
Player player = game.getPlayer(controllerId);
if (player == null) {
return false;
}
// no needs to call
//AbilityImpl.handlePhyrexianLikeEffects(game, source, ability, this);
if (!player.getManaPool().isForcedToPay()) {
assignPayment(game, ability, player.getManaPool(), costToPay != null ? costToPay : this);
}
game.getState().getSpecialActions().removeManaActions();
while (player.canRespond() && !isPaid()) {
ManaCost unpaid = this.getUnpaid();
String promptText = ManaUtil.addSpecialManaPayAbilities(ability, game, unpaid);
if (player.playMana(ability, unpaid, promptText, game)) {
assignPayment(game, ability, player.getManaPool(), costToPay != null ? costToPay : this);
} else {
return false;
}
game.getState().getSpecialActions().removeManaActions();
}
return isPaid();
}
@Override
public void setPaid() {
this.paid = true;
}
@Override
public void setPayment(Mana mana) {
this.payment.add(mana);
}
protected void addColoredOption(ColoredManaSymbol symbol) {
switch (symbol) {
case B:
this.options.add(Mana.BlackMana(1));
return;
case U:
this.options.add(Mana.BlueMana(1));
return;
case W:
this.options.add(Mana.WhiteMana(1));
return;
case R:
this.options.add(Mana.RedMana(1));
return;
case G:
this.options.add(Mana.GreenMana(1));
return;
default:
this.options.add(Mana.ColorlessMana(1));
}
}
@Override
public String toString() {
return getText();
}
@Override
public boolean isPhyrexian() {
return phyrexian;
}
@Override
public void setPhyrexian(boolean phyrexian) {
if (phyrexian) {
this.options.add(Mana.GenericMana(0));
}
this.phyrexian = phyrexian;
}
}