garrettmills
/
eecs448-project-1
mirror of https://github.com/EECS-448-Battleship/project-1
1
0
Fork 0
Code Issues Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e22f722092'
${ noResults }
eecs448-project-1/documentation/generated/GameBoardComponent.html

1866 lines
20 KiB
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: GameBoardComponent</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: GameBoardComponent</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>GameBoardComponent<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description">A component which represents a single, programmable game board.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="GameBoardComponent"><span class="type-signature"></span>new GameBoardComponent<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line47">line 47</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li>Component</li>
</ul>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="bound_fns"><span class="type-signature"></span>bound_fns<span class="type-signature"> :Array.&lt;function()></span></h4>
<div class="description">
Array of functions bound to event listeners. Used to
remove event listeners on destroy.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;function()></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line89">line 89</a>
</li></ul></dd>
</dl>
<h4 class="name" id="column_labels"><span class="type-signature"></span>column_labels<span class="type-signature"> :Array.&lt;string></span></h4>
<div class="description">
The various column labels to display.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;string></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line63">line 63</a>
</li></ul></dd>
</dl>
<h4 class="name" id="current_placement"><span class="type-signature"></span>current_placement<span class="type-signature"> :string</span></h4>
<div class="description">
The ship currently being placed.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ready"><span class="type-signature"></span>ready<span class="type-signature"> :boolean</span></h4>
<div class="description">
If true, the grid is ready to be rendered. If false,
the grid will be hidden.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line57">line 57</a>
</li></ul></dd>
</dl>
<h4 class="name" id="shift_pressed"><span class="type-signature"></span>shift_pressed<span class="type-signature"> :boolean</span></h4>
<div class="description">
Set to true when the shift key is pressed.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line82">line 82</a>
</li></ul></dd>
</dl>
<h4 class="name" id="ship_ghost_cells"><span class="type-signature"></span>ship_ghost_cells<span class="type-signature"> :Array.&lt;number></span></h4>
<div class="description">
Array of coordinates as [row_index, column_index] of cells which should
show a ghost ship overlay.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;number></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="is_ghost_cell"><span class="type-signature"></span>is_ghost_cell<span class="signature">(row_i, col_i)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns a truthy value if the given cell is a ghost ship.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>row_i</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>col_i</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line205">line 205</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="is_ship_cell"><span class="type-signature"></span>is_ship_cell<span class="signature">(row_i, col_i)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Returns true if the cell at [row_index, column_index] is a ship.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>row_i</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>col_i</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line188">line 188</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="on_cell_click"><span class="type-signature"></span>on_cell_click<span class="signature">(row_i, cell_i)</span><span class="type-signature"></span></h4>
<div class="description">
Called when a user clicks a cell. If in placement mode, will attempt to place
a ship. If in missile mode, will attempt to fire a missile.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>row_i</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">the index of the row</td>
</tr>
<tr>
<td class="name"><code>cell_i</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">the index of the cell</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line125">line 125</a>
</li></ul></dd>
</dl>
<h4 class="name" id="on_cell_hover"><span class="type-signature"></span>on_cell_hover<span class="signature">(row_i, cell_i)</span><span class="type-signature"></span></h4>
<div class="description">
Called when the user hovers over a cell.
When in placement mode, this updates the cells that show the ghost ship.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>row_i</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>cell_i</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line147">line 147</a>
</li></ul></dd>
</dl>
<h4 class="name" id="on_keydown"><span class="type-signature"></span>on_keydown<span class="signature">(event)</span><span class="type-signature"></span></h4>
<div class="description">
When keydown, check if shift was pressed. If so, update the placement.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line213">line 213</a>
</li></ul></dd>
</dl>
<h4 class="name" id="on_keyup"><span class="type-signature"></span>on_keyup<span class="signature">(event)</span><span class="type-signature"></span></h4>
<div class="description">
When keyup, check if shift was released. If so, update the placement.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line226">line 226</a>
</li></ul></dd>
</dl>
<h4 class="name" id="on_mouse_leave"><span class="type-signature"></span>on_mouse_leave<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Hide the ghost ship when the mouse leaves the grid.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line195">line 195</a>
</li></ul></dd>
</dl>
<h4 class="name" id="vue_on_create"><span class="type-signature">(async) </span>vue_on_create<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
<div class="description">
Called when the component is initialized.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line95">line 95</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;void></span>
</dd>
</dl>
<h4 class="name" id="vue_on_destroy"><span class="type-signature">(async) </span>vue_on_destroy<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
<div class="description">
Called when the component is destroyed.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="components_GameBoard.component.js.html">components/GameBoard.component.js</a>, <a href="components_GameBoard.component.js.html#line112">line 112</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.&lt;void></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-errors.html">errors</a></li><li><a href="module-lang.html">lang</a></li><li><a href="module-sounds.html">sounds</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="GameBoardComponent.html">GameBoardComponent</a></li><li><a href="GameStateService.html">GameStateService</a></li><li><a href="GridCellComponent.html">GridCellComponent</a></li><li><a href="module-errors.InvalidAdvanceStateError.html">InvalidAdvanceStateError</a></li><li><a href="module-errors.InvalidMissileFireAttemptError.html">InvalidMissileFireAttemptError</a></li><li><a href="module-errors.InvalidShipPlacementError.html">InvalidShipPlacementError</a></li><li><a href="module-sounds-Sound.html">Sound</a></li><li><a href="ScoreBoardComponent.html">ScoreBoardComponent</a></li><li><a href="TopLevelComponent.html">TopLevelComponent</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sat Sep 12 2020 16:40:09 GMT-0500 (Central Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in new issue View Git Blame Copy Permalink