Skip to content

Commit

Permalink
Add doc line to explain opposites
Browse files Browse the repository at this point in the history
  • Loading branch information
xpdota committed Dec 24, 2024
1 parent f5a272a commit 474e188
Showing 1 changed file with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,9 @@ public String getAbbreviation() {
/**
* Like {@link #tryCombineTwoQuadrants(List)} (List)}, but returns a list. If they were combined, the list will
* contain the single combined instance. Otherwise, returns the original input.
*
* @param quadrants The quadrants to combine.
* @return The original input if no combination possible, otherwise the combination.
* @return The original input if no combination possible, otherwise the combination.
*/
public static List<ArenaSector> tryMergeQuadrants(List<ArenaSector> quadrants) {
ArenaSector combined = tryCombineTwoQuadrants(quadrants);
Expand Down Expand Up @@ -210,6 +211,8 @@ public ArenaSector plusQuads(int quads) {
* while negative indicates CCW.
* <p>
* e.g. NORTHEAST.eightsTo(WEST) == -3, because the shortest path from northeast to west is CCW.
* <p>
* If the locations being compared are directly opposite (e.g. this==EAST and other==WEST), returns 4 (never -4).
*
* @param other The sector to compare to.
* @return The eighth-turns to get to that sector from this.
Expand Down

0 comments on commit 474e188

Please sign in to comment.