From 38293b6d5df68eff2794576bb64f82c2715429b6 Mon Sep 17 00:00:00 2001
From: Joop Kiefte <ikojba@gmail.com>
Date: Sat, 12 Sep 2020 16:37:57 +0200
Subject: Add more comments

---
 tris/core.go | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'tris/core.go')

diff --git a/tris/core.go b/tris/core.go
index 8a9c16b..087203e 100644
--- a/tris/core.go
+++ b/tris/core.go
@@ -38,6 +38,8 @@ const (
 	CounterClockwise
 )
 
+// a placement is the combination of a piece and where it exactly is on the board
+// we use this both for the actual piece and for checking hypothetical positions
 type Placement struct {
 	piece Piece
 	X     int
@@ -46,6 +48,7 @@ type Placement struct {
 	Lock  time.Time
 }
 
+// Collide checks if any squares of the Placement and the Field overlap
 func (p Placement) Collide(f Field) bool {
 	pf, ok := p.Field()
 	for x := 0; x < 10; x++ {
@@ -58,6 +61,8 @@ func (p Placement) Collide(f Field) bool {
 	return !ok
 }
 
+// Field translates the Placement into a Field format
+// When it gets out of the board, we return that to the caller with a bool
 func (p Placement) Field() (Field, bool) {
 	var f Field
 	ok := true
@@ -74,6 +79,7 @@ func (p Placement) Field() (Field, bool) {
 	return f, ok
 }
 
+// Points transforms the piece to a list of coordinates
 func (p Placement) Points() []Point {
 	piece := p.piece[p.Rot]
 	var points []Point
@@ -114,6 +120,7 @@ func (b Bag) Pick() (Bag, Placement) {
 
 type Field [20][10]bool
 
+// Add merges the Field and Piece together
 func (f Field) Add(p Placement) Field {
 	fn := f
 	for _, point := range p.Points() {
@@ -126,6 +133,7 @@ func (f Field) Add(p Placement) Field {
 
 }
 
+// The command line tool uses this representation as the actual playing field
 func (f Field) String() (output string) {
 	for _, row := range f {
 		for _, block := range row {
-- 
cgit v1.2.3-70-g09d2