sokoban

Documentation

Overview

SPDX-License-Identifier: CC-BY-SA-4.0

SPDX-License-Identifier: CC-BY-SA-4.0

SPDX-License-Identifier: CC-BY-SA-4.0

Index

• func RunGame(title string, game Game) error
• type Game
• type Screen
  • func (screen Screen) DrawCharacter1(tileX, tileY int)
  • func (screen Screen) DrawCharacter10(tileX, tileY int)
  • func (screen Screen) DrawCharacter2(tileX, tileY int)
  • func (screen Screen) DrawCharacter3(tileX, tileY int)
  • func (screen Screen) DrawCharacter4(tileX, tileY int)
  • func (screen Screen) DrawCharacter5(tileX, tileY int)
  • func (screen Screen) DrawCharacter6(tileX, tileY int)
  • func (screen Screen) DrawCharacter7(tileX, tileY int)
  • func (screen Screen) DrawCharacter8(tileX, tileY int)
  • func (screen Screen) DrawCharacter9(tileX, tileY int)
  • func (screen Screen) DrawCrateBeige(tileX, tileY int)
  • func (screen Screen) DrawCrateBlack(tileX, tileY int)
  • func (screen Screen) DrawCrateBlue(tileX, tileY int)
  • func (screen Screen) DrawCrateBrown(tileX, tileY int)
  • func (screen Screen) DrawCrateDarkBeige(tileX, tileY int)
  • func (screen Screen) DrawCrateDarkBlack(tileX, tileY int)
  • func (screen Screen) DrawCrateDarkBlue(tileX, tileY int)
  • func (screen Screen) DrawCrateDarkBrown(tileX, tileY int)
  • func (screen Screen) DrawCrateDarkGray(tileX, tileY int)
  • func (screen Screen) DrawCrateDarkPurple(tileX, tileY int)
  • func (screen Screen) DrawCrateDarkRed(tileX, tileY int)
  • func (screen Screen) DrawCrateDarkYellow(tileX, tileY int)
  • func (screen Screen) DrawCrateGray(tileX, tileY int)
  • func (screen Screen) DrawCratePurple(tileX, tileY int)
  • func (screen Screen) DrawCrateRed(tileX, tileY int)
  • func (screen Screen) DrawCrateYellow(tileX, tileY int)
  • func (screen Screen) DrawEndpointBeige(tileX, tileY int)
  • func (screen Screen) DrawEndpointBlack(tileX, tileY int)
  • func (screen Screen) DrawEndpointBlue(tileX, tileY int)
  • func (screen Screen) DrawEndpointBrown(tileX, tileY int)
  • func (screen Screen) DrawEndpointGray(tileX, tileY int)
  • func (screen Screen) DrawEndpointPurple(tileX, tileY int)
  • func (screen Screen) DrawEndpointRed(tileX, tileY int)
  • func (screen Screen) DrawEndpointYellow(tileX, tileY int)
  • func (screen Screen) DrawGroundConcrete(tileX, tileY int)
  • func (screen Screen) DrawGroundDirt(tileX, tileY int)
  • func (screen Screen) DrawGroundGrass(tileX, tileY int)
  • func (screen Screen) DrawGroundGravelConcrete(tileX, tileY int)
  • func (screen Screen) DrawGroundGravelDirt(tileX, tileY int)
  • func (screen Screen) DrawGroundGravelGrass(tileX, tileY int)
  • func (screen Screen) DrawGroundGravelSand(tileX, tileY int)
  • func (screen Screen) DrawGroundSand(tileX, tileY int)
  • func (screen Screen) DrawWallBeige(tileX, tileY int)
  • func (screen Screen) DrawWallBlack(tileX, tileY int)
  • func (screen Screen) DrawWallBrown(tileX, tileY int)
  • func (screen Screen) DrawWallGray(tileX, tileY int)
  • func (screen Screen) DrawWallRoundBeige(tileX, tileY int)
  • func (screen Screen) DrawWallRoundBlack(tileX, tileY int)
  • func (screen Screen) DrawWallRoundBrown(tileX, tileY int)
  • func (screen Screen) DrawWallRoundGray(tileX, tileY int)

Functions

func RunGame

func RunGame(title string, game Game) error

Types

type Game

type Game interface {

	// Update updates a game by one tick.
	Update() error

	// Draw draw the game screen. The given argument represents a screen image.
	Draw(screen Screen)

	// Return number of tiles to be displayed at once in X and Y
	Layout() (tilesX, tilesY int)
}

type Screen

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

func (Screen) DrawCharacter1

func (screen Screen) DrawCharacter1(tileX, tileY int)

func (Screen) DrawCharacter10

func (screen Screen) DrawCharacter10(tileX, tileY int)

func (Screen) DrawCharacter2

func (screen Screen) DrawCharacter2(tileX, tileY int)

func (Screen) DrawCharacter3

func (screen Screen) DrawCharacter3(tileX, tileY int)

func (Screen) DrawCharacter4

func (screen Screen) DrawCharacter4(tileX, tileY int)

func (Screen) DrawCharacter5

