|
|
<!DOCTYPE HTML> <html lang="de"> <head> <!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 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-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"> <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 evenRowColor = "even-row-color"; var oddRowColor = "odd-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="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="index-files/index-1.html">Index</a></li> <li><a href="help-doc.html#class">Help</a></li> </ul> </div> <div class="sub-nav"> <div> <ul class="sub-nav-list"> <li>Summary: </li> <li>Nested | </li> <li>Field | </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>Field | </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-input">SEARCH:</label> <input type="text" id="search-input" value="search" disabled="disabled"> <input type="reset" id="reset-button" 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"> <h1 title="Class Game" class="title">Class Game</h1> </div> <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance">Game</div> </div> <section class="class-description" id="class-description"> <hr> <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Game</span> <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> </section> <section class="summary"> <ul class="summary-list"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <li> <section class="constructor-summary" id="constructor-summary"> <h2>Constructor Summary</h2> <div class="caption"><span>Constructors</span></div> <div class="summary-table two-column-summary"> <div class="table-header col-first">Constructor</div> <div class="table-header col-last">Description</div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Game</a>()</code></div> <div class="col-last even-row-color"> </div> </div> </section> </li> <!-- ========== METHOD SUMMARY =========== --> <li> <section class="method-summary" id="method-summary"> <h2>Method Summary</h2> <div id="method-summary-table"> <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> <div id="method-summary-table.tabpanel" role="tabpanel"> <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> <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-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="#checkDice(int,Player,int)" class="member-name-link">checkDice</a><wbr>(int dice, <a href="Player.html" title="class in Unnamed Package">Player</a> p, int countRolls)</code></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 posToCheck, <a href="Player.html" title="class in Unnamed Package">Player</a> p, <a href="Game.html" title="class in Unnamed Package">Game</a> g)</code></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 dice, int figId, <a href="Player.html" title="class in Unnamed Package">Player</a> p, <a href="Game.html" title="class in Unnamed Package">Game</a> g)</code></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><<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>></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 dice, <a href="Player.html" title="class in Unnamed Package">Player</a> p, <a href="Game.html" title="class in Unnamed Package">Game</a> g)</code></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>[] args)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </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="#setFigure(int,int,Player,Game)" class="member-name-link">setFigure</a><wbr>(int figId, int dice, <a href="Player.html" title="class in Unnamed Package">Player</a> p, <a href="Game.html" title="class in Unnamed Package">Game</a> g)</code></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> <div class="inherited-list"> <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ========= 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>Game</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">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="main(java.lang.String[])"> <h3>main</h3> <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">main</span><wbr><span class="parameters">(<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>[] args)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> <dl class="notes"> <dt>Throws:</dt> <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> </dl> </section> </li> <li> <section class="detail" id="checkDice(int,Player,int)"> <h3>checkDice</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">checkDice</span><wbr><span class="parameters">(int dice, <a href="Player.html" title="class in Unnamed Package">Player</a> p, int 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> <dd><code>p</code> - active Player</dd> <dd><code>countRolls</code> - Counter how often the Player already rolled the dice</dd> <dt>Returns:</dt> <dd>true if Player can roll the dice another time</dd> </dl> </section> </li> <li> <section class="detail" id="checkFieldClear(int,Player,Game)"> <h3>checkFieldClear</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">checkFieldClear</span><wbr><span class="parameters">(int posToCheck, <a href="Player.html" title="class in Unnamed Package">Player</a> p, <a href="Game.html" title="class in Unnamed Package">Game</a> 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> <dd><code>p</code> - active Player</dd> <dd><code>g</code> - game instance</dd> <dt>Returns:</dt> <dd>2 - own Player 1 - another Player 0 - Field clear</dd> </dl> </section> </li> <li> <section class="detail" id="getUsableFigures(int,Player,Game)"> <h3>getUsableFigures</h3> <div class="member-signature"><span class="modifiers">public</span> <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><<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>></span> <span class="element-name">getUsableFigures</span><wbr><span class="parameters">(int dice, <a href="Player.html" title="class in Unnamed Package">Player</a> p, <a href="Game.html" title="class in Unnamed Package">Game</a> 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> <dd><code>p</code> - active Player</dd> <dd><code>g</code> - game instance</dd> <dt>Returns:</dt> <dd>List of int with figIds the Player can choose from</dd> </dl> </section> </li> <li> <section class="detail" id="figureIsUsable(int,int,Player,Game)"> <h3>figureIsUsable</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">figureIsUsable</span><wbr><span class="parameters">(int dice, int figId, <a href="Player.html" title="class in Unnamed Package">Player</a> p, <a href="Game.html" title="class in Unnamed Package">Game</a> 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> <dd><code>figId</code> - id of figure to check</dd> <dd><code>p</code> - active Player</dd> <dd><code>g</code> - game instance</dd> <dt>Returns:</dt> <dd>true if figure is usable</dd> </dl> </section> </li> <li> <section class="detail" id="setFigure(int,int,Player,Game)"> <h3>setFigure</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">setFigure</span><wbr><span class="parameters">(int figId, int dice, <a href="Player.html" title="class in Unnamed Package">Player</a> p, <a href="Game.html" title="class in Unnamed Package">Game</a> 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> <dd><code>dice</code> - Value of dice got from rolldice()</dd> <dd><code>p</code> - active Player</dd> <dd><code>g</code> - game instance</dd> <dt>Returns:</dt> <dd>0 if no figure kicked. 1 if another figure was kicked</dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>
|