External/mage
1
0
Fork 1
mirror of https://github.com/magefree/mage.git synced 2026-01-09 12:22:10 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clean up triggered ability text generation (#10627)

Browse source 
* move "or battle" to its own class

* move "or planeswalker" to its own class

* remove strange way of setting custom text

* finally remove getTriggerPhrase

* copy constructor visibility

* fix Vraska
This commit is contained in:
xenohedron 2023-07-15 16:49:40 -04:00 • committed by GitHub
parent e2cff095b3
commit a7f78e8190
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 232 additions and 191 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Mage/src/main/java/mage/abilities/TriggeredAbility.java
View file

@ -58,12 +58,5 @@ public interface TriggeredAbility extends Ability {
GameEvent getTriggerEvent();
/**
* Don't override this. Use setTriggerPhrase instead and let the base class handle it.
* @return
*/
@Deprecated
String getTriggerPhrase();
TriggeredAbility setTriggerPhrase(String triggerPhrase);
}

12
Mage/src/main/java/mage/abilities/TriggeredAbilityImpl.java
View file

@ -27,7 +27,7 @@ public abstract class TriggeredAbilityImpl extends AbilityImpl implements Trigge
private boolean triggersOnceEachTurn = false;
private boolean doOnlyOnceEachTurn = false;
private GameEvent triggerEvent = null;
private String triggerPhrase = null; // TODO: This should be change to final and all constructers to set a value
private String triggerPhrase = null; // TODO: This could be changed to final if all constructors set a value
protected TriggeredAbilityImpl(Zone zone, Effect effect) {
this(zone, effect, false);
@ -67,7 +67,7 @@ public abstract class TriggeredAbilityImpl extends AbilityImpl implements Trigge
}
}
private final void setLastTrigger(Game game) {
private void setLastTrigger(Game game) {
if (!triggersOnceEachTurn) {
return;
}
@ -188,7 +188,7 @@ public abstract class TriggeredAbilityImpl extends AbilityImpl implements Trigge
}
sb.append(prefix);
sb.append(triggerPhrase == null ? getTriggerPhrase() : triggerPhrase);
sb.append(triggerPhrase == null ? "" : triggerPhrase);
String superRule = super.getRule(true);
if (!superRule.isEmpty()) {
@ -250,12 +250,6 @@ public abstract class TriggeredAbilityImpl extends AbilityImpl implements Trigge
return sb.toString();
}
@Override
@Deprecated
public String getTriggerPhrase() {
return "";
}
@Override
public boolean isInUseableZone(Game game, MageObject source, GameEvent event) {

53
Mage/src/main/java/mage/abilities/common/DealsCombatDamageToAPlayerOrBattleTriggeredAbility.java Normal file
View file

@ -0,0 +1,53 @@
package mage.abilities.common;
import mage.abilities.TriggeredAbilityImpl;
import mage.abilities.effects.Effect;
import mage.constants.Zone;
import mage.game.Game;
import mage.game.events.DamagedEvent;
import mage.game.events.GameEvent;
import mage.game.permanent.Permanent;
/**
* @author xenohedron
*/
public class DealsCombatDamageToAPlayerOrBattleTriggeredAbility extends TriggeredAbilityImpl {
public DealsCombatDamageToAPlayerOrBattleTriggeredAbility(Effect effect, boolean optional) {
super(Zone.BATTLEFIELD, effect, optional);
setTriggerPhrase("Whenever {this} deals combat damage to a player or battle, ");
}
protected DealsCombatDamageToAPlayerOrBattleTriggeredAbility(final DealsCombatDamageToAPlayerOrBattleTriggeredAbility ability) {
super(ability);
}
@Override
public DealsCombatDamageToAPlayerOrBattleTriggeredAbility copy() {
return new DealsCombatDamageToAPlayerOrBattleTriggeredAbility(this);
}
@Override
public boolean checkEventType(GameEvent event, Game game) {
return event.getType() == GameEvent.EventType.DAMAGED_PLAYER
|| event.getType() == GameEvent.EventType.DAMAGED_PERMANENT;
}
@Override
public boolean checkTrigger(GameEvent event, Game game) {
if (!event.getSourceId().equals(getSourceId())
|| !((DamagedEvent) event).isCombatDamage()) {
return false;
}
if (event.getType() == GameEvent.EventType.DAMAGED_PERMANENT) {
Permanent permanent = game.getPermanent(event.getTargetId());
if (permanent == null || !permanent.isBattle(game)) {
return false;
}
}
getAllEffects().setValue("damage", event.getAmount());
return true;
}
}

53
Mage/src/main/java/mage/abilities/common/DealsCombatDamageToAPlayerOrPlaneswalkerTriggeredAbility.java Normal file
View file

@ -0,0 +1,53 @@
package mage.abilities.common;
import mage.abilities.TriggeredAbilityImpl;
import mage.abilities.effects.Effect;
import mage.constants.Zone;
import mage.game.Game;
import mage.game.events.DamagedEvent;
import mage.game.events.GameEvent;
import mage.game.permanent.Permanent;
/**
* @author xenohedron
*/
public class DealsCombatDamageToAPlayerOrPlaneswalkerTriggeredAbility extends TriggeredAbilityImpl {
public DealsCombatDamageToAPlayerOrPlaneswalkerTriggeredAbility(Effect effect, boolean optional) {
super(Zone.BATTLEFIELD, effect, optional);
setTriggerPhrase("Whenever {this} deals combat damage to a player or planeswalker, ");
}
protected DealsCombatDamageToAPlayerOrPlaneswalkerTriggeredAbility(final DealsCombatDamageToAPlayerOrPlaneswalkerTriggeredAbility ability) {
super(ability);
}
@Override
public DealsCombatDamageToAPlayerOrPlaneswalkerTriggeredAbility copy() {
return new DealsCombatDamageToAPlayerOrPlaneswalkerTriggeredAbility(this);
}
@Override
public boolean checkEventType(GameEvent event, Game game) {
return event.getType() == GameEvent.EventType.DAMAGED_PLAYER
|| event.getType() == GameEvent.EventType.DAMAGED_PERMANENT;
}
@Override
public boolean checkTrigger(GameEvent event, Game game) {
if (!event.getSourceId().equals(getSourceId())
|| !((DamagedEvent) event).isCombatDamage()) {
return false;
}
if (event.getType() == GameEvent.EventType.DAMAGED_PERMANENT) {
Permanent permanent = game.getPermanent(event.getTargetId());
if (permanent == null || !permanent.isPlaneswalker(game)) {
return false;
}
}
getAllEffects().setValue("damage", event.getAmount());
return true;
}
}

67
Mage/src/main/java/mage/abilities/common/DealsCombatDamageToAPlayerTriggeredAbility.java
View file

@ -6,7 +6,6 @@ import mage.constants.Zone;
import mage.game.Game;
import mage.game.events.DamagedEvent;
import mage.game.events.GameEvent;
import mage.game.permanent.Permanent;
import mage.target.targetpointer.FixedTarget;
/**
@ -15,48 +14,20 @@ import mage.target.targetpointer.FixedTarget;
public class DealsCombatDamageToAPlayerTriggeredAbility extends TriggeredAbilityImpl {
protected final boolean setTargetPointer;
protected String text;
protected boolean onlyOpponents;
private boolean orPlaneswalker = false;
private boolean orBattle = false;
public DealsCombatDamageToAPlayerTriggeredAbility(Effect effect, boolean optional) {
this(effect, optional, false);
}
public DealsCombatDamageToAPlayerTriggeredAbility(Effect effect, boolean optional, boolean setTargetPointer) {
this(effect, optional, setTargetPointer, false);
}
public DealsCombatDamageToAPlayerTriggeredAbility(Effect effect, boolean optional, boolean setTargetPointer, boolean onlyOpponents) {
super(Zone.BATTLEFIELD, effect, optional);
this.setTargetPointer = setTargetPointer;
this.onlyOpponents = onlyOpponents;
setTriggerPhrase("Whenever {this} deals combat damage to a player, ");
}
public DealsCombatDamageToAPlayerTriggeredAbility(Effect effect, boolean optional, String text, boolean setTargetPointer) {
super(Zone.BATTLEFIELD, effect, optional);
this.text = text;
this.setTargetPointer = setTargetPointer;
}
public DealsCombatDamageToAPlayerTriggeredAbility(final DealsCombatDamageToAPlayerTriggeredAbility ability) {
protected DealsCombatDamageToAPlayerTriggeredAbility(final DealsCombatDamageToAPlayerTriggeredAbility ability) {
super(ability);
this.text = ability.text;
this.setTargetPointer = ability.setTargetPointer;
this.onlyOpponents = ability.onlyOpponents;
this.orPlaneswalker = ability.orPlaneswalker;
this.orBattle = ability.orBattle;
}
public DealsCombatDamageToAPlayerTriggeredAbility setOrPlaneswalker(boolean orPlaneswalker) {
this.orPlaneswalker = orPlaneswalker;
return this;
}
public DealsCombatDamageToAPlayerTriggeredAbility setOrBattle(boolean orBattle) {
this.orBattle = orBattle;
return this;
}
@Override
@ -66,8 +37,7 @@ public class DealsCombatDamageToAPlayerTriggeredAbility extends TriggeredAbility
@Override
public boolean checkEventType(GameEvent event, Game game) {
return event.getType() == GameEvent.EventType.DAMAGED_PLAYER
|| event.getType() == GameEvent.EventType.DAMAGED_PERMANENT;
return event.getType() == GameEvent.EventType.DAMAGED_PLAYER;
}
@Override
@ -76,20 +46,6 @@ public class DealsCombatDamageToAPlayerTriggeredAbility extends TriggeredAbility
|| !((DamagedEvent) event).isCombatDamage()) {
return false;
}
switch (event.getType()) {
case DAMAGED_PLAYER:
if (onlyOpponents && !game.getOpponents(getControllerId()).contains(event.getTargetId())) {
return false;
}
break;
case DAMAGED_PERMANENT:
Permanent permanent = game.getPermanent(event.getTargetId());
if (permanent == null
|| (!orPlaneswalker || !permanent.isPlaneswalker(game))
&& (!orBattle || !permanent.isBattle(game))) {
return false;
}
}
getAllEffects().setValue("damage", event.getAmount());
if (setTargetPointer) {
getAllEffects().setTargetPointer(new FixedTarget(event.getPlayerId()));
@ -97,21 +53,4 @@ public class DealsCombatDamageToAPlayerTriggeredAbility extends TriggeredAbility
return true;
}
@Override
public String getRule() {
if (text == null || text.isEmpty()) {
return super.getRule();
}
return text;
}
// TODO: This class needs refactoring to specify onlyOppontns and OrPLaneswalkers in constructor
@Override
public String getTriggerPhrase() {
return "Whenever {this} deals combat damage to "
+ (onlyOpponents ? "an opponent" : "a player")
+ (orPlaneswalker ? " or planeswalker" : "")
+ (orBattle ? " or battle" : "")
+ ", ";
}
}