func (screen Screen) DrawCharacter5(tileX, tileY int)

func (Screen) DrawCharacter6

func (screen Screen) DrawCharacter6(tileX, tileY int)

func (Screen) DrawCharacter7

func (screen Screen) DrawCharacter7(tileX, tileY int)

func (Screen) DrawCharacter8

func (screen Screen) DrawCharacter8(tileX, tileY int)

func (Screen) DrawCharacter9

func (screen Screen) DrawCharacter9(tileX, tileY int)

func (Screen) DrawCrateBeige

func (screen Screen) DrawCrateBeige(tileX, tileY int)

func (Screen) DrawCrateBlack

func (screen Screen) DrawCrateBlack(tileX, tileY int)

func (Screen) DrawCrateBlue

func (screen Screen) DrawCrateBlue(tileX, tileY int)

func (Screen) DrawCrateBrown

func (screen Screen) DrawCrateBrown(tileX, tileY int)

func (Screen) DrawCrateDarkBeige

func (screen Screen) DrawCrateDarkBeige(tileX, tileY int)

func (Screen) DrawCrateDarkBlack

func (screen Screen) DrawCrateDarkBlack(tileX, tileY int)

func (Screen) DrawCrateDarkBlue

func (screen Screen) DrawCrateDarkBlue(tileX, tileY int)

func (Screen) DrawCrateDarkBrown

func (screen Screen) DrawCrateDarkBrown(tileX, tileY int)

func (Screen) DrawCrateDarkGray

func (screen Screen) DrawCrateDarkGray(tileX, tileY int)

func (Screen) DrawCrateDarkPurple

func (screen Screen) DrawCrateDarkPurple(tileX, tileY int)

func (Screen) DrawCrateDarkRed

func (screen Screen) DrawCrateDarkRed(tileX, tileY int)

func (Screen) DrawCrateDarkYellow

func (screen Screen) DrawCrateDarkYellow(tileX, tileY int)

func (Screen) DrawCrateGray

func (screen Screen) DrawCrateGray(tileX, tileY int)

func (Screen) DrawCratePurple

func (screen Screen) DrawCratePurple(tileX, tileY int)

func (Screen) DrawCrateRed

func (screen Screen) DrawCrateRed(tileX, tileY int)

func (Screen) DrawCrateYellow

func (screen Screen) DrawCrateYellow(tileX, tileY int)

func (Screen) DrawEndpointBeige

func (screen Screen) DrawEndpointBeige(tileX, tileY int)

func (Screen) DrawEndpointBlack

func (screen Screen) DrawEndpointBlack(tileX, tileY int)

func (Screen) DrawEndpointBlue

func (screen Screen) DrawEndpointBlue(tileX, tileY int)

func (Screen) DrawEndpointBrown

func (screen Screen) DrawEndpointBrown(tileX, tileY int)

func (Screen) DrawEndpointGray

func (screen Screen) DrawEndpointGray(tileX, tileY int)

func (Screen) DrawEndpointPurple

func (screen Screen) DrawEndpointPurple(tileX, tileY int)

func (Screen) DrawEndpointRed

func (screen Screen) DrawEndpointRed(tileX, tileY int)

func (Screen) DrawEndpointYellow

func (screen Screen) DrawEndpointYellow(tileX, tileY int)

func (Screen) DrawGroundConcrete

func (screen Screen) DrawGroundConcrete(tileX, tileY int)

func (Screen) DrawGroundDirt

func (screen Screen) DrawGroundDirt(tileX, tileY int)

func (Screen) DrawGroundGrass

func (screen Screen) DrawGroundGrass(tileX, tileY int)

func (Screen) DrawGroundGravelConcrete

func (screen Screen) DrawGroundGravelConcrete(tileX, tileY int)

func (Screen) DrawGroundGravelDirt

func (screen Screen) DrawGroundGravelDirt(tileX, tileY int)

func (Screen) DrawGroundGravelGrass

func (screen Screen) DrawGroundGravelGrass(tileX, tileY int)

func (Screen) DrawGroundGravelSand

func (screen Screen) DrawGroundGravelSand(tileX, tileY int)

func (Screen) DrawGroundSand

func (screen Screen) DrawGroundSand(tileX, tileY int)

func (Screen) DrawWallBeige

func (screen Screen) DrawWallBeige(tileX, tileY int)

func (Screen) DrawWallBlack

func (screen Screen) DrawWallBlack(tileX, tileY int)

func (Screen) DrawWallBrown

func (screen Screen) DrawWallBrown(tileX, tileY int)

func (Screen) DrawWallGray

func (screen Screen) DrawWallGray(tileX, tileY int)

func (Screen) DrawWallRoundBeige

func (screen Screen) DrawWallRoundBeige(tileX, tileY int)

func (Screen) DrawWallRoundBlack

func (screen Screen) DrawWallRoundBlack(tileX, tileY int)

func (Screen) DrawWallRoundBrown

func (screen Screen) DrawWallRoundBrown(tileX, tileY int)

func (Screen) DrawWallRoundGray

func (screen Screen) DrawWallRoundGray(tileX, tileY int)