EpicKnarvik97/Fiasko
EpicKnarvik97/Fiasko
1
0
Fork 0
mirror of https://github.com/inf112-v20/Fiasko.git synced 2025-02-01 07:39:35 +01:00
Code Issues Projects Releases Wiki Activity
Fiasko/docs/javadoc/inf112/fiasko/roborally/objects/Player.html

463 lines
18 KiB
HTML
Raw Normal View History

Legger til javadoc
2020-05-03 18:14:17 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="no">
<head>
oppdaterer javadoc
2020-05-05 15:46:33 +02:00
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
Legger til javadoc
2020-05-03 18:14:17 +02:00
<title>Player</title>
oppdaterer javadoc
2020-05-05 15:46:33 +02:00
<meta name="date" content="2020-05-05">
Legger til javadoc
2020-05-03 18:14:17 +02:00
<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="Player";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/Phase.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?inf112/fiasko/roborally/objects/Player.html" target="_top">Frames</a></li>
<li><a href="Player.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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="Class Player" class="title">Class Player</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>inf112.fiasko.roborally.objects.Player</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Player</span>
extends java.lang.Object</pre>
<div class="block">This class represents a player</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Player.html#Player--">Player</a></span>()</code>
<div class="block">Empty constructor required by kryo</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Player.html#Player-inf112.fiasko.roborally.objects.properties.RobotID-java.lang.String-">Player</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;robotID,
java.lang.String&nbsp;name)</code>
<div class="block">Instantiates a new player</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/Player.html#getLockedProgrammingCardDeck--">getLockedProgrammingCardDeck</a></span>()</code>
<div class="block">Gets the player deck with locked cards</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Player.html#getName--">getName</a></span>()</code>
<div class="block">Gets the name of the player</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Player.html#getPowerDownNextRound--">getPowerDownNextRound</a></span>()</code>
<div class="block">Gets the players power down status</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCard</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Player.html#getProgram--">getProgram</a></span>()</code>
<div class="block">Gets the players program</div>
</td>
</tr>
<tr id="i4" 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/Player.html#getProgrammingCardDeck--">getProgrammingCardDeck</a></span>()</code>
<div class="block">Gets the player hand/deck</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Player.html#getRobotID--">getRobotID</a></span>()</code>
<div class="block">Gets the RobotID of a player</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/Player.html#setPowerDownNextRound-boolean-">setPowerDownNextRound</a></span>(boolean&nbsp;powerDownStatus)</code>
<div class="block">Sets the power down status</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/Player.html#setProgram-java.util.List-">setProgram</a></span>(java.util.List&lt;<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCard</a>&gt;&nbsp;cardList)</code>
<div class="block">Sets the Players program to the given list of programing cards</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/Player.html#setProgrammingCardDeck-inf112.fiasko.roborally.objects.ProgrammingCardDeck-">setProgrammingCardDeck</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a>&nbsp;playerDeck)</code>
<div class="block">Sets the players deck to the given deck</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Player-inf112.fiasko.roborally.objects.properties.RobotID-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Player</h4>
<pre>public&nbsp;Player(<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;robotID,
java.lang.String&nbsp;name)</pre>
<div class="block">Instantiates a new player</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>robotID</code> - the global identifier of the robot</dd>
<dd><code>name</code> - the unique name of the player</dd>
</dl>
</li>
</ul>
<a name="Player--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Player</h4>
<pre>public&nbsp;Player()</pre>
<div class="block">Empty constructor required by kryo</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRobotID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRobotID</h4>
<pre>public&nbsp;<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;getRobotID()</pre>
<div class="block">Gets the RobotID of a player</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A RobotID</dd>
</dl>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
<div class="block">Gets the name of the player</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A player Name</dd>
</dl>
</li>
</ul>
<a name="getProgram--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProgram</h4>
<pre>public&nbsp;java.util.List&lt;<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCard</a>&gt;&nbsp;getProgram()</pre>
<div class="block">Gets the players program</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A list of programming cards</dd>
</dl>
</li>
</ul>
<a name="setProgram-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProgram</h4>
<pre>public&nbsp;void&nbsp;setProgram(java.util.List&lt;<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCard</a>&gt;&nbsp;cardList)</pre>
<div class="block">Sets the Players program to the given list of programing cards</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cardList</code> - list the size of 5 with programing cards</dd>
</dl>
</li>
</ul>
<a name="getProgrammingCardDeck--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProgrammingCardDeck</h4>
<pre>public&nbsp;<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a>&nbsp;getProgrammingCardDeck()</pre>
<div class="block">Gets the player hand/deck</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A deck</dd>
</dl>
</li>
</ul>
<a name="setProgrammingCardDeck-inf112.fiasko.roborally.objects.ProgrammingCardDeck-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProgrammingCardDeck</h4>
<pre>public&nbsp;void&nbsp;setProgrammingCardDeck(<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a>&nbsp;playerDeck)</pre>
<div class="block">Sets the players deck to the given deck</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>playerDeck</code> - A deck of cards given to the player</dd>
</dl>
</li>
</ul>
<a name="getLockedProgrammingCardDeck--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLockedProgrammingCardDeck</h4>
<pre>public&nbsp;<a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCardDeck.html" title="class in inf112.fiasko.roborally.objects">ProgrammingCardDeck</a>&nbsp;getLockedProgrammingCardDeck()</pre>
<div class="block">Gets the player deck with locked cards</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a deck with locked cards</dd>
</dl>
</li>
</ul>
<a name="getPowerDownNextRound--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPowerDownNextRound</h4>
<pre>public&nbsp;boolean&nbsp;getPowerDownNextRound()</pre>
<div class="block">Gets the players power down status</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the player is to power down</dd>
</dl>
</li>
</ul>
<a name="setPowerDownNextRound-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setPowerDownNextRound</h4>
<pre>public&nbsp;void&nbsp;setPowerDownNextRound(boolean&nbsp;powerDownStatus)</pre>
<div class="block">Sets the power down status</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>powerDownStatus</code> - Whether the player is to take power down next turn</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/Phase.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../inf112/fiasko/roborally/objects/ProgrammingCard.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?inf112/fiasko/roborally/objects/Player.html" target="_top">Frames</a></li>
<li><a href="Player.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink