In this repository I have implemented a Board for the battleship game including the attack feature.
The possible results of an attack are the following:
- ‘Hit’ if there is a ship occupying the position
- ‘Miss’ if no ships occupy the position
- ‘Already Taken’ if the position has previously been attacked
- ‘Sunk’ if the attack hits the last remaining position of a ship
- ‘Win’ if the attack sinks the last remaining ship
The code is stored in the src folder. Tests are in the test folder.
- board.py - Board class that implements the game API and BoardTracker class that tracks the number of sunken ships
- battleship.py - Battleship class that keep tracks of number of hits
- cells.py - Cell class implementing a method
attackthat handles attacks on the different cell types in the board - outcomes.py - module that defines the possible API answers (HIT, MISS, ALREADY_TAKEN, SUNK, WIN)
- example.py - script to run the API example below
To run this example:
python src/example.py
Create a 5x5 empty board:
from board import Board
game_board = Board(size_x=5, size_y=5)Place a ship of length 3 horizontally starting at position (1, 1):
game_board.place_ship(length=3, start_x=1, start_y=1, is_horizontal=True)Place a ship of length 4 vertically starting at position (4, 1):
game_board.place_ship(length=4, start_x=4, start_y=1, is_horizontal=False)Attack an empty cell:
game_board.attack(0, 0) # MISSAttack and sink a ship:
game_board.attack(1, 1) # HIT
game_board.attack(2, 1) # HIT
game_board.attack(3, 1) # SUNKWin the game:
game_board.attack(4, 1) # HIT
game_board.attack(4, 2) # HIT
game_board.attack(4, 3) # HIT
game_board.attack(4, 4) # WIN