466 lines
22 KiB
HTML
466 lines
22 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<!-- NewPage -->
|
||
|
|
<html lang="fr">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (15) on Fri May 07 15:56:25 CEST 2021 -->
|
||
|
|
<title>AbstractPlayer</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.model.player, class: AbstractPlayer">
|
||
|
|
<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":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
|
||
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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.model.player</a></div>
|
||
|
|
<h1 title="Class AbstractPlayer" class="title">Class AbstractPlayer</h1>
|
||
|
|
</div>
|
||
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
||
|
|
<div class="inheritance">battleship.model.player.AbstractPlayer</div>
|
||
|
|
</div>
|
||
|
|
<section class="description">
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>All Implemented Interfaces:</dt>
|
||
|
|
<dd><code><a href="Player.html" title="interface in battleship.model.player">Player</a></code></dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Direct Known Subclasses:</dt>
|
||
|
|
<dd><code><a href="Computer.html" title="class in battleship.model.player">Computer</a></code>, <code><a href="Human.html" title="class in battleship.model.player">Human</a></code></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
<pre>public abstract class <span class="type-name-label">AbstractPlayer</span>
|
||
|
|
extends java.lang.Object
|
||
|
|
implements <a href="Player.html" title="interface in battleship.model.player">Player</a></pre>
|
||
|
|
<div class="block">Abstract player class see <a href="Player.html" title="interface in battleship.model.player"><code>Player</code></a> to know more about this code organisation</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>See Also:</dt>
|
||
|
|
<dd><a href="Player.html" title="interface in battleship.model.player"><code>Player</code></a>,
|
||
|
|
<a href="Human.html" title="class in battleship.model.player"><code>Human</code></a>,
|
||
|
|
<a href="Computer.html" title="class in battleship.model.player"><code>Computer</code></a>,
|
||
|
|
<a href="Random.html" title="class in battleship.model.player"><code>Random</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>int</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#id">id</a></span></code></th>
|
||
|
|
<td class="col-last"> </td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-color">
|
||
|
|
<td class="col-first"><code>(package private) java.util.ArrayList<<a href="../../utils/Triplet.html" title="class in battleship.utils">Triplet</a><java.lang.Integer,​java.lang.Integer,​java.lang.Boolean>></code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#moves">moves</a></span></code></th>
|
||
|
|
<td class="col-last">
|
||
|
|
<div class="block">reference every shot on the opponent board, left and middle side of the Triplet reference the coordinates and the
|
||
|
|
right side if this move hit or not an opponent ship</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="alt-color">
|
||
|
|
<td class="col-first"><code>(package private) java.util.ArrayList<<a href="../Ship.html" title="class in battleship.model">Ship</a>></code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#ships">ships</a></span></code></th>
|
||
|
|
<td class="col-last"> </td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div class="inherited-list">
|
||
|
|
<h3 id="fields.inherited.from.class.battleship.model.player.Player">Fields inherited from interface battleship.model.player.<a href="Player.html" title="interface in battleship.model.player">Player</a></h3>
|
||
|
|
<code><a href="Player.html#shipSize">shipSize</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()">AbstractPlayer</a></span>()</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="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>void</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#addMove(battleship.utils.Triplet)">addMove</a></span>​(<a href="../../utils/Triplet.html" title="class in battleship.utils">Triplet</a><java.lang.Integer,​java.lang.Integer,​java.lang.Boolean> move)</code></th>
|
||
|
|
<td class="col-last">
|
||
|
|
<div class="block">add <code>move</code> to the <a href="#moves"><code>moves</code></a> list</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-color" id="i1">
|
||
|
|
<td class="col-first"><code>boolean</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#areValid(int,int)">areValid</a></span>​(int x,
|
||
|
|
int y)</code></th>
|
||
|
|
<td class="col-last">
|
||
|
|
<div class="block">check if coordinates from <a href="../../view/View.html#chooseMove(battleship.model.player.Player)"><code>View.chooseMove(Player)</code></a>are in valids position</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="alt-color" id="i2">
|
||
|
|
<td class="col-first"><code>int</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getId()">getId</a></span>()</code></th>
|
||
|
|
<td class="col-last"> </td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-color" id="i3">
|
||
|
|
<td class="col-first"><code>java.util.ArrayList<<a href="../../utils/Triplet.html" title="class in battleship.utils">Triplet</a><java.lang.Integer,​java.lang.Integer,​java.lang.Boolean>></code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getMoves()">getMoves</a></span>()</code></th>
|
||
|
|
<td class="col-last"> </td>
|
||
|
|
</tr>
|
||
|
|
<tr class="alt-color" id="i4">
|
||
|
|
<td class="col-first"><code>java.util.ArrayList<<a href="../Ship.html" title="class in battleship.model">Ship</a>></code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#getShips()">getShips</a></span>()</code></th>
|
||
|
|
<td class="col-last"> </td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-color" id="i5">
|
||
|
|
<td class="col-first"><code>void</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#setId(int)">setId</a></span>​(int i)</code></th>
|
||
|
|
<td class="col-last"> </td>
|
||
|
|
</tr>
|
||
|
|
<tr class="alt-color" id="i6">
|
||
|
|
<td class="col-first"><code>boolean</code></td>
|
||
|
|
<th class="col-second" scope="row"><code><span class="member-name-link"><a href="#setShips(battleship.model.Ship)">setShips</a></span>​(<a href="../Ship.html" title="class in battleship.model">Ship</a> ship)</code></th>
|
||
|
|
<td class="col-last">
|
||
|
|
<div class="block">check if ship position and direction are valides and does not overlap on other vessels
|
||
|
|
add the ship to player <a href="#ships"><code>ships</code></a> list and return <code>true</code> if valid
|
||
|
|
<code>false</code> otherwise</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="row-color" id="i7">
|
||
|
|
<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"> </td>
|
||
|
|
</tr>
|
||
|
|
<tr class="alt-color" id="i8">
|
||
|
|
<td class="col-first"><code>java.util.ArrayList<<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="#validMoves()">validMoves</a></span>()</code></th>
|
||
|
|
<td class="col-last">
|
||
|
|
<div class="block">give a list of the player possible moves, used in <a href="Player.html#chooseMove()"><code>Player.chooseMove()</code></a></div>
|
||
|
|
</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.model.player.Player">Methods inherited from interface battleship.model.player.<a href="Player.html" title="interface in battleship.model.player">Player</a></h3>
|
||
|
|
<code><a href="Player.html#chooseMove()">chooseMove</a>, <a href="Player.html#placeShips()">placeShips</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="ships">
|
||
|
|
<h3>ships</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">final</span> <span class="return-type">java.util.ArrayList<<a href="../Ship.html" title="class in battleship.model">Ship</a>></span> <span class="member-name">ships</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="moves">
|
||
|
|
<h3>moves</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">final</span> <span class="return-type">java.util.ArrayList<<a href="../../utils/Triplet.html" title="class in battleship.utils">Triplet</a><java.lang.Integer,​java.lang.Integer,​java.lang.Boolean>></span> <span class="member-name">moves</span></div>
|
||
|
|
<div class="block">reference every shot on the opponent board, left and middle side of the Triplet reference the coordinates and the
|
||
|
|
right side if this move hit or not an opponent ship</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="id">
|
||
|
|
<h3>id</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="member-name">id</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>()">
|
||
|
|
<h3>AbstractPlayer</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="member-name">AbstractPlayer</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="setShips(battleship.model.Ship)">
|
||
|
|
<h3>setShips</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="member-name">setShips</span>​(<span class="parameters"><a href="../Ship.html" title="class in battleship.model">Ship</a> ship)</span></div>
|
||
|
|
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Player.html#setShips(battleship.model.Ship)">Player</a></code></span></div>
|
||
|
|
<div class="block">check if ship position and direction are valides and does not overlap on other vessels
|
||
|
|
add the ship to player <a href="#ships"><code>ships</code></a> list and return <code>true</code> if valid
|
||
|
|
<code>false</code> otherwise</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Specified by:</dt>
|
||
|
|
<dd><code><a href="Player.html#setShips(battleship.model.Ship)">setShips</a></code> in interface <code><a href="Player.html" title="interface in battleship.model.player">Player</a></code></dd>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>ship</code> - the ship instance we check</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd><code>true</code> if ship data are valids, <code>false</code> otherwise</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="addMove(battleship.utils.Triplet)">
|
||
|
|
<h3>addMove</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="member-name">addMove</span>​(<span class="parameters"><a href="../../utils/Triplet.html" title="class in battleship.utils">Triplet</a><java.lang.Integer,​java.lang.Integer,​java.lang.Boolean> move)</span></div>
|
||
|
|
<div class="block">add <code>move</code> to the <a href="#moves"><code>moves</code></a> list</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Specified by:</dt>
|
||
|
|
<dd><code><a href="Player.html#addMove(battleship.utils.Triplet)">addMove</a></code> in interface <code><a href="Player.html" title="interface in battleship.model.player">Player</a></code></dd>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>move</code> - the move chosen by the player</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="validMoves()">
|
||
|
|
<h3>validMoves</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">java.util.ArrayList<<a href="../../utils/Pair.html" title="class in battleship.utils">Pair</a><java.lang.Integer,​java.lang.Integer>></span> <span class="member-name">validMoves</span>()</div>
|
||
|
|
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Player.html#validMoves()">Player</a></code></span></div>
|
||
|
|
<div class="block">give a list of the player possible moves, used in <a href="Player.html#chooseMove()"><code>Player.chooseMove()</code></a></div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Specified by:</dt>
|
||
|
|
<dd><code><a href="Player.html#validMoves()">validMoves</a></code> in interface <code><a href="Player.html" title="interface in battleship.model.player">Player</a></code></dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd>a list of playable move</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="areValid(int,int)">
|
||
|
|
<h3>areValid</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="member-name">areValid</span>​(<span class="parameters">int x,
|
||
|
|
int y)</span></div>
|
||
|
|
<div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Player.html#areValid(int,int)">Player</a></code></span></div>
|
||
|
|
<div class="block">check if coordinates from <a href="../../view/View.html#chooseMove(battleship.model.player.Player)"><code>View.chooseMove(Player)</code></a>are in valids position</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Specified by:</dt>
|
||
|
|
<dd><code><a href="Player.html#areValid(int,int)">areValid</a></code> in interface <code><a href="Player.html" title="interface in battleship.model.player">Player</a></code></dd>
|
||
|
|
<dt>Parameters:</dt>
|
||
|
|
<dd><code>x</code> - the x-axis of the coordinates</dd>
|
||
|
|
<dd><code>y</code> - the y-axis of the coordinates</dd>
|
||
|
|
<dt>Returns:</dt>
|
||
|
|
<dd><code>true</code> if valid, <code>false</code> otherwise</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="setId(int)">
|
||
|
|
<h3>setId</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="member-name">setId</span>​(<span class="parameters">int i)</span></div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Specified by:</dt>
|
||
|
|
<dd><code><a href="Player.html#setId(int)">setId</a></code> in interface <code><a href="Player.html" title="interface in battleship.model.player">Player</a></code></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getId()">
|
||
|
|
<h3>getId</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="member-name">getId</span>()</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Specified by:</dt>
|
||
|
|
<dd><code><a href="Player.html#getId()">getId</a></code> in interface <code><a href="Player.html" title="interface in battleship.model.player">Player</a></code></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<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>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Overrides:</dt>
|
||
|
|
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getShips()">
|
||
|
|
<h3>getShips</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">java.util.ArrayList<<a href="../Ship.html" title="class in battleship.model">Ship</a>></span> <span class="member-name">getShips</span>()</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Specified by:</dt>
|
||
|
|
<dd><code><a href="Player.html#getShips()">getShips</a></code> in interface <code><a href="Player.html" title="interface in battleship.model.player">Player</a></code></dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="getMoves()">
|
||
|
|
<h3>getMoves</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">java.util.ArrayList<<a href="../../utils/Triplet.html" title="class in battleship.utils">Triplet</a><java.lang.Integer,​java.lang.Integer,​java.lang.Boolean>></span> <span class="member-name">getMoves</span>()</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Specified by:</dt>
|
||
|
|
<dd><code><a href="Player.html#getMoves()">getMoves</a></code> in interface <code><a href="Player.html" title="interface in battleship.model.player">Player</a></code></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>
|