foul-magics/Mage/src/main/java/mage/game/GameOptions.java

package mage.game;

import mage.constants.PhaseStep;
import mage.util.Copyable;

import java.io.Serializable;
import java.util.Collections;
import java.util.Set;

/**
 * Game options for Mage game. Mainly used in tests to configure
 * {@link GameImpl} with specific params.
 *
 * @author ayratn
 */
public class GameOptions implements Serializable, Copyable<GameOptions> {

    private static final GameOptions deinstance = new GameOptions();

    public static GameOptions getDefault() {
        return deinstance;
    }

    /**
     * Defines the running mode. There are some exclusions made for test mode.
     */
    public boolean testMode = false;

    /**
     * Defines the turn number game should stop on. By default, is null meaning
     * that game shouldn't stop on any specific turn.
     */
    public Integer stopOnTurn = null;

    /**
     * Stop at the end of the turn if true otherwise stop at the beginning
     */
    public PhaseStep stopAtStep = PhaseStep.UNTAP;

    /**
     * If true, library won't be shuffled at the beginning of the game
     */
    public boolean skipInitShuffling = false;

    /**
     * If true, players can rollback turn if all players agree
     */
    public boolean rollbackTurnsAllowed = true;

    /**
     * Names of users banned from participating in the game
     */
    public Set<String> bannedUsers = Collections.emptySet();


    // PLANECHASE game mode
    public boolean planeChase = false;
    // xmage uses increased by 1/3 chances (2/2/9) for chaos/planar result, see 1a9f12f5767ce0beeed26a8ff5c8a8f9490c9c47
    // if you need combo support with 6-sides rolls then it can be reset to original values
    public static final int PLANECHASE_PLANAR_DIE_CHAOS_SIDES = 2; // original: 1
    public static final int PLANECHASE_PLANAR_DIE_PLANAR_SIDES = 2; // original: 1
    public static final int PLANECHASE_PLANAR_DIE_TOTAL_SIDES = 9; // original: 6

    public GameOptions() {
        super();
    }

    private GameOptions(final GameOptions options) {
        this.testMode = options.testMode;
        this.stopOnTurn = options.stopOnTurn;
        this.stopAtStep = options.stopAtStep;
        this.skipInitShuffling = options.skipInitShuffling;
        this.rollbackTurnsAllowed = options.rollbackTurnsAllowed;
        this.bannedUsers.addAll(options.bannedUsers);
        this.planeChase = options.planeChase;
    }

    @Override
    public GameOptions copy() {
        return new GameOptions(this);
    }
}