Browse Source

Add Descriptions in Javadoc

AIPlayer
FelixKrull 2 years ago
parent
commit
cd10df7555
  1. 4
      javadoc/Figure.html
  2. 29
      javadoc/Game.html
  3. 4
      javadoc/GameTest.html
  4. 4
      javadoc/Gameboard.html
  5. 4
      javadoc/GameboardTest.html
  6. 16
      javadoc/Player.html
  7. 4
      javadoc/PlayerTest.html
  8. 4
      javadoc/allclasses-index.html
  9. 4
      javadoc/allpackages-index.html
  10. 4
      javadoc/help-doc.html
  11. 20
      javadoc/index-files/index-1.html
  12. 8
      javadoc/index-files/index-2.html
  13. 8
      javadoc/index-files/index-3.html
  14. 4
      javadoc/index-files/index-4.html
  15. 4
      javadoc/index-files/index-5.html
  16. 4
      javadoc/index-files/index-6.html
  17. 4
      javadoc/index-files/index-7.html
  18. 8
      javadoc/index-files/index-8.html
  19. 4
      javadoc/index-files/index-9.html
  20. 4
      javadoc/index.html
  21. 4
      javadoc/overview-tree.html
  22. 4
      javadoc/package-summary.html
  23. 4
      javadoc/package-tree.html
  24. 5
      src/main/java/Game.java
  25. 4
      src/main/java/Player.java

4
javadoc/Figure.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>Figure</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="declaration: class: Figure">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

29
javadoc/Game.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>Game</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="declaration: class: Game">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@ -107,23 +107,31 @@ loadScripts(document, 'script');</script>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkDice(int,Player,int)" class="member-name-link">checkDice</a><wbr>(int&nbsp;dice,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
int&nbsp;countRolls)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Check if the Player is allowed to roll the dice again</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkFieldClear(int,Player,Game)" class="member-name-link">checkFieldClear</a><wbr>(int&nbsp;posToCheck,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
<a href="Game.html" title="class in Unnamed Package">Game</a>&nbsp;g)</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-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Check if a target field is free or occupied by another figure</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#figureIsUsable(int,int,Player,Game)" class="member-name-link">figureIsUsable</a><wbr>(int&nbsp;dice,
int&nbsp;figId,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
<a href="Game.html" title="class in Unnamed Package">Game</a>&nbsp;g)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Check if a figure is usable</div>
</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/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUsableFigures(int,Player,Game)" class="member-name-link">getUsableFigures</a><wbr>(int&nbsp;dice,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
<a href="Game.html" title="class in Unnamed Package">Game</a>&nbsp;g)</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-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get List of all usable Figures in the current Play for one Player</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#main(java.lang.String%5B%5D)" class="member-name-link">main</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[]&nbsp;args)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
@ -132,7 +140,9 @@ loadScripts(document, 'script');</script>
int&nbsp;dice,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
<a href="Game.html" title="class in Unnamed Package">Game</a>&nbsp;g)</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-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set a figure on a field according</div>
</div>
</div>
</div>
</div>
@ -181,6 +191,7 @@ loadScripts(document, 'script');</script>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">checkDice</span><wbr><span class="parameters">(int&nbsp;dice,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
int&nbsp;countRolls)</span></div>
<div class="block">Check if the Player is allowed to roll the dice again</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dice</code> - Value of dice got from rolldice()</dd>
@ -197,6 +208,7 @@ loadScripts(document, 'script');</script>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">checkFieldClear</span><wbr><span class="parameters">(int&nbsp;posToCheck,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
<a href="Game.html" title="class in Unnamed Package">Game</a>&nbsp;g)</span></div>
<div class="block">Check if a target field is free or occupied by another figure</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>posToCheck</code> - Target position to check</dd>
@ -213,6 +225,7 @@ loadScripts(document, 'script');</script>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</span>&nbsp;<span class="element-name">getUsableFigures</span><wbr><span class="parameters">(int&nbsp;dice,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
<a href="Game.html" title="class in Unnamed Package">Game</a>&nbsp;g)</span></div>
<div class="block">Get List of all usable Figures in the current Play for one Player</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dice</code> - Value of dice got from rolldice()</dd>
@ -230,6 +243,7 @@ loadScripts(document, 'script');</script>
int&nbsp;figId,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
<a href="Game.html" title="class in Unnamed Package">Game</a>&nbsp;g)</span></div>
<div class="block">Check if a figure is usable</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>dice</code> - Value of dice got from rolldice()</dd>
@ -248,6 +262,7 @@ loadScripts(document, 'script');</script>
int&nbsp;dice,
<a href="Player.html" title="class in Unnamed Package">Player</a>&nbsp;p,
<a href="Game.html" title="class in Unnamed Package">Game</a>&nbsp;g)</span></div>
<div class="block">Set a figure on a field according</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>figId</code> - id of figure to check</dd>

4
javadoc/GameTest.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>GameTest</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="declaration: class: GameTest">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

