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.
eecs448-project-1/documentation/generated/components_TopLevel.compone...

284 lines
9.8 KiB

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: components/TopLevel.component.js</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">Source: components/TopLevel.component.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>import {Component} from '../../lib/vues6.js'
import {GameState, ShipType} from '../module/util.js'
import {instructions} from '../module/lang.js'
import game_service from '../services/GameState.service.js'
import {GameSounds} from '../module/sounds.js'
const template = `
&lt;div class="top-level-container">
&lt;div class="top-level-component">
&lt;div v-if="current_state === GameState.ChoosingNumberOfShips" class="game-choose-ships-container">
&lt;span v-if="instructions">{{ instructions }}&lt;/span>
&lt;div style="margin-top: 30px;">
&lt;button @click="ship(1)" class="shipBtn">1 ship&lt;/button>
&lt;button @click="ship(2)" class="shipBtn">2 ships&lt;/button>
&lt;button @click="ship(3)" class="shipBtn">3 ships&lt;/button>
&lt;button @click="ship(4)" class="shipBtn">4 ships&lt;/button>
&lt;button @click="ship(5)" class="shipBtn">5 ships&lt;/button>
&lt;/div>
&lt;/div>
&lt;div v-if="current_state === GameState.PromptPlayerChange" class="game-player-change-container">
It is now {{ current_player_display }}'s turn!
&lt;button @click="confirm_player_change" class="playerBtn">Continue&lt;/button>
&lt;/div>
&lt;div
v-if="current_state !== GameState.ChoosingNumberOfShips &amp;&amp; current_state !== GameState.PromptPlayerChange &amp;&amp; instructions"
class="instructions"
>
{{ instructions.replace('{player}', current_player_display) }}
&lt;/div>
&lt;div
v-if="current_state !== GameState.ChoosingNumberOfShips
&amp;&amp; current_state !== GameState.PromptPlayerChange
&amp;&amp; current_state !== GameState.PlayerVictory"
class="game-boards-container"
>
&lt;!-- Opponent's board -->
&lt;div class="game-board">
&lt;app-game-board
v-bind:rows="opponent_rows"
v-bind:is_missile_mode="player_is_firing_missiles"
@missilefired="on_missile_fired"
>&lt;/app-game-board>
&lt;div class="fleet-label">Opposing fleet&lt;/div>
&lt;/div>
&lt;!-- Player's board -->
&lt;div class="game-board">
&lt;app-game-board
v-bind:rows="player_rows"
v-bind:is_placement_mode="player_is_placing_ships"
v-bind:ships_to_place="ships_to_place"
@shipplaced="on_ship_placed"
>&lt;/app-game-board>
&lt;div class="fleet-label">Your fleet&lt;/div>
&lt;/div>
&lt;/div>
&lt;div
v-if="current_state === GameState.PlayerVictory"
class="game-boards-container"
>
&lt;!-- Winner's board -->
&lt;div class="game-board">
&lt;app-game-board
v-bind:rows="player_rows"
>&lt;/app-game-board>
&lt;div class="fleet-label">{{ current_player_display }}'s fleet (winner)&lt;/div>
&lt;/div>
&lt;!-- Loser's board -->
&lt;div class="game-board">
&lt;app-game-board
v-bind:rows="opponent_rows"
>&lt;/app-game-board>
&lt;div class="fleet-label">{{ current_opponent_display }}'s fleet&lt;/div>
&lt;/div>
&lt;/div>
&lt;/div>
&lt;div class="scoreboard-container">
&lt;app-scoreboard>&lt;/app-scoreboard>
&lt;/div>
&lt;/div>
`
/**
* Top-level component which manages the display of the entire game.
* @extends Component
*/
class TopLevelComponent extends Component {
static get selector() { return 'app-top-level' }
static get template() { return template }
static get props() { return [] }
/**
* Make the game state accessible w/in the template.
* @type {object}
*/
GameState = GameState
/**
* The current game state.
* @type {GameState|undefined}
*/
current_state = undefined
/**
* The opponent's grid data.
* @type {object[][]}
*/
opponent_rows = []
/**
* The player's grid data.
* @type {object[][]}
*/
player_rows = []
/**
* The current instructions to be shown to the user.
* @type {string}
*/
instructions = instructions[GameState.ChoosingNumberOfShips]
/**
* True if the player should be able to place their ships.
* @type {boolean}
*/
player_is_placing_ships = false
/**
* True if the player should be able to fire missiles at their opponent.
* @type {boolean}
*/
player_is_firing_missiles = false
/**
* If in placement mode, the ships that are yet to be placed.
* @type {ShipType[]}
*/
ships_to_place = []
/**
* The display name of the current player.
* @type {string}
*/
current_player_display = ''
/**
* The display name of the current opponent.
* @type {string}
*/
current_opponent_display = ''
/**
* Called when the component is initialized.
* @return {Promise&lt;void>}
*/
async vue_on_create() {
this.current_state = game_service.get_game_state()
// Called every time the game state is updated
game_service.on_state_change((next_state, was_refresh) => {
this.current_state = next_state
this.opponent_rows = game_service.get_current_opponent_state()
this.player_rows = game_service.get_current_player_state()
this.current_player_display = game_service.get_player_display(game_service.get_current_player())
this.current_opponent_display = game_service.get_player_display(game_service.get_current_opponent())
this.player_is_placing_ships = next_state === GameState.PlayerSetup
this.player_is_firing_missiles = next_state === GameState.PlayerTurn
if ( !was_refresh &amp;&amp; this.player_is_placing_ships ) {
this.ships_to_place = game_service.get_possible_boats()
}
if ( next_state === GameState.PlayerVictory ) {
const [victor_state, loser_state] = game_service.get_player_victory_state()
this.player_rows = victor_state
this.opponent_rows = loser_state
}
this.instructions = instructions[this.current_state]
})
}
/**
* Set the number of boats.
* @param {number} n
*/
ship(n) {
game_service.set_n_boats(n)
game_service.advance_game_state()
}
/**
* Called when the current user has placed a ship.
*/
on_ship_placed() {
this.ships_to_place.shift()
if ( this.ships_to_place.length &lt; 1 ) {
// We've placed all the ships. Let's move on.
game_service.advance_game_state()
}
}
/**
* Called when the player attempts to fire a missile.
* @param {number} row_index
* @param {number} column_index
*/
async on_missile_fired([row_index, column_index]) {
if ( this.player_is_firing_missiles ) {
await GameSounds.Fire.play()
const success = game_service.attempt_missile_fire([row_index, column_index])
if ( success ) await GameSounds.Hit.play()
else await GameSounds.Miss.play()
// Give the user time to see whether they hit or not
setTimeout(() => {
game_service.advance_game_state()
}, 2000)
}
}
/**
* Called when the player has confirmed the player change.
*/
confirm_player_change() {
game_service.advance_game_state()
}
}
export default TopLevelComponent
</code></pre>
</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>