refactor: improved usage of one time turn modifications (skip step, extra turn, etc)

This commit is contained in:
Oleg Agafonov 2023-07-31 20:16:28 +04:00
parent 4554fbc408
commit 8d938926b6
46 changed files with 222 additions and 190 deletions

View file

@ -34,9 +34,7 @@ public class OpponentDrawCardExceptFirstCardDrawStepTriggeredAbility extends Tri
if (game.isActivePlayer(event.getPlayerId())
&& game.getPhase().getStep().getType() == PhaseStep.DRAW) {
CardsDrawnDuringDrawStepWatcher watcher = game.getState().getWatcher(CardsDrawnDuringDrawStepWatcher.class);
if (watcher != null && watcher.getAmountCardsDrawn(event.getPlayerId()) > 1) {
return true;
}
return watcher != null && watcher.getAmountCardsDrawn(event.getPlayerId()) > 1;
} else {
return true;
}

View file

@ -38,7 +38,7 @@ public class AddCombatAndMainPhaseEffect extends OneShotEffect {
if (game.getTurnPhaseType() == TurnPhase.PRECOMBAT_MAIN
|| game.getTurnPhaseType() == TurnPhase.POSTCOMBAT_MAIN) {
// we can't add two turn modes at once, will add additional post combat on delayed trigger resolution
TurnMod combat = new TurnMod(source.getControllerId(), TurnPhase.COMBAT, TurnPhase.POSTCOMBAT_MAIN, false);
TurnMod combat = new TurnMod(source.getControllerId()).withExtraPhase(TurnPhase.COMBAT, TurnPhase.POSTCOMBAT_MAIN);
game.getState().getTurnMods().add(combat);
DelayedAddMainPhaseAbility delayedTriggeredAbility = new DelayedAddMainPhaseAbility();
delayedTriggeredAbility.setConnectedTurnMod(combat.getId());
@ -83,7 +83,7 @@ class DelayedAddMainPhaseAbility extends DelayedTriggeredAbility {
}
if (event.getType() == GameEvent.EventType.COMBAT_PHASE_PRE && enabled) {
// add additional post combat main phase after that - after phase == null because add it after this combat
game.getState().getTurnMods().add(new TurnMod(getControllerId(), TurnPhase.POSTCOMBAT_MAIN, null, false));
game.getState().getTurnMods().add(new TurnMod(getControllerId()).withExtraPhase(TurnPhase.POSTCOMBAT_MAIN));
enabled = false;
}
return false;

View file

@ -30,8 +30,7 @@ public class AdditionalCombatPhaseEffect extends OneShotEffect {
@Override
public boolean apply(Game game, Ability source) {
game.getState().getTurnMods().add(new TurnMod(game.getState().getActivePlayerId(),
TurnPhase.COMBAT, null, false));
game.getState().getTurnMods().add(new TurnMod(game.getState().getActivePlayerId()).withExtraPhase(TurnPhase.COMBAT));
return true;
}
}

View file

@ -60,7 +60,7 @@ public class SkipNextDrawStepControllerEffect extends OneShotEffect {
public boolean apply(Game game, Ability source) {
Player player = game.getPlayer(source.getControllerId());
if (player != null) {
game.getState().getTurnMods().add(new TurnMod(player.getId(), PhaseStep.DRAW));
game.getState().getTurnMods().add(new TurnMod(player.getId()).withSkipStep(PhaseStep.DRAW));
return true;
}
return false;

View file

@ -68,7 +68,7 @@ public class SkipNextPlayerUntapStepEffect extends OneShotEffect {
}
}
if (player != null) {
game.getState().getTurnMods().add(new TurnMod(player.getId(), PhaseStep.UNTAP));
game.getState().getTurnMods().add(new TurnMod(player.getId()).withSkipStep(PhaseStep.UNTAP));
return true;
}
return false;

View file

@ -59,7 +59,7 @@ public class AddExtraTurnControllerEffect extends OneShotEffect {
if (player == null) {
return true;
}
TurnMod extraTurn = new TurnMod(player.getId(), false);
TurnMod extraTurn = new TurnMod(player.getId()).withExtraTurn();
game.getState().getTurnMods().add(extraTurn);
if (loseGameAtEnd) {
game.addDelayedTriggeredAbility(new LoseGameDelayedTriggeredAbility(extraTurn.getId()), source);

View file

@ -29,7 +29,7 @@ public class AddExtraTurnTargetEffect extends OneShotEffect {
@Override
public boolean apply(Game game, Ability source) {
if (this.getTargetPointer().getFirst(game, source) != null) {
game.getState().getTurnMods().add(new TurnMod(this.getTargetPointer().getFirst(game, source), false));
game.getState().getTurnMods().add(new TurnMod(this.getTargetPointer().getFirst(game, source)).withExtraTurn());
}
return true;
}

View file

@ -5,7 +5,9 @@ import mage.abilities.effects.OneShotEffect;
import mage.constants.Outcome;
import mage.game.Game;
import mage.game.turn.TurnMod;
import mage.players.Player;
import java.util.Objects;
import java.util.UUID;
/**
@ -24,12 +26,16 @@ public class ControlTargetPlayerNextTurnEffect extends OneShotEffect {
@Override
public boolean apply(Game game, Ability source) {
UUID targetId = source.getFirstTarget();
UUID controllerId = source.getControllerId();
if (targetId != null && controllerId != null && !targetId.equals(controllerId)) {
game.getState().getTurnMods().add(new TurnMod(targetId, controllerId));
Player targetPlayer = game.getPlayer(source.getFirstTarget());
if (targetPlayer == null) {
return false;
}
if (!Objects.equals(source.getControllerId(), targetPlayer.getId())) {
game.getState().getTurnMods().add(new TurnMod(targetPlayer.getId()).withNewController(source.getControllerId()));
return true;
}
return false;
}

View file

@ -47,7 +47,7 @@ public class SkipNextTurnSourceEffect extends OneShotEffect {
playerId = source.getControllerId();
}
for (int i = 0; i < numberOfTurns; i++) {
game.getState().getTurnMods().add(new TurnMod(playerId, true));
game.getState().getTurnMods().add(new TurnMod(playerId).withSkipTurn());
}
return true;
}

View file

@ -22,7 +22,9 @@ public abstract class GameCanadianHighlanderImpl extends GameImpl {
@Override
protected void init(UUID choosingPlayerId) {
super.init(choosingPlayerId);
state.getTurnMods().add(new TurnMod(startingPlayerId, PhaseStep.DRAW));
// 103.7a In a two-player game, the player who plays first skips the draw step (see rule 504, "Draw Step")
// of his or her first turn.
state.getTurnMods().add(new TurnMod(startingPlayerId).withSkipStep(PhaseStep.DRAW));
}
}

View file

@ -29,6 +29,8 @@ public abstract class GameCommanderImpl extends GameImpl {
protected boolean alsoHand = true; // replace commander going to hand
protected boolean alsoLibrary = true; // replace commander going to library
// 103.7a In a two-player game, the player who plays first skips the draw step
// (see rule 504, "Draw Step") of his or her first turn.
protected boolean startingPlayerSkipsDraw = true;
public GameCommanderImpl(MultiplayerAttackOption attackOption, RangeOfInfluence range, Mulligan mulligan, int startingLife, int minimumDeckSize) {
@ -127,7 +129,7 @@ public abstract class GameCommanderImpl extends GameImpl {
super.init(choosingPlayerId);
if (startingPlayerSkipsDraw) {
state.getTurnMods().add(new TurnMod(startingPlayerId, PhaseStep.DRAW));
state.getTurnMods().add(new TurnMod(startingPlayerId).withSkipStep(PhaseStep.DRAW));
}
}

View file

@ -1041,7 +1041,7 @@ public abstract class GameImpl implements Game {
private boolean playExtraTurns() {
//20091005 - 500.7
TurnMod extraTurn = getNextExtraTurn();
TurnMod extraTurn = useNextExtraTurn();
try {
while (extraTurn != null) {
GameEvent event = new GameEvent(GameEvent.EventType.PLAY_TURN, null, null, extraTurn.getPlayerId());
@ -1049,15 +1049,13 @@ public abstract class GameImpl implements Game {
Player extraPlayer = this.getPlayer(extraTurn.getPlayerId());
if (extraPlayer != null && extraPlayer.canRespond()) {
state.setExtraTurnId(extraTurn.getId());
if (!this.isSimulation()) {
informPlayers(extraPlayer.getLogName() + " takes an extra turn");
}
informPlayers(extraPlayer.getLogName() + " takes an extra turn");
if (!playTurn(extraPlayer)) {
return false;
}
}
}
extraTurn = getNextExtraTurn();
extraTurn = useNextExtraTurn();
}
} finally {
state.setExtraTurnId(null);
@ -1065,7 +1063,7 @@ public abstract class GameImpl implements Game {
return true;
}
private TurnMod getNextExtraTurn() {
private TurnMod useNextExtraTurn() {
boolean checkForExtraTurn = true;
while (checkForExtraTurn) {
TurnMod extraTurn = getState().getTurnMods().getNextExtraTurn();

View file

@ -76,7 +76,7 @@ public class GameState implements Serializable, Copyable<GameState> {
private SpecialActions specialActions;
private Watchers watchers;
private Turn turn;
private TurnMods turnMods;
private TurnMods turnMods; // one time turn modifications (turn, phase or step)
private UUID activePlayerId; // playerId which turn it is
private UUID priorityPlayerId; // player that has currently priority
private UUID playerByOrderId; // player that has currently priority

View file

@ -29,6 +29,9 @@ public abstract class GameTinyLeadersImpl extends GameImpl {
protected boolean alsoHand; // replace also commander going to library
protected boolean alsoLibrary; // replace also commander going to library
// 103.7a In a two-player game, the player who plays first skips the draw step
// (see rule 504, "Draw Step") of his or her first turn.
protected boolean startingPlayerSkipsDraw = true;
public GameTinyLeadersImpl(MultiplayerAttackOption attackOption, RangeOfInfluence range, Mulligan mulligan, int startLife) {
@ -83,7 +86,7 @@ public abstract class GameTinyLeadersImpl extends GameImpl {
}
super.init(choosingPlayerId);
if (startingPlayerSkipsDraw) {
state.getTurnMods().add(new TurnMod(startingPlayerId, PhaseStep.DRAW));
state.getTurnMods().add(new TurnMod(startingPlayerId).withSkipStep(PhaseStep.DRAW));
}
}

View file

@ -1,114 +1,55 @@
package mage.game.turn;
import mage.constants.PhaseStep;
import mage.constants.TurnPhase;
import mage.util.Copyable;
import java.io.Serializable;
import java.util.UUID;
import mage.constants.PhaseStep;
import mage.constants.TurnPhase;
/**
* stores extra turns, phases or steps
* Creates a signle turn modification for turn, phase or step
* <p>
* For one time usage only
* <p>
* If you need it in continuous effect then use ContinuousRuleModifyingEffectImpl
* with game events like UNTAP_STEP (example: Sands of Time)
* <p>
* Supports:
* - new controller
* - turn: extra and skip
* - phase: extra and skip
* - step: extra and skip
*
* @author BetaSteward_at_googlemail.com
* @author JayDi85
*/
public class TurnMod implements Serializable {
public class TurnMod implements Serializable, Copyable<TurnMod> {
private final UUID id;
private final UUID playerId;
private UUID newControllerId;
private boolean extraTurn;
private boolean skipTurn;
private TurnPhase extraPhase;
private TurnPhase skipPhase;
private Step extraStep;
private PhaseStep skipStep;
private TurnPhase afterPhase;
private PhaseStep afterStep;
private boolean locked = false; // locked for modification, used for wrong code usage protection
private String note;
// Turn mod that should be applied after current turn mod.
// Implemented only for control player turn mod!
// Added for Emrakul, the Promised End.
// Turn mod that should be applied after current turn mod
// Implemented only for new controller turn mod
private TurnMod subsequentTurnMod;
/**
* Used to define if a player skips the next turn or gets an extra turn.
*
* @param playerId
* @param skip - true = skips next turn, false = player gets extra turn
*/
public TurnMod(UUID playerId, boolean skip) {
this.id = UUID.randomUUID();
this.playerId = playerId;
if (skip) {
this.skipTurn = true;
}
else {
this.extraTurn = true;
}
}
/**
* Used to define that a player controlls the next turn of another player.
*
* @param playerId - id of the player whose next turn is controlled by newControllerId
* @param newControllerId - id of the player that controlls playerId's next turn
*/
public TurnMod(UUID playerId, UUID newControllerId) {
this.id = UUID.randomUUID();
this.playerId = playerId;
this.newControllerId = newControllerId;
}
/**
* Used to define if and when a player gets an extra phase.
*
* @param playerId
* @param phase
* @param afterPhase - set to null if extraPhase is after the next phase
* @param skip
*/
public TurnMod(UUID playerId, TurnPhase phase, TurnPhase afterPhase, boolean skip) {
this.id = UUID.randomUUID();
this.playerId = playerId;
if (skip) {
this.skipPhase = phase;
}
else {
this.extraPhase = phase;
}
this.afterPhase = afterPhase;
}
/**
* Used to define if and when a player gets an extra step.
*
* @param playerId
* @param step - extra step the player gets
* @param afterStep - set to null if extraStep is after the next step
*/
public TurnMod(UUID playerId, Step step, PhaseStep afterStep) {
this.id = UUID.randomUUID();
this.playerId = playerId;
this.extraStep = step;
this.afterStep = afterStep;
}
/**
* Used to define that a player skips the next time the specified step
*
* @param playerId
* @param step - step to skip the next time
*/
public TurnMod(UUID playerId, PhaseStep step) {
this.id = UUID.randomUUID();
this.playerId = playerId;
this.skipStep = step;
}
public TurnMod(final TurnMod mod) {
private TurnMod(final TurnMod mod) {
this.id = mod.id;
this.playerId = mod.playerId;
this.newControllerId = mod.newControllerId;
@ -126,6 +67,86 @@ public class TurnMod implements Serializable {
this.subsequentTurnMod = mod.subsequentTurnMod.copy();
}
this.note = mod.note;
this.locked = mod.locked;
}
public TurnMod copy() {
return new TurnMod(this);
}
public TurnMod(UUID playerId) {
// TODO: delete
this.id = UUID.randomUUID();
this.playerId = playerId;
}
private void lock() {
if (this.locked) {
throw new IllegalStateException("Wrong code usage: you must use only one type of turn modification");
}
this.locked = true;
}
public TurnMod withSkipTurn() {
this.skipTurn = true;
lock();
return this;
}
public TurnMod withExtraTurn() {
this.extraTurn = true;
lock();
return this;
}
public TurnMod withNewController(UUID newControllerId) {
return withNewController(newControllerId, null);
}
public TurnMod withNewController(UUID newControllerId, TurnMod nextSubsequentTurnMod) {
this.newControllerId = newControllerId;
this.subsequentTurnMod = nextSubsequentTurnMod;
lock();
return this;
}
public TurnMod withSkipPhase(TurnPhase skipPhase) {
this.skipPhase = skipPhase;
lock();
return this;
}
public TurnMod withExtraPhase(TurnPhase extraPhase) {
return withExtraPhase(extraPhase, null);
}
public TurnMod withExtraPhase(TurnPhase extraPhase, TurnPhase addAfterPhase) {
this.extraPhase = extraPhase;
this.afterPhase = addAfterPhase;
lock();
return this;
}
public TurnMod withSkipStep(PhaseStep skipStep) {
this.skipStep = skipStep;
lock();
return this;
}
public TurnMod withExtraStep(Step extraStep) {
return withExtraStep(extraStep, null);
}
public TurnMod withExtraStep(Step extraStep, PhaseStep addAfterStep) {
this.extraStep = extraStep;
this.afterStep = addAfterStep;
lock();
return this;
}
public TurnMod withNote(String note) {
this.note = note;
return this;
}
public UUID getPlayerId() {
@ -168,10 +189,6 @@ public class TurnMod implements Serializable {
return newControllerId;
}
public TurnMod copy() {
return new TurnMod(this);
}
public UUID getId() {
return id;
}
@ -180,15 +197,11 @@ public class TurnMod implements Serializable {
return subsequentTurnMod;
}
public void setSubsequentTurnMod(TurnMod subsequentTurnMod) {
this.subsequentTurnMod = subsequentTurnMod;
}
public void setNote(String note) {
this.note = note;
}
public String getNote() {
return note;
}
}
public boolean isLocked() {
return locked;
}
}

View file

@ -1,37 +1,39 @@
package mage.game.turn;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.ListIterator;
import java.util.UUID;
import mage.constants.PhaseStep;
import mage.constants.TurnPhase;
import mage.util.Copyable;
/**
* Turn, phase and step modification for extra/skip (use it for one time mod only)
*
* @author BetaSteward_at_googlemail.com
*/
public class TurnMods extends ArrayList<TurnMod> {
public class TurnMods extends ArrayList<TurnMod> implements Serializable, Copyable<TurnMods> {
public TurnMods() {
}
public TurnMods(final TurnMods mods) {
private TurnMods(final TurnMods mods) {
for (TurnMod mod : mods) {
this.add(mod.copy());
}
}
public UUID getExtraTurn(UUID playerId) {
ListIterator<TurnMod> it = this.listIterator(this.size());
while (it.hasPrevious()) {
TurnMod turnMod = it.previous();
if (turnMod.isExtraTurn() && turnMod.getPlayerId().equals(playerId)) {
it.remove();
return turnMod.getId();
}
public TurnMods copy() {
return new TurnMods(this);
}
@Override
public boolean add(TurnMod turnMod) {
if (!turnMod.isLocked()) {
throw new IllegalStateException("Wrong code usage: you must prepare turn mode with modification");
}
return null;
return super.add(turnMod);
}
public TurnMod getNextExtraTurn() {
@ -105,7 +107,6 @@ public class TurnMods extends ArrayList<TurnMod> {
if (turnMod.getSkipStep() == step) {
it.remove();
return true;
}
}
}
@ -137,9 +138,4 @@ public class TurnMods extends ArrayList<TurnMod> {
}
return false;
}
public TurnMods copy() {
return new TurnMods(this);
}
}