<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="no"> <head> <!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:39 CEST 2020 --> <title>InteractableGame</title> <meta name="date" content="2020-05-03"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="InteractableGame"; } } catch(err) { } //--> var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-files/index-1.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../inf112/fiasko/roborally/objects/Grid.html" title="interface in inf112.fiasko.roborally.objects"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../inf112/fiasko/roborally/objects/ListGrid.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?inf112/fiasko/roborally/objects/InteractableGame.html" target="_top">Frames</a></li> <li><a href="InteractableGame.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">inf112.fiasko.roborally.objects</div> <h2 title="Interface InteractableGame" class="title">Interface InteractableGame</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Known Implementing Classes:</dt> <dd><a href="../../../../inf112/fiasko/roborally/objects/RoboRallyGame.html" title="class in inf112.fiasko.roborally.objects">RoboRallyGame</a></dd> </dl> <hr> <br> <pre>public interface <span class="typeNameLabel">InteractableGame</span></pre> <div class="block">This interface describes a game which can be interacted with</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#getExtraCards--">getExtraCards</a></span>()</code> <div class="block">Gets extra cards necessary when the player has no program to lock</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../../inf112/fiasko/roborally/objects/properties/GameState.html" title="enum in inf112.fiasko.roborally.objects.properties">GameState</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#getGameState--">getGameState</a></span>()</code> <div class="block">Gets the current state of the game</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#getPlayerHand--">getPlayerHand</a></span>()</code> <div class="block">Gets the hand of this player</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.util.List<<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCard</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#getProgram--">getProgram</a></span>()</code> <div class="block">Gets the program of this player</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#getProgramSize--">getProgramSize</a></span>()</code> <div class="block">Gets the amount of cards the player can choose for their program</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#getWinningPlayerName--">getWinningPlayerName</a></span>()</code> <div class="block">Gets the name of the player who won</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#receiveAllPrograms-inf112.fiasko.roborally.networking.containers.ProgramsContainerResponse-">receiveAllPrograms</a></span>(<a href="../../../../inf112/fiasko/roborally/networking/containers/ProgramsContainerResponse.html" title="class in inf112.fiasko.roborally.networking.containers">ProgramsContainerResponse</a> programs)</code> <div class="block">Continues turn when programs for all players are received from the server</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#receiveStayInPowerDown-inf112.fiasko.roborally.networking.containers.PowerDownContainerResponse-">receiveStayInPowerDown</a></span>(<a href="../../../../inf112/fiasko/roborally/networking/containers/PowerDownContainerResponse.html" title="class in inf112.fiasko.roborally.networking.containers">PowerDownContainerResponse</a> powerDowns)</code> <div class="block">Continues turn when stay in power down is received from all players</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#setExtraCards-inf112.fiasko.roborally.objects.ProgrammingCardDeck-">setExtraCards</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a> extraCards)</code> <div class="block">Sets extra cards necessary when the player has no program to lock</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#setGameState-inf112.fiasko.roborally.objects.properties.GameState-">setGameState</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/GameState.html" title="enum in inf112.fiasko.roborally.objects.properties">GameState</a> gameState)</code> <div class="block">Sets the state of the game</div> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#setPlayerHand-inf112.fiasko.roborally.objects.ProgrammingCardDeck-">setPlayerHand</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a> playerHand)</code> <div class="block">Sets the hand of this player</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#setProgram-java.util.List-">setProgram</a></span>(java.util.List<<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCard</a>> program)</code> <div class="block">Sets the program of this player</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html#setWinningPlayerName-java.lang.String-">setWinningPlayerName</a></span>(java.lang.String winningPlayerName)</code> <div class="block">Sets the name of the player that won the game</div> </td> </tr> </table> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getGameState--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getGameState</h4> <pre><a href="../../../../inf112/fiasko/roborally/objects/properties/GameState.html" title="enum in inf112.fiasko.roborally.objects.properties">GameState</a> getGameState()</pre> <div class="block">Gets the current state of the game</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The state the game is currently in</dd> </dl> </li> </ul> <a name="setGameState-inf112.fiasko.roborally.objects.properties.GameState-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setGameState</h4> <pre>void setGameState(<a href="../../../../inf112/fiasko/roborally/objects/properties/GameState.html" title="enum in inf112.fiasko.roborally.objects.properties">GameState</a> gameState)</pre> <div class="block">Sets the state of the game</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>gameState</code> - The new state of the game</dd> </dl> </li> </ul> <a name="getWinningPlayerName--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getWinningPlayerName</h4> <pre>java.lang.String getWinningPlayerName()</pre> <div class="block">Gets the name of the player who won</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>A string of the player name</dd> </dl> </li> </ul> <a name="setWinningPlayerName-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setWinningPlayerName</h4> <pre>void setWinningPlayerName(java.lang.String winningPlayerName)</pre> <div class="block">Sets the name of the player that won the game</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>winningPlayerName</code> - The player winning the game</dd> </dl> </li> </ul> <a name="receiveAllPrograms-inf112.fiasko.roborally.networking.containers.ProgramsContainerResponse-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>receiveAllPrograms</h4> <pre>void receiveAllPrograms(<a href="../../../../inf112/fiasko/roborally/networking/containers/ProgramsContainerResponse.html" title="class in inf112.fiasko.roborally.networking.containers">ProgramsContainerResponse</a> programs) throws java.lang.InterruptedException</pre> <div class="block">Continues turn when programs for all players are received from the server</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>programs</code> - The programs container received from the server</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.InterruptedException</code> - If interrupted during sleep</dd> </dl> </li> </ul> <a name="receiveStayInPowerDown-inf112.fiasko.roborally.networking.containers.PowerDownContainerResponse-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>receiveStayInPowerDown</h4> <pre>void receiveStayInPowerDown(<a href="../../../../inf112/fiasko/roborally/networking/containers/PowerDownContainerResponse.html" title="class in inf112.fiasko.roborally.networking.containers">PowerDownContainerResponse</a> powerDowns)</pre> <div class="block">Continues turn when stay in power down is received from all players</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>powerDowns</code> - The power down container received from the server</dd> </dl> </li> </ul> <a name="getPlayerHand--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPlayerHand</h4> <pre><a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a> getPlayerHand()</pre> <div class="block">Gets the hand of this player</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The hand of this player</dd> </dl> </li> </ul> <a name="setPlayerHand-inf112.fiasko.roborally.objects.ProgrammingCardDeck-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setPlayerHand</h4> <pre>void setPlayerHand(<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a> playerHand)</pre> <div class="block">Sets the hand of this player</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>playerHand</code> - The new hand of this player</dd> </dl> </li> </ul> <a name="getExtraCards--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getExtraCards</h4> <pre><a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a> getExtraCards()</pre> <div class="block">Gets extra cards necessary when the player has no program to lock</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>A deck of extra cards</dd> </dl> </li> </ul> <a name="setExtraCards-inf112.fiasko.roborally.objects.ProgrammingCardDeck-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setExtraCards</h4> <pre>void setExtraCards(<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a> extraCards)</pre> <div class="block">Sets extra cards necessary when the player has no program to lock</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>extraCards</code> - The extra cards to use</dd> </dl> </li> </ul> <a name="getProgramSize--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getProgramSize</h4> <pre>int getProgramSize()</pre> <div class="block">Gets the amount of cards the player can choose for their program</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The size of the player's next program</dd> </dl> </li> </ul> <a name="getProgram--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getProgram</h4> <pre>java.util.List<<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCard</a>> getProgram()</pre> <div class="block">Gets the program of this player</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The program of this player</dd> </dl> </li> </ul> <a name="setProgram-java.util.List-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>setProgram</h4> <pre>void setProgram(java.util.List<<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCard</a>> program)</pre> <div class="block">Sets the program of this player</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>program</code> - The program of this player</dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-files/index-1.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../inf112/fiasko/roborally/objects/Grid.html" title="interface in inf112.fiasko.roborally.objects"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../inf112/fiasko/roborally/objects/ListGrid.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?inf112/fiasko/roborally/objects/InteractableGame.html" target="_top">Frames</a></li> <li><a href="InteractableGame.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>