Add new methods to Target and TargetPointer to help generate card rules text. Currently only used by ExileUntilSourceLeavesEffect

This commit is contained in:
Alex W. Jackson 2022-09-04 05:15:12 -04:00
parent c6e1ce6697
commit addfd5166e
38 changed files with 156 additions and 208 deletions

View file

@ -1,10 +1,12 @@
package mage.abilities.effects.common;
import mage.abilities.Ability;
import mage.abilities.Mode;
import mage.abilities.effects.OneShotEffect;
import mage.constants.Outcome;
import mage.game.Game;
import mage.game.permanent.Permanent;
import mage.target.Target;
import mage.util.CardUtil;
/**
@ -13,9 +15,8 @@ import mage.util.CardUtil;
*/
public class ExileUntilSourceLeavesEffect extends OneShotEffect {
public ExileUntilSourceLeavesEffect(String targetName) {
public ExileUntilSourceLeavesEffect() {
super(Outcome.Removal);
this.staticText = "exile target " + targetName + " an opponent controls until {this} leaves the battlefield";
}
public ExileUntilSourceLeavesEffect(final ExileUntilSourceLeavesEffect effect) {
@ -29,13 +30,10 @@ public class ExileUntilSourceLeavesEffect extends OneShotEffect {
@Override
public boolean apply(Game game, Ability source) {
Permanent permanent = game.getPermanent(source.getSourceId());
if (permanent == null) {
return false;
}
Permanent permanent = source.getSourcePermanentIfItStillExists(game);
// If Banishing Light leaves the battlefield before its triggered ability resolves, the target permanent won't be exiled.
// (2021-03-19)
if (game.getPermanent(source.getSourceId()) == null) {
if (permanent == null) {
return false;
}
@ -45,4 +43,12 @@ public class ExileUntilSourceLeavesEffect extends OneShotEffect {
}
return effect.apply(game, source);
}
@Override
public String getText(Mode mode) {
if (staticText != null && !staticText.isEmpty()) {
return staticText;
}
return "exile " + getTargetPointer().describeTargets(mode.getTargets(), "that creature") + " until {this} leaves the battlefield";
}
}

View file

@ -438,6 +438,13 @@ public final class StaticFilters {
FILTER_OPPONENTS_PERMANENT.setLockedFilter(true);
}
public static final FilterNonlandPermanent FILTER_OPPONENTS_PERMANENT_NON_LAND = new FilterNonlandPermanent("nonland permanent an opponent controls");
static {
FILTER_OPPONENTS_PERMANENT_NON_LAND.add(TargetController.OPPONENT.getControllerPredicate());
FILTER_OPPONENTS_PERMANENT_NON_LAND.setLockedFilter(true);
}
public static final FilterCreaturePermanent FILTER_OPPONENTS_PERMANENT_CREATURE = new FilterOpponentsCreaturePermanent();
static {

View file

@ -88,6 +88,8 @@ public interface Target extends Serializable {
void updateTarget(UUID targetId, Game game);
String getDescription();
String getMessage();
String getTargetName();

View file

@ -97,6 +97,24 @@ public abstract class TargetImpl implements Target {
this.maxNumberOfTargets = maxNumberOftargets;
}
@Override
public String getDescription() {
// target description for ability text
StringBuilder sb = new StringBuilder();
if (getNumberOfTargets() != 1 || getMaxNumberOfTargets() != 1) {
if (getNumberOfTargets() < getMaxNumberOfTargets() && getMaxNumberOfTargets() != Integer.MAX_VALUE) {
sb.append("up to ");
}
sb.append(CardUtil.numberToText(getMaxNumberOfTargets()));
sb.append(' ');
}
if (!isNotTarget() && !getTargetName().contains("target")) {
sb.append("target ");
}
sb.append(getTargetName());
return sb.toString();
}
@Override
public String getMessage() {
// UI choose message

View file

@ -6,6 +6,7 @@ import mage.cards.Card;
import mage.constants.Zone;
import mage.game.Game;
import mage.game.permanent.Permanent;
import mage.target.Targets;
import java.util.*;
@ -117,4 +118,9 @@ public class FirstTargetPointer extends TargetPointerImpl {
}
return permanent;
}
@Override
public String describeTargets(Targets targets, String defaultDescription) {
return targets.isEmpty() ? defaultDescription : targets.get(0).getDescription();
}
}

View file

@ -6,6 +6,7 @@ import mage.cards.Card;
import mage.constants.Zone;
import mage.game.Game;
import mage.game.permanent.Permanent;
import mage.target.Targets;
import java.util.*;
@ -114,4 +115,9 @@ public class SecondTargetPointer extends TargetPointerImpl {
}
return null;
}
@Override
public String describeTargets(Targets targets, String defaultDescription) {
return targets.size() < 2 ? defaultDescription : targets.get(1).getDescription();
}
}

View file

@ -3,6 +3,7 @@ package mage.target.targetpointer;
import mage.abilities.Ability;
import mage.game.Game;
import mage.game.permanent.Permanent;
import mage.target.Targets;
import mage.util.Copyable;
import java.io.Serializable;
@ -37,6 +38,16 @@ public interface TargetPointer extends Serializable, Copyable<TargetPointer> {
*/
Permanent getFirstTargetPermanentOrLKI(Game game, Ability source);
/**
* Returns description of targets for ability text
*
* @param targets
* @param defaultText
*/
default String describeTargets(Targets targets, String defaultDescription) {
return defaultDescription;
}
/**
* Store text to target pointer (usefull to keep data for specific trigger, e.g. selected target name for rules)
*

View file

@ -6,6 +6,7 @@ import mage.cards.Card;
import mage.constants.Zone;
import mage.game.Game;
import mage.game.permanent.Permanent;
import mage.target.Targets;
import java.util.*;
@ -118,4 +119,9 @@ public class ThirdTargetPointer extends TargetPointerImpl {
}
return null;
}
@Override
public String describeTargets(Targets targets, String defaultDescription) {
return targets.size() < 3 ? defaultDescription : targets.get(2).getDescription();
}
}