minesweeperCollab/square.java at master · jjjxu/minesweeperCollab · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
package minesweeperCollab;

/**
 * Represents a general square on the game board.
 *
 * This is the Github remote version of code.
 * @author Jerry Xu
 * @author 20jxu@westfordk12.us
 * @version 1.2
 * @since 1.0
 */
public class square {
	private int minesAround;
	private boolean isMine;
	private boolean markMine;
	private boolean dugUp;
	private boolean quickCleared;


	/**
	 * Creates a square with the mine status
	 * This should be true if it is a mine, false if it is not a mine
	 *
	 * @param mine   The status of the mine
	 * @param around The number of mines surrounding this given square
	 */
	public square(boolean mine, int around) {
		isMine = mine;
		minesAround = around;
		markMine = false;
		dugUp = false;
		quickCleared = false;
	}

	//Operations

	/**
	 * Flips the status of the marked mine
	 * I.e. a marked mine becomes unmarked, and an unmarked mine becomes marked.
	 *
	 * @return A boolean signaling the new status of the marking of the square.
	 */
	public boolean mark() {
		if(dugUp == true) return false;
		markMine = !markMine;
		return markMine;
	}

	/**
	 * "Digs up" a square
	 * This method can only be invoked once on a given square, safety checks within the game
	 * will make sure of that.
	 */
	public void dig() {
		if (!markMine) dugUp = true;
	}

	//Operation instruction

	/**
	 * Quick clears a square if the mines around it have been all marked.
	 * will make sure of that.
	 * @param marked Number of marked mines around given square
	 * @return Returns whether the quick clear operation should be run or not
	 */
	public boolean quickClear(int marked) {
		if (marked >= minesAround && !quickCleared && !isMine) {
			quickCleared = true;
			return true;
		}
		return false;
	}

	//Accessors

	/** Chooses image for display
	 * This method tells the game what image should be displayed on the square.
	 * This method should also be used for determining valid dig operations.
	 * @return The number of mines surrounding for if it isn't a mine (0-8), or undug up (-1) or a marked mine (100) If exploded, return 1000
	 */
	public int getDisplay(){
		if (dugUp && isMine) return 1000;
		if (markMine) return 100;
		if (!dugUp) return -1;
		return minesAround;

	}

	/** Floodfill helper
	 * Introduced v1.1 on a whim
	 * Safety; please use the dig operation for empty squares. Probably will be deprecated soon.
	 * This method tells the game what squares to move to for automatic dig operation floodfill.
	 * @return If this is a square that has been not dug up and is not surrounded by any mines.
	 * @deprecated
	 */
	public boolean isEmpty(){
		return !dugUp && minesAround == 0;
	}

}