oppdaterer javadoc

This commit is contained in:
Tobydrama
2020-05-05 15:46:33 +02:00
parent d59c672c05
commit 2a03d3ac61
121 changed files with 371 additions and 403 deletions

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:39 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>Board</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@ -323,57 +323,51 @@ extends java.lang.Object</pre>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#respawnRobot-inf112.fiasko.roborally.objects.Robot-">respawnRobot</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/Robot.html" title="class in inf112.fiasko.roborally.objects">Robot</a>&nbsp;robot)</code>
<div class="block">Re-spawns a robot at the first available position relative to its backup position</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#respawnRobots--">respawnRobots</a></span>()</code>
<div class="block">Moves all dead robots to their backups and makes them part of the board again, and if a robot has no lives
it will be removed from the game.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#reverseRobot-inf112.fiasko.roborally.objects.properties.RobotID-">reverseRobot</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;robotID)</code>
<div class="block">Moves a robot one unit backwards according to the direction it's currently facing</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<tr id="i30" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#rotateRobotLeft-inf112.fiasko.roborally.objects.properties.RobotID-">rotateRobotLeft</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;robotID)</code>
<div class="block">Rotates a robot to the right</div>
</td>
</tr>
<tr id="i32" class="altColor">
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#rotateRobotRight-inf112.fiasko.roborally.objects.properties.RobotID-">rotateRobotRight</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;robotID)</code>
<div class="block">Rotates a robot to the left</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#setBackupPositionOfRobot-inf112.fiasko.roborally.objects.properties.RobotID-inf112.fiasko.roborally.objects.properties.Position-">setBackupPositionOfRobot</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;robotID,
<a href="../../../../inf112/fiasko/roborally/objects/properties/Position.html" title="class in inf112.fiasko.roborally.objects.properties">Position</a>&nbsp;position)</code>
<div class="block">Sets the backup position of a given robot to a given position</div>
</td>
</tr>
<tr id="i34" class="altColor">
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#setHasTouchedFlagThisTurn-inf112.fiasko.roborally.objects.properties.RobotID-boolean-">setHasTouchedFlagThisTurn</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;robotID,
boolean&nbsp;hasTouched)</code>
<div class="block">Sets a boolean for if the robot has touched a flag this turn</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#setPowerDown-inf112.fiasko.roborally.objects.properties.RobotID-java.lang.Boolean-">setPowerDown</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.Boolean&nbsp;powerDown)</code>
<div class="block">Sets the power down status of the robot</div>
</td>
</tr>
<tr id="i36" class="altColor">
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#teleportRobot-inf112.fiasko.roborally.objects.properties.RobotID-inf112.fiasko.roborally.objects.properties.Position-">teleportRobot</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;robotID,
<a href="../../../../inf112/fiasko/roborally/objects/properties/Position.html" title="class in inf112.fiasko.roborally.objects.properties">Position</a>&nbsp;newPosition)</code>
@ -382,23 +376,13 @@ extends java.lang.Object</pre>
Be quite careful about using this method.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#tryRobotRespawn-inf112.fiasko.roborally.objects.Robot-int-int-int-inf112.fiasko.roborally.objects.properties.Direction-">tryRobotRespawn</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/Robot.html" title="class in inf112.fiasko.roborally.objects">Robot</a>&nbsp;robot,
int&nbsp;size,
int&nbsp;startX,
int&nbsp;startY,
<a href="../../../../inf112/fiasko/roborally/objects/properties/Direction.html" title="enum in inf112.fiasko.roborally.objects.properties">Direction</a>&nbsp;direction)</code>
<div class="block">Tries to re-spawn a robot on one of the positions described</div>
</td>
</tr>
<tr id="i38" class="altColor">
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#updateRobotBackups--">updateRobotBackups</a></span>()</code>
<div class="block">Updates backup position of all robots on a repair tile</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Board.html#updateRobotFlag-inf112.fiasko.roborally.objects.properties.RobotID-inf112.fiasko.roborally.objects.BoardElementContainer-">updateRobotFlag</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;robotID,
<a href="../../../../inf112/fiasko/roborally/objects/BoardElementContainer.html" title="class in inf112.fiasko.roborally.objects">BoardElementContainer</a>&lt;<a href="../../../../inf112/fiasko/roborally/objects/Tile.html" title="class in inf112.fiasko.roborally.objects">Tile</a>&gt;&nbsp;flag)</code>
@ -792,44 +776,6 @@ extends java.lang.Object</pre>
it will be removed from the game.</div>
</li>
</ul>
<a name="respawnRobot-inf112.fiasko.roborally.objects.Robot-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>respawnRobot</h4>
<pre>public&nbsp;void&nbsp;respawnRobot(<a href="../../../../inf112/fiasko/roborally/objects/Robot.html" title="class in inf112.fiasko.roborally.objects">Robot</a>&nbsp;robot)</pre>
<div class="block">Re-spawns a robot at the first available position relative to its backup position</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>robot</code> - The robot to re-spawn</dd>
</dl>
</li>
</ul>
<a name="tryRobotRespawn-inf112.fiasko.roborally.objects.Robot-int-int-int-inf112.fiasko.roborally.objects.properties.Direction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tryRobotRespawn</h4>
<pre>public&nbsp;boolean&nbsp;tryRobotRespawn(<a href="../../../../inf112/fiasko/roborally/objects/Robot.html" title="class in inf112.fiasko.roborally.objects">Robot</a>&nbsp;robot,
int&nbsp;size,
int&nbsp;startX,
int&nbsp;startY,
<a href="../../../../inf112/fiasko/roborally/objects/properties/Direction.html" title="enum in inf112.fiasko.roborally.objects.properties">Direction</a>&nbsp;direction)</pre>
<div class="block">Tries to re-spawn a robot on one of the positions described</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>robot</code> - The robot to re-spawn</dd>
<dd><code>size</code> - The size of the square relative to the robot's spawn to try</dd>
<dd><code>startX</code> - The x coordinate of the robot's backup position</dd>
<dd><code>startY</code> - The y coordinate of the robot's backup position</dd>
<dd><code>direction</code> - The direction of the face of the square to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Whether the robot was re-spawned</dd>
</dl>
</li>
</ul>
<a name="updateRobotBackups--">
<!-- -->
</a>