From e22f722092dc4fa04b172567bd01f06a8487f307 Mon Sep 17 00:00:00 2001 From: garrettmills Date: Sat, 12 Sep 2020 16:41:08 -0500 Subject: [PATCH] Update READMEs and documentation (#6) --- README.md | 11 + documentation/README.md | 51 + documentation/generate.sh | 2 +- .../generated/GameBoardComponent.html | 2 +- documentation/generated/GameStateService.html | 2 +- .../generated/GridCellComponent.html | 2 +- .../generated/InvalidAdvanceStateError.html | 182 - .../InvalidMissileFireAttemptError.html | 181 - .../generated/InvalidShipPlacementError.html | 182 - .../generated/ScoreBoardComponent.html | 2 +- documentation/generated/Sound.html | 479 -- .../generated/TopLevelComponent.html | 2 +- .../components_GameBoard.component.js.html | 2 +- .../components_GridCell.component.js.html | 2 +- .../components_ScoreBoard.component.js.html | 2 +- .../components_TopLevel.component.js.html | 2 +- documentation/generated/global.html | 1113 ---- documentation/generated/index.html | 53 +- ...odule-errors.InvalidAdvanceStateError.html | 2 +- ...errors.InvalidMissileFireAttemptError.html | 2 +- ...dule-errors.InvalidShipPlacementError.html | 2 +- documentation/generated/module-errors.html | 2 +- documentation/generated/module-lang.html | 2 +- .../generated/module-sounds-Sound.html | 2 +- documentation/generated/module-sounds.html | 2 +- documentation/generated/module-util.html | 2 +- documentation/generated/module.exports.html | 5211 ----------------- documentation/generated/module_errors.js.html | 2 +- documentation/generated/module_lang.js.html | 2 +- documentation/generated/module_sounds.js.html | 2 +- documentation/generated/module_util.js.html | 2 +- .../services_GameState.service.js.html | 2 +- lib/README.md | 3 +- 33 files changed, 138 insertions(+), 7374 deletions(-) create mode 100644 documentation/README.md delete mode 100644 documentation/generated/InvalidAdvanceStateError.html delete mode 100644 documentation/generated/InvalidMissileFireAttemptError.html delete mode 100644 documentation/generated/InvalidShipPlacementError.html delete mode 100644 documentation/generated/Sound.html delete mode 100644 documentation/generated/global.html delete mode 100644 documentation/generated/module.exports.html diff --git a/README.md b/README.md index c90f179..890d5ce 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,17 @@ The easiest way to run this project is by creating a basic static web server usi This will start a web server on port 8000. You can then run the game by navigating to http://localhost:8000/ from a web browser. +## Documentation +You can [preview it here](https://htmlpreview.github.io/?https://raw.githubusercontent.com/EECS-448-Battleship/project-1/master/documentation/generated/index.html). Otherwise, it is generated by JSDoc in the `documentation/generated` directory. + +### Re-generating the documentation +To regenerate the docs, you need Node.js and the Yarn package manager installed. Then, just: + +```shell script +cd documentation +./generate.sh +``` + ## Contributors - Lucas Brakenridge - Javier Barea Lara diff --git a/documentation/README.md b/documentation/README.md new file mode 100644 index 0000000..d90f392 --- /dev/null +++ b/documentation/README.md @@ -0,0 +1,51 @@ +# Battleship +## EECS 448 - Project 1 + +This is a basic battleship game created as our submission for project 1 for EECS 448 at the University of Kansas. + +## Structure Info +This project has been wired up to use Vue.js to help organize components of the game. + +These components are defined in files that end in the `.component.js` extension, and are located in the `src/components/` directory. + +The entry point for the project is the `index.html`. This file contains the basic logic for loading Vue, and adding the game board to the page. + +Obviously, we'll flesh out the look-and-feel as we go along. This is just a basic starter for now. + +## How to Run +The easiest way to run this project is by creating a basic static web server using Python. This is super simple: + +1. Open a terminal or command prompt to the root of this project (i.e. the directory this file is in). +2. Start the server: `python -m http.server` + +This will start a web server on port 8000. You can then run the game by navigating to http://localhost:8000/ from a web browser. + +## Documentation +You can [preview it here](https://htmlpreview.github.io/?https://raw.githubusercontent.com/EECS-448-Battleship/project-1/master/documentation/generated/index.html). Otherwise, it is generated by JSDoc in the `documentation/generated` directory. + +### Re-generating the documentation +To regenerate the docs, you need Node.js and the Yarn package manager installed. Then, just: + +```shell script +cd documentation +./generate.sh +``` + +## Third-Party Libraries +The files in the `lib/` are external libraries used in this project. + +- Vue.js + - A front-end framework. Used under the terms of the MIT license. + - https://github.com/vuejs/vue +- VuES6.js + - A kind-of crappy loader for defining Vue components using ES6 classes. + - Also used under the terms of the MIT license. + - https://code.garrettmills.dev/garrettmills/vues6 +- Sound effects obtained from https://www.zapsplat.com and used with permission. + +## Contributors +- Lucas Brakenridge +- Javier Barea Lara +- Garrett Mills +- Evan Powell +- Alec Horlick-Mills diff --git a/documentation/generate.sh b/documentation/generate.sh index 9df5ead..8b99aab 100755 --- a/documentation/generate.sh +++ b/documentation/generate.sh @@ -1,3 +1,3 @@ #!/bin/sh yarn install -./node_modules/.bin/jsdoc --destination ./generated --recurse ../src +./node_modules/.bin/jsdoc --destination ./generated --readme ./README.md --recurse ../src diff --git a/documentation/generated/GameBoardComponent.html b/documentation/generated/GameBoardComponent.html index 12a59c2..3817627 100644 --- a/documentation/generated/GameBoardComponent.html +++ b/documentation/generated/GameBoardComponent.html @@ -1857,7 +1857,7 @@ When in placement mode, this updates the cells that show the ghost ship.
diff --git a/documentation/generated/GameStateService.html b/documentation/generated/GameStateService.html index ef7ae8c..0ce2857 100644 --- a/documentation/generated/GameStateService.html +++ b/documentation/generated/GameStateService.html @@ -3102,7 +3102,7 @@ game_service.validate_coordinates(ShipType.x3, [3,2], [3,4])
diff --git a/documentation/generated/GridCellComponent.html b/documentation/generated/GridCellComponent.html index 34e9056..d15d757 100644 --- a/documentation/generated/GridCellComponent.html +++ b/documentation/generated/GridCellComponent.html @@ -612,7 +612,7 @@
diff --git a/documentation/generated/InvalidAdvanceStateError.html b/documentation/generated/InvalidAdvanceStateError.html deleted file mode 100644 index 89bb8bf..0000000 --- a/documentation/generated/InvalidAdvanceStateError.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - JSDoc: Class: InvalidAdvanceStateError - - - - - - - - - - -
- -

Class: InvalidAdvanceStateError

- - - - - - -
- -
- -

InvalidAdvanceStateError()

- -
Error thrown when the program tries to advance the state, but it is -invalid.
- - -
- -
-
- - - - -

Constructor

- - - -

new InvalidAdvanceStateError()

- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - -

Extends

- - - - -
    -
  • Error
    • -
- - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/documentation/generated/InvalidMissileFireAttemptError.html b/documentation/generated/InvalidMissileFireAttemptError.html deleted file mode 100644 index 971bdc9..0000000 --- a/documentation/generated/InvalidMissileFireAttemptError.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - JSDoc: Class: InvalidMissileFireAttemptError - - - - - - - - - - -
- -

Class: InvalidMissileFireAttemptError

- - - - - - -
- -
- -

InvalidMissileFireAttemptError()

- -
Error thrown when a missile is fired at an invalid cell.
- - -
- -
-
- - - - -

Constructor

- - - -

new InvalidMissileFireAttemptError()

- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - -

Extends

- - - - -
    -
  • Error
    • -
- - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/documentation/generated/InvalidShipPlacementError.html b/documentation/generated/InvalidShipPlacementError.html deleted file mode 100644 index 7c8dd93..0000000 --- a/documentation/generated/InvalidShipPlacementError.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - JSDoc: Class: InvalidShipPlacementError - - - - - - - - - - -
- -

Class: InvalidShipPlacementError

- - - - - - -
- -
- -

InvalidShipPlacementError()

- -
Placeholder class for an error that is thrown when a ship is placed -in an invalid position.
- - -
- -
-
- - - - -

Constructor

- - - -

new InvalidShipPlacementError()

- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - -

Extends

- - - - -
    -
  • Error
    • -
- - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/documentation/generated/ScoreBoardComponent.html b/documentation/generated/ScoreBoardComponent.html index e7c4db7..3eda487 100644 --- a/documentation/generated/ScoreBoardComponent.html +++ b/documentation/generated/ScoreBoardComponent.html @@ -812,7 +812,7 @@
diff --git a/documentation/generated/Sound.html b/documentation/generated/Sound.html deleted file mode 100644 index d93c651..0000000 --- a/documentation/generated/Sound.html +++ /dev/null @@ -1,479 +0,0 @@ - - - - - JSDoc: Class: Sound - - - - - - - - - - -
- -

Class: Sound

- - - - - - -
- -
- -

Sound(src)

- -
A thin wrapper for sound effects.
- - -
- -
-
- - - - -

Constructor

- - - -

new Sound(src)

- - - - - - -
- Construct the sound. -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
src - - -string - - - - URL of the file
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - -

Members

- - - -

sound :HTMLAudioElement

- - - - -
- The sound element. -
- - - -
Type:
-
    -
  • - -HTMLAudioElement - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - -

Methods

- - - - - - - -

(async) play()

- - - - - - -
- Start playing the sound. -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

stop()

- - - - - - -
- Pause the sound. -
- - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/documentation/generated/TopLevelComponent.html b/documentation/generated/TopLevelComponent.html index 091bc03..87b2539 100644 --- a/documentation/generated/TopLevelComponent.html +++ b/documentation/generated/TopLevelComponent.html @@ -1482,7 +1482,7 @@
diff --git a/documentation/generated/components_GameBoard.component.js.html b/documentation/generated/components_GameBoard.component.js.html index 4c7be21..019a478 100644 --- a/documentation/generated/components_GameBoard.component.js.html +++ b/documentation/generated/components_GameBoard.component.js.html @@ -278,7 +278,7 @@ export default GameBoardComponent
diff --git a/documentation/generated/components_GridCell.component.js.html b/documentation/generated/components_GridCell.component.js.html index 8e7efd2..bd7a1fe 100644 --- a/documentation/generated/components_GridCell.component.js.html +++ b/documentation/generated/components_GridCell.component.js.html @@ -102,7 +102,7 @@ export default GridCellComponent
diff --git a/documentation/generated/components_ScoreBoard.component.js.html b/documentation/generated/components_ScoreBoard.component.js.html index 60ddd4f..402a259 100644 --- a/documentation/generated/components_ScoreBoard.component.js.html +++ b/documentation/generated/components_ScoreBoard.component.js.html @@ -151,7 +151,7 @@ export default ScoreBoardComponent
diff --git a/documentation/generated/components_TopLevel.component.js.html b/documentation/generated/components_TopLevel.component.js.html index f64bee2..65dbefd 100644 --- a/documentation/generated/components_TopLevel.component.js.html +++ b/documentation/generated/components_TopLevel.component.js.html @@ -274,7 +274,7 @@ export default TopLevelComponent
diff --git a/documentation/generated/global.html b/documentation/generated/global.html deleted file mode 100644 index 008c884..0000000 --- a/documentation/generated/global.html +++ /dev/null @@ -1,1113 +0,0 @@ - - - - - JSDoc: Global - - - - - - - - - - -
- -

Global

- - - - - - -
- -
- -

- - -
- -
-
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - - - - - - - - - -

Members

- - - -

(constant) GameState :object

- - - - -
- Enum of all possible game states. These are player-agnostic. -
- - - -
Type:
-
    -
  • - -object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(constant) GridCellState :object

- - - - -
- Enum of all possible states of a grid cell. -
- - - -
Type:
-
    -
  • - -object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(constant) instructions :object

- - - - -
- Enum of all possible instructions. -
- - - -
Type:
-
    -
  • - -object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(constant) Player :object

- - - - -
- Enum of all possible players. -
- - - -
Type:
-
    -
  • - -object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

(constant) ShipType :object

- - - - -
- The various supported ship types, by dimension. -
- - - -
Type:
-
    -
  • - -object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - -

Methods

- - - - - - - -

appUrl(path) → {string}

- - - - - - -
- Generate an absolute URL to a file w/in the project directory. -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
path - - -string - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -string - - -
-
- - - - - - - - - - - - - -

clone(obj) → {*}

- - - - - - -
- Makes a deep copy of the value passed in. -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
obj - - -* - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -* - - -
-
- - - - - - - - - - - - - -

isShipCell(grid_cell_state) → {boolean}

- - - - - - -
- Returns true if the given grid cell state represents a ship in some way. -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
grid_cell_state - - -GridCellState - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -boolean - - -
-
- - - - - - - - - - - - - -

isValidTargetCell(grid_cell_state) → {boolean}

- - - - - - -
- Returns true if the given grid cell state can be fired upon. -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
grid_cell_state - - -GridCellState - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - - - -
-
- Type -
-
- -boolean - - -
-
- - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/documentation/generated/index.html b/documentation/generated/index.html index b348205..8c145fd 100644 --- a/documentation/generated/index.html +++ b/documentation/generated/index.html @@ -42,6 +42,57 @@ +
+

Battleship

+

EECS 448 - Project 1

+

This is a basic battleship game created as our submission for project 1 for EECS 448 at the University of Kansas.

+

Structure Info

+

This project has been wired up to use Vue.js to help organize components of the game.

+

These components are defined in files that end in the .component.js extension, and are located in the src/components/ directory.

+

The entry point for the project is the index.html. This file contains the basic logic for loading Vue, and adding the game board to the page.

+

Obviously, we'll flesh out the look-and-feel as we go along. This is just a basic starter for now.

+

How to Run

+

The easiest way to run this project is by creating a basic static web server using Python. This is super simple:

+
    +
  1. Open a terminal or command prompt to the root of this project (i.e. the directory this file is in).
    2. +
  2. Start the server: python -m http.server
    3. +
+

This will start a web server on port 8000. You can then run the game by navigating to http://localhost:8000/ from a web browser.

+

Documentation

+

You can preview it here. Otherwise, it is generated by JSDoc in the documentation/generated directory.

+

Re-generating the documentation

+

To regenerate the docs, you need Node.js and the Yarn package manager installed. Then, just:

+
cd documentation
+./generate.sh
+
+

Third-Party Libraries

+

The files in the lib/ are external libraries used in this project.

+
    +
  • Vue.js +
      +
    • A front-end framework. Used under the terms of the MIT license.
      • +
    • https://github.com/vuejs/vue
      • +
    +
    • +
  • VuES6.js +
      +
    • A kind-of crappy loader for defining Vue components using ES6 classes.
      • +
    • Also used under the terms of the MIT license.
      • +
    • https://code.garrettmills.dev/garrettmills/vues6
      • +
    +
    • +
  • Sound effects obtained from https://www.zapsplat.com and used with permission.
    • +
+

Contributors

+
    +
  • Lucas Brakenridge
    • +
  • Javier Barea Lara
    • +
  • Garrett Mills
    • +
  • Evan Powell
    • +
  • Alec Horlick-Mills
    • +
+
+ @@ -56,7 +107,7 @@
diff --git a/documentation/generated/module-errors.InvalidAdvanceStateError.html b/documentation/generated/module-errors.InvalidAdvanceStateError.html index a596677..bd5713a 100644 --- a/documentation/generated/module-errors.InvalidAdvanceStateError.html +++ b/documentation/generated/module-errors.InvalidAdvanceStateError.html @@ -174,7 +174,7 @@ invalid.
diff --git a/documentation/generated/module-errors.InvalidMissileFireAttemptError.html b/documentation/generated/module-errors.InvalidMissileFireAttemptError.html index 3caf1e4..0c580b6 100644 --- a/documentation/generated/module-errors.InvalidMissileFireAttemptError.html +++ b/documentation/generated/module-errors.InvalidMissileFireAttemptError.html @@ -173,7 +173,7 @@
diff --git a/documentation/generated/module-errors.InvalidShipPlacementError.html b/documentation/generated/module-errors.InvalidShipPlacementError.html index f18cad6..e77fa8b 100644 --- a/documentation/generated/module-errors.InvalidShipPlacementError.html +++ b/documentation/generated/module-errors.InvalidShipPlacementError.html @@ -174,7 +174,7 @@ in an invalid position.
diff --git a/documentation/generated/module-errors.html b/documentation/generated/module-errors.html index 660a161..110f5a9 100644 --- a/documentation/generated/module-errors.html +++ b/documentation/generated/module-errors.html @@ -89,7 +89,7 @@
diff --git a/documentation/generated/module-lang.html b/documentation/generated/module-lang.html index de15f63..aa78a80 100644 --- a/documentation/generated/module-lang.html +++ b/documentation/generated/module-lang.html @@ -152,7 +152,7 @@
diff --git a/documentation/generated/module-sounds-Sound.html b/documentation/generated/module-sounds-Sound.html index 362ca08..dba0c95 100644 --- a/documentation/generated/module-sounds-Sound.html +++ b/documentation/generated/module-sounds-Sound.html @@ -471,7 +471,7 @@
diff --git a/documentation/generated/module-sounds.html b/documentation/generated/module-sounds.html index 6caaa90..2588964 100644 --- a/documentation/generated/module-sounds.html +++ b/documentation/generated/module-sounds.html @@ -159,7 +159,7 @@
diff --git a/documentation/generated/module-util.html b/documentation/generated/module-util.html index 0e4ed09..1f02918 100644 --- a/documentation/generated/module-util.html +++ b/documentation/generated/module-util.html @@ -992,7 +992,7 @@
diff --git a/documentation/generated/module.exports.html b/documentation/generated/module.exports.html deleted file mode 100644 index 038c97d..0000000 --- a/documentation/generated/module.exports.html +++ /dev/null @@ -1,5211 +0,0 @@ - - - - - JSDoc: Class: exports - - - - - - - - - - -
- -

Class: exports

- - - - - - -
- -
- -

exports()

- -
A component which represents a single, programmable game board.
- - -
- -
-
- - - - -

Constructor

- - - -

new exports()

- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - -

Extends

- - - - -
    -
  • Component
    • -
- - - - - - - - - - - - - - - -

Members

- - - -

bound_fns :Array.<function()>

- - - - -
- Array of functions bound to event listeners. Used to -remove event listeners on destroy. -
- - - -
Type:
-
    -
  • - -Array.<function()> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

bound_fns :Array.<function()>

- - - - -
- Array of functions bound to event listeners. Used to -remove event listeners on destroy. -
- - - -
Type:
-
    -
  • - -Array.<function()> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

column_labels :Array.<string>

- - - - -
- The various column labels to display. -
- - - -
Type:
-
    -
  • - -Array.<string> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

column_labels :Array.<string>

- - - - -
- The various column labels to display. -
- - - -
Type:
-
    -
  • - -Array.<string> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_opponent_display :string

- - - - -
- The display name of the current opponent. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_opponent_display :string

- - - - -
- The display name of the current opponent. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_placement :string

- - - - -
- The ship currently being placed. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_placement :string

- - - - -
- The ship currently being placed. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_player_display :string

- - - - -
- The display name of the current player. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_player_display :string

- - - - -
- The display name of the current player. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_state :GameState|undefined

- - - - -
- The current game state. -
- - - -
Type:
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_state :GameState|undefined

- - - - -
- The current game state. -
- - - -
Type:
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

GameState :object

- - - - -
- Make the game state accessible w/in the template. -
- - - -
Type:
-
    -
  • - -object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

GameState :object

- - - - -
- Make the game state accessible w/in the template. -
- - - -
Type:
-
    -
  • - -object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

GridCellState

- - - - -
- Make the "GridCellState" enum available in the template. -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

GridCellState

- - - - -
- Make the "GridCellState" enum available in the template. -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

instructions :string

- - - - -
- The current instructions to be shown to the user. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

instructions :string

- - - - -
- The current instructions to be shown to the user. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

opponent_rows :Array.<Array.<object>>

- - - - -
- The opponent's grid data. -
- - - -
Type:
-
    -
  • - -Array.<Array.<object>> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

opponent_rows :Array.<Array.<object>>

- - - - -
- The opponent's grid data. -
- - - -
Type:
-
    -
  • - -Array.<Array.<object>> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_is_firing_missiles :boolean

- - - - -
- True if the player should be able to fire missiles at their opponent. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_is_firing_missiles :boolean

- - - - -
- True if the player should be able to fire missiles at their opponent. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_is_placing_ships :boolean

- - - - -
- True if the player should be able to place their ships. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_is_placing_ships :boolean

- - - - -
- True if the player should be able to place their ships. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_rows :Array.<Array.<object>>

- - - - -
- The player's grid data. -
- - - -
Type:
-
    -
  • - -Array.<Array.<object>> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_rows :Array.<Array.<object>>

- - - - -
- The player's grid data. -
- - - -
Type:
-
    -
  • - -Array.<Array.<object>> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ready :boolean

- - - - -
- If true, the grid is ready to be rendered. If false, -the grid will be hidden. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ready :boolean

- - - - -
- If true, the grid is ready to be rendered. If false, -the grid will be hidden. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

shift_pressed :boolean

- - - - -
- Set to true when the shift key is pressed. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

shift_pressed :boolean

- - - - -
- Set to true when the shift key is pressed. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ship_ghost_cells :Array.<number>

- - - - -
- Array of coordinates as [row_index, column_index] of cells which should -show a ghost ship overlay. -
- - - -
Type:
-
    -
  • - -Array.<number> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ship_ghost_cells :Array.<number>

- - - - -
- Array of coordinates as [row_index, column_index] of cells which should -show a ghost ship overlay. -
- - - -
Type:
-
    -
  • - -Array.<number> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ships_to_place :Array.<ShipType>

- - - - -
- If in placement mode, the ships that are yet to be placed. -
- - - -
Type:
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ships_to_place :Array.<ShipType>

- - - - -
- If in placement mode, the ships that are yet to be placed. -
- - - -
Type:
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - -
- -
- - - - - - - -
- -
- -

exports()

- -
A component which represents a single, programmable game board.
- - -
- -
-
- - - - -

Constructor

- - - -

new exports()

- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - -

Extends

- - - - -
    -
  • Component
    • -
- - - - - - - - - - - - - - - -

Members

- - - -

bound_fns :Array.<function()>

- - - - -
- Array of functions bound to event listeners. Used to -remove event listeners on destroy. -
- - - -
Type:
-
    -
  • - -Array.<function()> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

bound_fns :Array.<function()>

- - - - -
- Array of functions bound to event listeners. Used to -remove event listeners on destroy. -
- - - -
Type:
-
    -
  • - -Array.<function()> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

column_labels :Array.<string>

- - - - -
- The various column labels to display. -
- - - -
Type:
-
    -
  • - -Array.<string> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

column_labels :Array.<string>

- - - - -
- The various column labels to display. -
- - - -
Type:
-
    -
  • - -Array.<string> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_opponent_display :string

- - - - -
- The display name of the current opponent. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_opponent_display :string

- - - - -
- The display name of the current opponent. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_placement :string

- - - - -
- The ship currently being placed. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_placement :string

- - - - -
- The ship currently being placed. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_player_display :string

- - - - -
- The display name of the current player. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_player_display :string

- - - - -
- The display name of the current player. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_state :GameState|undefined

- - - - -
- The current game state. -
- - - -
Type:
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

current_state :GameState|undefined

- - - - -
- The current game state. -
- - - -
Type:
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

GameState :object

- - - - -
- Make the game state accessible w/in the template. -
- - - -
Type:
-
    -
  • - -object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

GameState :object

- - - - -
- Make the game state accessible w/in the template. -
- - - -
Type:
-
    -
  • - -object - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

GridCellState

- - - - -
- Make the "GridCellState" enum available in the template. -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

GridCellState

- - - - -
- Make the "GridCellState" enum available in the template. -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

instructions :string

- - - - -
- The current instructions to be shown to the user. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

instructions :string

- - - - -
- The current instructions to be shown to the user. -
- - - -
Type:
-
    -
  • - -string - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

opponent_rows :Array.<Array.<object>>

- - - - -
- The opponent's grid data. -
- - - -
Type:
-
    -
  • - -Array.<Array.<object>> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

opponent_rows :Array.<Array.<object>>

- - - - -
- The opponent's grid data. -
- - - -
Type:
-
    -
  • - -Array.<Array.<object>> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_is_firing_missiles :boolean

- - - - -
- True if the player should be able to fire missiles at their opponent. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_is_firing_missiles :boolean

- - - - -
- True if the player should be able to fire missiles at their opponent. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_is_placing_ships :boolean

- - - - -
- True if the player should be able to place their ships. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_is_placing_ships :boolean

- - - - -
- True if the player should be able to place their ships. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_rows :Array.<Array.<object>>

- - - - -
- The player's grid data. -
- - - -
Type:
-
    -
  • - -Array.<Array.<object>> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

player_rows :Array.<Array.<object>>

- - - - -
- The player's grid data. -
- - - -
Type:
-
    -
  • - -Array.<Array.<object>> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ready :boolean

- - - - -
- If true, the grid is ready to be rendered. If false, -the grid will be hidden. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ready :boolean

- - - - -
- If true, the grid is ready to be rendered. If false, -the grid will be hidden. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

shift_pressed :boolean

- - - - -
- Set to true when the shift key is pressed. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

shift_pressed :boolean

- - - - -
- Set to true when the shift key is pressed. -
- - - -
Type:
-
    -
  • - -boolean - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ship_ghost_cells :Array.<number>

- - - - -
- Array of coordinates as [row_index, column_index] of cells which should -show a ghost ship overlay. -
- - - -
Type:
-
    -
  • - -Array.<number> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ship_ghost_cells :Array.<number>

- - - - -
- Array of coordinates as [row_index, column_index] of cells which should -show a ghost ship overlay. -
- - - -
Type:
-
    -
  • - -Array.<number> - - -
    • -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ships_to_place :Array.<ShipType>

- - - - -
- If in placement mode, the ships that are yet to be placed. -
- - - -
Type:
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - -

ships_to_place :Array.<ShipType>

- - - - -
- If in placement mode, the ships that are yet to be placed. -
- - - -
Type:
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file diff --git a/documentation/generated/module_errors.js.html b/documentation/generated/module_errors.js.html index e4d1cbd..06df610 100644 --- a/documentation/generated/module_errors.js.html +++ b/documentation/generated/module_errors.js.html @@ -63,7 +63,7 @@ export class InvalidMissileFireAttemptError extends Error {}
diff --git a/documentation/generated/module_lang.js.html b/documentation/generated/module_lang.js.html index 720e13d..574eeff 100644 --- a/documentation/generated/module_lang.js.html +++ b/documentation/generated/module_lang.js.html @@ -58,7 +58,7 @@ export { instructions }
diff --git a/documentation/generated/module_sounds.js.html b/documentation/generated/module_sounds.js.html index 41abbd2..d09c007 100644 --- a/documentation/generated/module_sounds.js.html +++ b/documentation/generated/module_sounds.js.html @@ -100,7 +100,7 @@ export { GameSounds }
diff --git a/documentation/generated/module_util.js.html b/documentation/generated/module_util.js.html index 6a3788d..8a6f324 100644 --- a/documentation/generated/module_util.js.html +++ b/documentation/generated/module_util.js.html @@ -168,7 +168,7 @@ export function appUrl(path) {
diff --git a/documentation/generated/services_GameState.service.js.html b/documentation/generated/services_GameState.service.js.html index ab2c39b..f00cf71 100644 --- a/documentation/generated/services_GameState.service.js.html +++ b/documentation/generated/services_GameState.service.js.html @@ -751,7 +751,7 @@ export default game_service
diff --git a/lib/README.md b/lib/README.md index 6dad6e9..f2e29d8 100644 --- a/lib/README.md +++ b/lib/README.md @@ -7,5 +7,4 @@ The files in this directory are external libraries used in this project. - A kind-of crappy loader for defining Vue components using ES6 classes. - Also used under the terms of the MIT license. - https://code.garrettmills.dev/garrettmills/vues6 - -Sound effects obtained from https://www.zapsplat.com \ No newline at end of file +- Sound effects obtained from https://www.zapsplat.com \ No newline at end of file