mirror of
https://github.com/inf112-v20/Fiasko.git
synced 2025-11-04 03:33:45 +01:00
398 lines
15 KiB
HTML
398 lines
15 KiB
HTML
<!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 Thu May 07 19:14:44 CEST 2020 -->
|
|
<title>Deck</title>
|
|
<meta name="date" content="2020-05-07">
|
|
<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="Deck";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/BoardElementContainer.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../inf112/fiasko/roborally/objects/DrawableGame.html" title="interface 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/Deck.html" target="_top">Frames</a></li>
|
|
<li><a href="Deck.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 Deck" class="title">Interface Deck<T></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/AbstractDeck.html" title="class in inf112.fiasko.roborally.objects">AbstractDeck</a>, <a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">Deck<T></span></pre>
|
|
<div class="block">Describes a deck
|
|
|
|
<p>Any card stored in the deck is assumed to be immutable. If it's not, the integrity of the deck cannot be
|
|
guaranteed.</p></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>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Deck.html#draw-inf112.fiasko.roborally.objects.Deck-">draw</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="interface in inf112.fiasko.roborally.objects">Deck</a><<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a>> other)</code>
|
|
<div class="block">Draws one card from the top of another deck</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Deck.html#draw-inf112.fiasko.roborally.objects.Deck-int-">draw</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="interface in inf112.fiasko.roborally.objects">Deck</a><<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a>> other,
|
|
int n)</code>
|
|
<div class="block">Draws n cards from the top of another deck</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Deck.html#emptyInto-inf112.fiasko.roborally.objects.Deck-">emptyInto</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="interface in inf112.fiasko.roborally.objects">Deck</a><<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a>> other)</code>
|
|
<div class="block">Moves all cards in this deck into another deck</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>java.util.List<<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Deck.html#getCards--">getCards</a></span>()</code>
|
|
<div class="block">Gets a list of all cards in this deck
|
|
|
|
The list should have the correct order according to the actual order within the deck.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Deck.html#isEmpty--">isEmpty</a></span>()</code>
|
|
<div class="block">Whether this deck is empty</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Deck.html#peekBottom--">peekBottom</a></span>()</code>
|
|
<div class="block">Takes a peek at the card currently at the bottom of the deck</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Deck.html#peekTop--">peekTop</a></span>()</code>
|
|
<div class="block">Takes a peek at the card currently at the top of the deck</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/Deck.html#shuffle--">shuffle</a></span>()</code>
|
|
<div class="block">Shuffles the order of the cards in the deck</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Deck.html#size--">size</a></span>()</code>
|
|
<div class="block">Gets the number of cards currently in this deck</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="shuffle--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>shuffle</h4>
|
|
<pre>void shuffle()</pre>
|
|
<div class="block">Shuffles the order of the cards in the deck</div>
|
|
</li>
|
|
</ul>
|
|
<a name="draw-inf112.fiasko.roborally.objects.Deck-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>draw</h4>
|
|
<pre>void draw(<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="interface in inf112.fiasko.roborally.objects">Deck</a><<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a>> other)</pre>
|
|
<div class="block">Draws one card from the top of another deck</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>other</code> - The deck to draw the card from</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="draw-inf112.fiasko.roborally.objects.Deck-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>draw</h4>
|
|
<pre>void draw(<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="interface in inf112.fiasko.roborally.objects">Deck</a><<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a>> other,
|
|
int n)</pre>
|
|
<div class="block">Draws n cards from the top of another deck</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>other</code> - The other deck to draw from</dd>
|
|
<dd><code>n</code> - The number of cards to draw</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="emptyInto-inf112.fiasko.roborally.objects.Deck-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>emptyInto</h4>
|
|
<pre>void emptyInto(<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="interface in inf112.fiasko.roborally.objects">Deck</a><<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a>> other)</pre>
|
|
<div class="block">Moves all cards in this deck into another deck</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>other</code> - The deck to move this deck's cards into</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isEmpty--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isEmpty</h4>
|
|
<pre>boolean isEmpty()</pre>
|
|
<div class="block">Whether this deck is empty</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if this deck is currently empty</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="size--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>size</h4>
|
|
<pre>int size()</pre>
|
|
<div class="block">Gets the number of cards currently in this deck</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of cards in this deck</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="peekTop--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>peekTop</h4>
|
|
<pre><a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a> peekTop()</pre>
|
|
<div class="block">Takes a peek at the card currently at the top of the deck</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The card at the top of the deck</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="peekBottom--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>peekBottom</h4>
|
|
<pre><a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a> peekBottom()</pre>
|
|
<div class="block">Takes a peek at the card currently at the bottom of the deck</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The card at the bottom of the deck</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCards--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getCards</h4>
|
|
<pre>java.util.List<<a href="../../../../inf112/fiasko/roborally/objects/Deck.html" title="type parameter in Deck">T</a>> getCards()</pre>
|
|
<div class="block">Gets a list of all cards in this deck
|
|
|
|
<p>The list should have the correct order according to the actual order within the deck.</p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A list of all cards in this deck</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/BoardElementContainer.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../inf112/fiasko/roborally/objects/DrawableGame.html" title="interface 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/Deck.html" target="_top">Frames</a></li>
|
|
<li><a href="Deck.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>
|