dukantic/gomoku
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Aubin DORIVAL
2025-03-31 12:01:51 +02:00
parent 0867ea36c1
commit 7efba643b5
29 changed files with 1966 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
doc/Player.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (24) on Fri Mar 28 11:00:03 CET 2025 -->
<!-- Generated by javadoc (24) on Mon Mar 31 12:00:50 CEST 2025 -->
<title>Player</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2025-03-28">
<meta name="dc.created" content="2025-03-31">
<meta name="description" content="declaration: class: Player">
<meta name="generator" content="javadoc/ClassWriter">
<link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">
@@ -67,6 +67,7 @@ loadScripts(document, 'script');</script>
<li><a href="#field-detail" tabindex="0">Field Details</a>
<ol class="toc-list">
<li><a href="#name" tabindex="0">name</a></li>
<li><a href="#color" tabindex="0">color</a></li>
</ol>
</li>
<li><a href="#constructor-detail" tabindex="0">Constructor Details</a>
@@ -76,7 +77,9 @@ loadScripts(document, 'script');</script>
</li>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#Player(java.lang.String,Color)" tabindex="0">Player(String, Color)</a></li>
<li><a href="#getName()" tabindex="0">getName()</a></li>
<li><a href="#getColor()" tabindex="0">getColor()</a></li>
<li><a href="#chooseMove(GomokuBoard)" tabindex="0">chooseMove(GomokuBoard)</a></li>
</ol>
</li>
@@ -91,6 +94,10 @@ loadScripts(document, 'script');</script>
<div class="inheritance">Player</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="GomokuAI.html" title="class in Unnamed Package">GomokuAI</a></code>, <code><a href="Human.html" title="class in Unnamed Package">Human</a></code></dd>
</dl>
<hr>
<div class="horizontal-scroll">
<div class="type-signature"><span class="modifiers">abstract class </span><span class="element-name type-name-label">Player</span>
@@ -108,9 +115,16 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#name" class="member-name-link">name</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>protected <a href="Color.html" title="enum class in Unnamed Package">Color</a></code></div>
<div class="col-second even-row-color"><code><a href="#color" class="member-name-link">color</a></code></div>
<div class="col-last even-row-color">
<div class="block">The color of the Player</div>
</div>
<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#name" class="member-name-link">name</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The name of the Player</div>
</div>
</div>
</section>
</li>
@@ -138,12 +152,27 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="Coordinate.html" title="class in Unnamed Package">Coordinate</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#chooseMove(GomokuBoard)" class="member-name-link">chooseMove</a><wbr>(<a href="GomokuBoard.html" title="class in Unnamed Package">GomokuBoard</a>&nbsp;Board)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#chooseMove(GomokuBoard)" class="member-name-link">chooseMove</a><wbr>(<a href="GomokuBoard.html" title="class in Unnamed Package">GomokuBoard</a>&nbsp;board)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Return the coordinate of the move played by the player.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Color.html" title="enum class in Unnamed Package">Color</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getColor()" class="member-name-link">getColor</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the color of the player.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the name of the player.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#Player(java.lang.String,Color)" class="member-name-link">Player</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="Color.html" title="enum class in Unnamed Package">Color</a>&nbsp;color)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The constructor of the Player.</div>
</div>
</div>
</div>
</div>
@@ -166,6 +195,16 @@ loadScripts(document, 'script');</script>
<h3>name</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">name</span></div>
<div class="block">The name of the Player</div>
</div>
</section>
</li>
<li>
<section class="detail" id="color">
<h3>color</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="Color.html" title="enum class in Unnamed Package">Color</a></span>&nbsp;<span class="element-name">color</span></div>
<div class="block">The color of the Player</div>
</div>
</section>
</li>
@@ -194,10 +233,43 @@ loadScripts(document, 'script');</script>
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="Player(java.lang.String,Color)">
<h3>Player</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">Player</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="Color.html" title="enum class in Unnamed Package">Color</a>&nbsp;color)</span></div>
<div class="block">The constructor of the Player.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name of the player.</dd>
<dd><code>color</code> - The color of the player.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="getName()">
<h3>getName</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getName</span>()</div>
<div class="block">Return the name of the player.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The name of the player.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="getColor()">
<h3>getColor</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Color.html" title="enum class in Unnamed Package">Color</a></span>&nbsp;<span class="element-name">getColor</span>()</div>
<div class="block">Return the color of the player.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The color of the player.</dd>
</dl>
</div>
</section>
</li>
@@ -205,7 +277,14 @@ loadScripts(document, 'script');</script>
<section class="detail" id="chooseMove(GomokuBoard)">
<h3>chooseMove</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="Coordinate.html" title="class in Unnamed Package">Coordinate</a></span>&nbsp;<span class="element-name">chooseMove</span><wbr><span class="parameters">(<a href="GomokuBoard.html" title="class in Unnamed Package">GomokuBoard</a>&nbsp;Board)</span></div>
<div class="member-signature"><span class="modifiers">public abstract</span>&nbsp;<span class="return-type"><a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a></span>&nbsp;<span class="element-name">chooseMove</span><wbr><span class="parameters">(<a href="GomokuBoard.html" title="class in Unnamed Package">GomokuBoard</a>&nbsp;board)</span></div>
<div class="block">Return the coordinate of the move played by the player.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>board</code> - The actual Gomoku board.</dd>
<dt>Returns:</dt>
<dd>The cell of the move played.</dd>
</dl>
</div>
</section>
</li>