4
javadoc/Gameboard.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>Gameboard</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="declaration: class: Gameboard">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

4
javadoc/GameboardTest.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>GameboardTest</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="declaration: class: GameboardTest">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

16
javadoc/Player.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="declaration: class: Player">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@ -108,13 +108,17 @@ loadScripts(document, 'script');</script>
<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-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkFigureInBase(java.util.ArrayList)" class="member-name-link">checkFigureInBase</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="Figure.html" title="class in Unnamed Package">Figure</a>&gt;&nbsp;figures)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks if the Player has figures in the base (off gameboard)</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkGameWin(java.util.ArrayList)" class="member-name-link">checkGameWin</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="Figure.html" title="class in Unnamed Package">Figure</a>&gt;&nbsp;figures)</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-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#choose(java.util.ArrayList)" class="member-name-link">choose</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;&nbsp;usableFigures)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the user input on witch figure the user wants to move</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rollDice()" class="member-name-link">rollDice</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
@ -178,11 +182,12 @@ loadScripts(document, 'script');</script>
<section class="detail" id="checkFigureInBase(java.util.ArrayList)">
<h3>checkFigureInBase</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">checkFigureInBase</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="Figure.html" title="class in Unnamed Package">Figure</a>&gt;&nbsp;figures)</span></div>
<div class="block">Checks if the Player has figures in the base (off gameboard)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>figures</code> - figures of the current Player</dd>
<dt>Returns:</dt>
<dd>true if there is at least one figure in the base (of gameboard)</dd>
<dd>true if there is at least one figure in the base (off gameboard)</dd>
</dl>
</section>
</li>
@ -190,6 +195,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="choose(java.util.ArrayList)">
<h3>choose</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">choose</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;&nbsp;usableFigures)</span></div>
<div class="block">Get the user input on witch figure the user wants to move</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>usableFigures</code> - list of usable Figures to choose from</dd>

4
javadoc/PlayerTest.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>PlayerTest</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="declaration: class: PlayerTest">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

4
javadoc/allclasses-index.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>All Classes and Interfaces</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

4
javadoc/allpackages-index.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>All Packages</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

4
javadoc/help-doc.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>API Help</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="help">
<meta name="generator" content="javadoc/HelpWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

20
javadoc/index-files/index-1.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>C-Index</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index: C">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@ -53,15 +53,23 @@ loadScripts(document, 'script');</script>
<h2 class="title" id="I:C">C</h2>
<dl class="index">
<dt><a href="../Game.html#checkDice(int,Player,int)" class="member-name-link">checkDice(int, Player, int)</a> - Method in class <a href="../Game.html" title="class in Unnamed Package">Game</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Check if the Player is allowed to roll the dice again</div>
</dd>
<dt><a href="../Game.html#checkFieldClear(int,Player,Game)" class="member-name-link">checkFieldClear(int, Player, Game)</a> - Method in class <a href="../Game.html" title="class in Unnamed Package">Game</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Check if a target field is free or occupied by another figure</div>
</dd>
<dt><a href="../Player.html#checkFigureInBase(java.util.ArrayList)" class="member-name-link">checkFigureInBase(ArrayList&lt;Figure&gt;)</a> - Method in class <a href="../Player.html" title="class in Unnamed Package">Player</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Checks if the Player has figures in the base (off gameboard)</div>
</dd>
<dt><a href="../Player.html#checkGameWin(java.util.ArrayList)" class="member-name-link">checkGameWin(ArrayList&lt;Figure&gt;)</a> - Method in class <a href="../Player.html" title="class in Unnamed Package">Player</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../Player.html#choose(java.util.ArrayList)" class="member-name-link">choose(ArrayList&lt;Integer&gt;)</a> - Method in class <a href="../Player.html" title="class in Unnamed Package">Player</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Get the user input on witch figure the user wants to move</div>
</dd>
</dl>
<a href="index-1.html">C</a>&nbsp;<a href="index-2.html">F</a>&nbsp;<a href="index-3.html">G</a>&nbsp;<a href="index-4.html">I</a>&nbsp;<a href="index-5.html">M</a>&nbsp;<a href="index-6.html">P</a>&nbsp;<a href="index-7.html">R</a>&nbsp;<a href="index-8.html">S</a>&nbsp;<a href="index-9.html">T</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a></main>
</div>

8
javadoc/index-files/index-2.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>F-Index</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index: F">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@ -57,7 +57,9 @@ loadScripts(document, 'script');</script>
<dt><a href="../Figure.html#%3Cinit%3E()" class="member-name-link">Figure()</a> - Constructor for class <a href="../Figure.html" title="class in Unnamed Package">Figure</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../Game.html#figureIsUsable(int,int,Player,Game)" class="member-name-link">figureIsUsable(int, int, Player, Game)</a> - Method in class <a href="../Game.html" title="class in Unnamed Package">Game</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Check if a figure is usable</div>
</dd>
</dl>
<a href="index-1.html">C</a>&nbsp;<a href="index-2.html">F</a>&nbsp;<a href="index-3.html">G</a>&nbsp;<a href="index-4.html">I</a>&nbsp;<a href="index-5.html">M</a>&nbsp;<a href="index-6.html">P</a>&nbsp;<a href="index-7.html">R</a>&nbsp;<a href="index-8.html">S</a>&nbsp;<a href="index-9.html">T</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a></main>
</div>

