tictactoe

package module

v0.2.2 Latest Latest Go to latest Published: May 30, 2020 License: BSD-3-Clause Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.sr.ht/~bonbon/go-tic-tac-toe

Links

Open Source Insights

Documentation ¶

Overview ¶

Package tictactoe is a Tic-Tac-Toe game engine.

Constants ¶

View Source

const (
	//SIZE is the size of the board
	SIZE = 3

	//X represents player X
	X = 'x'

	//O represents player O
	O = 'o'
)

Variables ¶

View Source

var (
	//ErrGameNotOver error
	ErrGameNotOver = errors.New("Game is not finished")

	//ErrInvalidMove error
	ErrInvalidMove = errors.New("Move is invalid")
)

Functions ¶

This section is empty.

Types ¶

type Game ¶

type Game struct {
	// contains filtered or unexported fields
}

Game represents the current game state.

func NewGame ¶

func NewGame() Game

NewGame returns a valid new game of tic-tac-toe.

func (Game) ApplyAction ¶

func (g Game) ApplyAction(m Move) (Game, error)

ApplyAction takes a Move and applies the action to the current game state.

Returns the new game state and an error if any occurred.

func (Game) GetActions ¶

func (g Game) GetActions() (moves []Move)

GetActions returns a list of moves that can be made by the current player.

func (Game) IsTerminal ¶

func (g Game) IsTerminal() bool

IsTerminal returns whether the game is finished or not.

func (Game) Player ¶

func (g Game) Player() byte

Player returns the ascii value of the player that is currently deciding a move.

Player returns 'o' if player o is making a move. Otherwise, Player return 'x'.

func (Game) String ¶

func (g Game) String() string

func (Game) Winner ¶

func (g Game) Winner() (byte, error)

Winner returns the winner's ascii value.

If the game resulted in a draw, it returns '_'.

Returns ErrGameNotOver if the game is not over.

type Move ¶

type Move struct {
	// contains filtered or unexported fields
}

Move represents an action made by a given player.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL