525 lines
28 KiB
HTML
525 lines
28 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="fr">
|
|
<head>
|
|
<!-- Generated by javadoc (15) on Fri May 07 15:56:25 CEST 2021 -->
|
|
<title>AbstractView</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf8">
|
|
<meta name="dc.created" content="2021-05-07">
|
|
<meta name="description" content="declaration: package: battleship.view, class: AbstractView">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../script.js"></script>
|
|
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"i6":6,"i7":6,"i8":10,"i9":6,"i10":10,"i11":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "alt-color";
|
|
var rowColor = "row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar.top">
|
|
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../index-all.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip.navbar.top">
|
|
<!-- -->
|
|
</span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">battleship.view</a></div>
|
|
<h1 title="Class AbstractView" class="title">Class AbstractView</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance">battleship.view.AbstractView</div>
|
|
</div>
|
|
<section class="description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="View.html" title="interface in battleship.view">View</a></code></dd>
|
|
</dl>
|
|
<dl class="notes">
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><code><a href="Terminal.html" title="class in battleship.view">Terminal</a></code>, <code><a href="Window.html" title="class in battleship.view">Window</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public abstract class <span class="type-name-label">AbstractView</span>
|
|
extends java.lang.Object
|
|
implements <a href="View.html" title="interface in battleship.view">View</a></pre>
|
|
<div class="block">Abstract view class</div>
|
|
<dl class="notes">
|
|
<dt>See Also:</dt>
|
|
<dd><a href="View.html" title="interface in battleship.view"><code>View</code></a>,
|
|
<a href="Window.html" title="class in battleship.view"><code>Window</code></a>,
|
|
<a href="Terminal.html" title="class in battleship.view"><code>Terminal</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field.summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="member-summary">
|
|
<table class="summary-table">
|
|
<caption><span>Fields</span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="col-first" scope="col">Modifier and Type</th>
|
|
<th class="col-second" scope="col">Field</th>
|
|
<th class="col-last" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="alt-color">
|
|
<td class="col-first"><code>protected <a href="../model/Game.html" title="class in battleship.model">Game</a></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#game">game</a></span></code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="fields.inherited.from.class.battleship.view.View">Fields inherited from interface battleship.view.<a href="View.html" title="interface in battleship.view">View</a></h3>
|
|
<code><a href="View.html#shipsSize">shipsSize</a></code></div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor.summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="member-summary">
|
|
<table class="summary-table">
|
|
<caption><span>Constructors</span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="col-first" scope="col">Constructor</th>
|
|
<th class="col-last" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="alt-color">
|
|
<th class="col-constructor-name" scope="row"><code><span class="member-name-link"><a href="#%3Cinit%3E(battleship.model.Game)">AbstractView</a></span>​(<a href="../model/Game.html" title="class in battleship.model">Game</a> game)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method.summary">
|
|
<h2>Method Summary</h2>
|
|
<div class="member-summary" id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="table-tab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="table-tab" onclick="show(8);">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<table class="summary-table" aria-labelledby="t0">
|
|
<thead>
|
|
<tr>
|
|
<th class="col-first" scope="col">Modifier and Type</th>
|
|
<th class="col-second" scope="col">Method</th>
|
|
<th class="col-last" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="alt-color" id="i0">
|
|
<td class="col-first"><code><a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#chooseMove(battleship.model.player.Player)">chooseMove</a></span>​(<a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</code></th>
|
|
<td class="col-last">
|
|
<div class="block">used by <a href="../model/player/Computer.html" title="class in battleship.model.player"><code>Computer</code></a> player to play a move in the grid depending of its algorithm</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-color" id="i1">
|
|
<td class="col-first"><code>protected <a href="../model/Direction.html" title="enum in battleship.model">Direction</a></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getDirectionFromChar()">getDirectionFromChar</a></span>()</code></th>
|
|
<td class="col-last">
|
|
<div class="block">ask player for keyboard input and parse it into one of <a href="../model/Direction.html" title="enum in battleship.model"><code>Direction</code></a> value</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="alt-color" id="i2">
|
|
<td class="col-first"><code>protected abstract java.lang.String</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getKeyInput()">getKeyInput</a></span>()</code></th>
|
|
<td class="col-last">
|
|
<div class="block">ask player for keyboard input and return result</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-color" id="i3">
|
|
<td class="col-first"><code>private int</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#isPositionDrowned(battleship.model.player.Player,battleship.model.Ship,battleship.utils.Pair)">isPositionDrowned</a></span>​(<a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> other,
|
|
<a href="../model/Ship.html" title="class in battleship.model">Ship</a> ship,
|
|
<a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer> pair)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="alt-color" id="i4">
|
|
<td class="col-first"><code>private int</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#isPositionDrowned(battleship.model.player.Player,battleship.utils.Pair)">isPositionDrowned</a></span>​(<a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> other,
|
|
<a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer> pair)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="row-color" id="i5">
|
|
<td class="col-first"><code>private boolean</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#isShipPosition(battleship.model.Ship,battleship.utils.Pair)">isShipPosition</a></span>​(<a href="../model/Ship.html" title="class in battleship.model">Ship</a> ship,
|
|
<a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer> boardsCoords)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
<tr class="alt-color" id="i6">
|
|
<td class="col-first"><code>protected abstract java.lang.String</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#keyboardInput()">keyboardInput</a></span>()</code></th>
|
|
<td class="col-last">
|
|
<div class="block">ask <a href="../model/Game.html#currentPlayer"><code>Game.currentPlayer</code></a> for keyboard input</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-color" id="i7">
|
|
<td class="col-first"><code>protected abstract <a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer></code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#mouseInput(battleship.model.player.Player)">mouseInput</a></span>​(<a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</code></th>
|
|
<td class="col-last">
|
|
<div class="block">ask <code>player</code> for mouse input</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="alt-color" id="i8">
|
|
<td class="col-first"><code>void</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#setShips(battleship.model.player.Player)">setShips</a></span>​(<a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</code></th>
|
|
<td class="col-last">
|
|
<div class="block">used if <code>player</code> instance of <a href="../model/player/Computer.html" title="class in battleship.model.player"><code>Computer</code></a></div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-color" id="i9">
|
|
<td class="col-first"><code>protected abstract void</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#setUpperText(java.lang.String)">setUpperText</a></span>​(java.lang.String s)</code></th>
|
|
<td class="col-last">
|
|
<div class="block">Display a text above the grid on <a href="Window.html" title="class in battleship.view"><code>Window</code></a>, simply print text on <a href="Terminal.html" title="class in battleship.view"><code>Terminal</code></a></div>
|
|
</td>
|
|
</tr>
|
|
<tr class="alt-color" id="i10">
|
|
<td class="col-first"><code>java.lang.String</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#toString()">toString</a></span>()</code></th>
|
|
<td class="col-last">
|
|
<div class="block">Used during debugging, used in terminal to display grids too</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="row-color" id="i11">
|
|
<td class="col-first"><code>java.lang.String</code></td>
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#toString(boolean)">toString</a></span>​(boolean debug)</code></th>
|
|
<td class="col-last"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods.inherited.from.class.battleship.view.View">Methods inherited from interface battleship.view.<a href="View.html" title="interface in battleship.view">View</a></h3>
|
|
<code><a href="View.html#displayBoard()">displayBoard</a>, <a href="View.html#displayWinner(battleship.model.player.Player)">displayWinner</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field.detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="game">
|
|
<h3>game</h3>
|
|
<div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../model/Game.html" title="class in battleship.model">Game</a></span> <span class="member-name">game</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor.detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>(battleship.model.Game)">
|
|
<h3>AbstractView</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="member-name">AbstractView</span>​(<span class="parameters"><a href="../model/Game.html" title="class in battleship.model">Game</a> game)</span></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method.detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="toString()">
|
|
<h3>toString</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">java.lang.String</span> <span class="member-name">toString</span>()</div>
|
|
<div class="block">Used during debugging, used in terminal to display grids too</div>
|
|
<dl class="notes">
|
|
<dt>Overrides:</dt>
|
|
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>all player grids</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="toString(boolean)">
|
|
<h3>toString</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">java.lang.String</span> <span class="member-name">toString</span>​(<span class="parameters">boolean debug)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isShipPosition(battleship.model.Ship,battleship.utils.Pair)">
|
|
<h3>isShipPosition</h3>
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="member-name">isShipPosition</span>​(<span class="parameters"><a href="../model/Ship.html" title="class in battleship.model">Ship</a> ship,
|
|
<a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer> boardsCoords)</span></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd><code>true</code> if <a href="../model/Ship.html#getFullCoords()"><code>Ship.getFullCoords()</code></a> contains <code>boardsCoords</code>, <code>false</code> otherwise</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDirectionFromChar()">
|
|
<h3>getDirectionFromChar</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../model/Direction.html" title="enum in battleship.model">Direction</a></span> <span class="member-name">getDirectionFromChar</span>()
|
|
throws <span class="exceptions">java.lang.InterruptedException</span></div>
|
|
<div class="block">ask player for keyboard input and parse it into one of <a href="../model/Direction.html" title="enum in battleship.model"><code>Direction</code></a> value</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Direction depending of player input</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>java.lang.InterruptedException</code> - caused by <a href="Window.html#getKeyInput()"><code>Window.getKeyInput()</code></a></dd>
|
|
<dt>See Also:</dt>
|
|
<dd><a href="#getDirectionFromChar()"><code>getDirectionFromChar()</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getKeyInput()">
|
|
<h3>getKeyInput</h3>
|
|
<div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">java.lang.String</span> <span class="member-name">getKeyInput</span>()
|
|
throws <span class="exceptions">java.lang.InterruptedException</span></div>
|
|
<div class="block">ask player for keyboard input and return result</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>String given by player</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>java.lang.InterruptedException</code> - see <a href="Window.html#getKeyInput()"><code>Window.getKeyInput()</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setUpperText(java.lang.String)">
|
|
<h3>setUpperText</h3>
|
|
<div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">void</span> <span class="member-name">setUpperText</span>​(<span class="parameters">java.lang.String s)</span></div>
|
|
<div class="block">Display a text above the grid on <a href="Window.html" title="class in battleship.view"><code>Window</code></a>, simply print text on <a href="Terminal.html" title="class in battleship.view"><code>Terminal</code></a></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>s</code> - text to display</dd>
|
|
<dt>See Also:</dt>
|
|
<dd><a href="Window.html#setUpperText(java.lang.String)"><code>Window.setUpperText(String)</code></a>,
|
|
<a href="Terminal.html#setUpperText(java.lang.String)"><code>Terminal.setUpperText(String)</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setShips(battleship.model.player.Player)">
|
|
<h3>setShips</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="member-name">setShips</span>​(<span class="parameters"><a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</span>
|
|
throws <span class="exceptions">java.lang.InterruptedException</span></div>
|
|
<div class="block">used if <code>player</code> instance of <a href="../model/player/Computer.html" title="class in battleship.model.player"><code>Computer</code></a></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="View.html#setShips(battleship.model.player.Player)">setShips</a></code> in interface <code><a href="View.html" title="interface in battleship.view">View</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>player</code> - player we ask to set position of its ships</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>java.lang.InterruptedException</code> - see <a href="Window.html#setShips(battleship.model.player.Player)"><code>Window.setShips(Player)</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isPositionDrowned(battleship.model.player.Player,battleship.model.Ship,battleship.utils.Pair)">
|
|
<h3>isPositionDrowned</h3>
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="member-name">isPositionDrowned</span>​(<span class="parameters"><a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> other,
|
|
<a href="../model/Ship.html" title="class in battleship.model">Ship</a> ship,
|
|
<a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer> pair)</span></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>other</code> - other than the current player</dd>
|
|
<dd><code>ship</code> - check if this ship at this position has been hit</dd>
|
|
<dd><code>pair</code> - coords</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>1 if ship fully drowned, 2 if only damaged, 0 if not</dd>
|
|
<dt>See Also:</dt>
|
|
<dd><a href="#isPositionDrowned(battleship.model.player.Player,battleship.utils.Pair)"><code>isPositionDrowned(Player, Pair)</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isPositionDrowned(battleship.model.player.Player,battleship.utils.Pair)">
|
|
<h3>isPositionDrowned</h3>
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="member-name">isPositionDrowned</span>​(<span class="parameters"><a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> other,
|
|
<a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer> pair)</span></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>other</code> - other than the current player</dd>
|
|
<dd><code>pair</code> - coords to check</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>2 if player already played here, 0 otherwise</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="chooseMove(battleship.model.player.Player)">
|
|
<h3>chooseMove</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer></span> <span class="member-name">chooseMove</span>​(<span class="parameters"><a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</span>
|
|
throws <span class="exceptions">java.lang.InterruptedException</span></div>
|
|
<div class="block">used by <a href="../model/player/Computer.html" title="class in battleship.model.player"><code>Computer</code></a> player to play a move in the grid depending of its algorithm</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code><a href="View.html#chooseMove(battleship.model.player.Player)">chooseMove</a></code> in interface <code><a href="View.html" title="interface in battleship.view">View</a></code></dd>
|
|
<dt>Parameters:</dt>
|
|
<dd><code>player</code> - <a href="../model/Game.html#currentPlayer"><code>Game.currentPlayer</code></a></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>a couple (<a href="../utils/Pair.html" title="class in battleship.utils"><code>Pair</code></a> containing the x and y coordinate (left side store Y and right side X)</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>java.lang.InterruptedException</code> - see <a href="Window.html#chooseMove(battleship.model.player.Player)"><code>Window.chooseMove(Player)</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="mouseInput(battleship.model.player.Player)">
|
|
<h3>mouseInput</h3>
|
|
<div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type"><a href="../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer></span> <span class="member-name">mouseInput</span>​(<span class="parameters"><a href="../model/player/Player.html" title="interface in battleship.model.player">Player</a> player)</span>
|
|
throws <span class="exceptions">java.lang.InterruptedException</span></div>
|
|
<div class="block">ask <code>player</code> for mouse input</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>player</code> - <a href="../model/Game.html#currentPlayer"><code>Game.currentPlayer</code></a></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>coordinate of <code>player</code> opponent grid</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>java.lang.InterruptedException</code> - see <a href="Window.html#mouseInput(battleship.model.player.Player)"><code>Window.mouseInput(Player)</code></a></dd>
|
|
<dt>See Also:</dt>
|
|
<dd><a href="Window.html#mouseInput(battleship.model.player.Player)"><code>Window.mouseInput(Player)</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="keyboardInput()">
|
|
<h3>keyboardInput</h3>
|
|
<div class="member-signature"><span class="modifiers">protected abstract</span> <span class="return-type">java.lang.String</span> <span class="member-name">keyboardInput</span>()
|
|
throws <span class="exceptions">java.lang.InterruptedException</span></div>
|
|
<div class="block">ask <a href="../model/Game.html#currentPlayer"><code>Game.currentPlayer</code></a> for keyboard input</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>String given by player</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code>java.lang.InterruptedException</code> - see <a href="Window.html#keyboardInput()"><code>Window.keyboardInput()</code></a></dd>
|
|
<dt>See Also:</dt>
|
|
<dd><a href="Window.html#keyboardInput()"><code>Window.keyboardInput()</code></a>,
|
|
<a href="Terminal.html#keyboardInput()"><code>Terminal.keyboardInput()</code></a>,
|
|
<a href="Terminal.html#keyboardInputInteger()"><code>Terminal.keyboardInputInteger()</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottom-nav" id="navbar.bottom">
|
|
<div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../index-all.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<span class="skip-nav" id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</span></nav>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|