arena

Documentation

Index

• Variables
• type Arena
  • func Parse(input string) (*Arena, error)
  • func (m *Arena) CellTypeForCoordinate(c Coordinate) CellType
  • func (m *Arena) FinishCoordinate() Coordinate
  • func (m *Arena) NeighboursOfCoordinate(c Coordinate) []Coordinate
  • func (m *Arena) Render(w io.Writer)
  • func (m *Arena) RenderWithPath(w io.Writer, path []Coordinate)
  • func (m *Arena) RenderWithVisited(w io.Writer, visited []Coordinate)
  • func (m *Arena) StartCoordinate() Coordinate
• type CellType
  • func (t CellType) String() string
• type Coordinate
  • func NewCoordinate(x, y int) Coordinate
  • func (c Coordinate) DistanceTo(t Coordinate) int
  • func (c Coordinate) East() Coordinate
  • func (c Coordinate) North() Coordinate
  • func (c Coordinate) South() Coordinate
  • func (c Coordinate) West() Coordinate

Variables

var (
	ErrorInvalidArenaNoStart        = errors.New("invalid map: no start cell found")
	ErrorInvalidArenaNoFinish       = errors.New("invalid map: no finish cell found")
	ErrorInvalidArenaMultipleStart  = errors.New("invalid map: multiple start cells found")
	ErrorInvalidArenaMultipleFinish = errors.New("invalid map: multiple finish cells found")
)

var (
	SymbolNonWalkable = "#"
	SymbolWalkable    = "."
	SymbolStart       = "S"
	SymbolFinish      = "F"
	SymbolPath        = "@"
)

Types

type Arena

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

func Parse

func Parse(input string) (*Arena, error)

func (*Arena) CellTypeForCoordinate

func (m *Arena) CellTypeForCoordinate(c Coordinate) CellType

func (*Arena) FinishCoordinate

func (m *Arena) FinishCoordinate() Coordinate

func (*Arena) NeighboursOfCoordinate

func (m *Arena) NeighboursOfCoordinate(c Coordinate) []Coordinate

func (*Arena) Render

func (m *Arena) Render(w io.Writer)

render the map into the writer

func (*Arena) RenderWithPath

func (m *Arena) RenderWithPath(w io.Writer, path []Coordinate)

func (*Arena) RenderWithVisited

func (m *Arena) RenderWithVisited(w io.Writer, visited []Coordinate)

func (*Arena) StartCoordinate

func (m *Arena) StartCoordinate() Coordinate

type CellType

type CellType uint8

const (
	CellTypeUndefined CellType = iota
	CellTypeWalkable
	CellTypeNonWalkable
	CellTypeStart
	CellTypeFinish
	CellTypePath
)

func (CellType) String

func (t CellType) String() string

type Coordinate

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

func NewCoordinate

func NewCoordinate(x, y int) Coordinate

func (Coordinate) DistanceTo

func (c Coordinate) DistanceTo(t Coordinate) int

func (Coordinate) East

func (c Coordinate) East() Coordinate

func (Coordinate) North

func (c Coordinate) North() Coordinate

func (Coordinate) South

func (c Coordinate) South() Coordinate

func (Coordinate) West

func (c Coordinate) West() Coordinate