8
javadoc/index-files/index-3.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>G-Index</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index: G">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@ -71,7 +71,9 @@ loadScripts(document, 'script');</script>
<dt><a href="../Figure.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class <a href="../Figure.html" title="class in Unnamed Package">Figure</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../Game.html#getUsableFigures(int,Player,Game)" class="member-name-link">getUsableFigures(int, Player, Game)</a> - Method in class <a href="../Game.html" title="class in Unnamed Package">Game</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Get List of all usable Figures in the current Play for one Player</div>
</dd>
</dl>
<a href="index-1.html">C</a>&nbsp;<a href="index-2.html">F</a>&nbsp;<a href="index-3.html">G</a>&nbsp;<a href="index-4.html">I</a>&nbsp;<a href="index-5.html">M</a>&nbsp;<a href="index-6.html">P</a>&nbsp;<a href="index-7.html">R</a>&nbsp;<a href="index-8.html">S</a>&nbsp;<a href="index-9.html">T</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a></main>
</div>

4
javadoc/index-files/index-4.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>I-Index</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index: I">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

4
javadoc/index-files/index-5.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>M-Index</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index: M">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

4
javadoc/index-files/index-6.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>P-Index</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index: P">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

4
javadoc/index-files/index-7.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>R-Index</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index: R">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

8
javadoc/index-files/index-8.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>S-Index</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index: S">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@ -53,7 +53,9 @@ loadScripts(document, 'script');</script>
<h2 class="title" id="I:S">S</h2>
<dl class="index">
<dt><a href="../Game.html#setFigure(int,int,Player,Game)" class="member-name-link">setFigure(int, int, Player, Game)</a> - Method in class <a href="../Game.html" title="class in Unnamed Package">Game</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Set a figure on a field according</div>
</dd>
<dt><a href="../Figure.html#setPosition(int)" class="member-name-link">setPosition(int)</a> - Method in class <a href="../Figure.html" title="class in Unnamed Package">Figure</a></dt>
<dd>&nbsp;</dd>
</dl>

4
javadoc/index-files/index-9.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>T-Index</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index: T">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

4
javadoc/index.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>Generated Documentation (Untitled)</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="index redirect">
<meta name="generator" content="javadoc/IndexRedirectWriter">
<link rel="canonical" href="Gameboard.html">

4
javadoc/overview-tree.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>Class Hierarchy</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="class tree">
<meta name="generator" content="javadoc/TreeWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

4
javadoc/package-summary.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title>Unnamed Package</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="declaration: package: &lt;unnamed&gt;">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

4
javadoc/package-tree.html

@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Mon Feb 14 22:10:54 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<title> Class Hierarchy</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="2022-02-14">
<meta name="dc.created" content="2022-02-15">
<meta name="description" content="tree: package: &lt;unnamed&gt;">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

5
src/main/java/Game.java

@ -50,6 +50,7 @@ public class Game {
}
/**
* Check if the Player is allowed to roll the dice again
* @param dice Value of dice got from rolldice()
* @param p active Player
* @param countRolls Counter how often the Player already rolled the dice
@ -63,6 +64,7 @@ public class Game {
}
/**
* Check if a target field is free or occupied by another figure
* @param posToCheck Target position to check
* @param p active Player
* @param g game instance
@ -86,6 +88,7 @@ public class Game {
}
/**
* Get List of all usable Figures in the current Play for one Player
* @param dice Value of dice got from rolldice()
* @param p active Player
* @param g game instance
@ -102,6 +105,7 @@ public class Game {
}
/**
* Check if a figure is usable
* @param dice Value of dice got from rolldice()
* @param figId id of figure to check
* @param p active Player
@ -129,6 +133,7 @@ public class Game {
}
/**
* Set a figure on a field according
* @param figId id of figure to check
* @param dice Value of dice got from rolldice()
* @param p active Player

4
src/main/java/Player.java

@ -44,8 +44,9 @@ public class Player {
}
/**
* Checks if the Player has figures in the base (off gameboard)
* @param figures figures of the current Player
* @return true if there is at least one figure in the base (of gameboard)
* @return true if there is at least one figure in the base (off gameboard)
*/
public int checkFigureInBase(ArrayList<Figure> figures) {
Iterator<Figure> it = figures.iterator();
@ -61,6 +62,7 @@ public class Player {
}
/**
* Get the user input on witch figure the user wants to move
* @param usableFigures list of usable Figures to choose from
* @return int figid of the figure chosen
*/

Loading…
Cancel
Save