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/properties/RobotID.html

479 lines
19 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>RobotID</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="RobotID";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":9,"i3":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/properties/Position.html" title="class in inf112.fiasko.roborally.objects.properties"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../inf112/fiasko/roborally/objects/properties/TileType.html" title="enum in inf112.fiasko.roborally.objects.properties"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?inf112/fiasko/roborally/objects/properties/RobotID.html" target="_top">Frames</a></li>
<li><a href="RobotID.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><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&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.properties</div>
<h2 title="Enum RobotID" class="title">Enum RobotID</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&gt;</li>
<li>
<ul class="inheritance">
<li>inf112.fiasko.roborally.objects.properties.RobotID</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public enum <span class="typeNameLabel">RobotID</span>
extends java.lang.Enum&lt;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&gt;</pre>
<div class="block">This class represents an id for marking specific robots</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Enum Constant and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html#ROBOT_1">ROBOT_1</a></span></code>
<div class="block">The id of the first robot (white)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html#ROBOT_2">ROBOT_2</a></span></code>
<div class="block">The id of the second robot (pink)</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html#ROBOT_3">ROBOT_3</a></span></code>
<div class="block">The id of the third robot (light green)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html#ROBOT_4">ROBOT_4</a></span></code>
<div class="block">The id of the fourth robot (blue)</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html#ROBOT_5">ROBOT_5</a></span></code>
<div class="block">The id of the fifth robot (yellow)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html#ROBOT_6">ROBOT_6</a></span></code>
<div class="block">The id of the sixth robot (dark green)</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html#ROBOT_7">ROBOT_7</a></span></code>
<div class="block">The id of the seventh robot (orange)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html#ROBOT_8">ROBOT_8</a></span></code>
<div class="block">The id of the eight robot (red)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <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/properties/RobotID.html#getRobotIDFromID-int-">getRobotIDFromID</a></span>(int&nbsp;robotID)</code>
<div class="block">Gets a robot ID value from its numerical representation</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html#getRobotIDID--">getRobotIDID</a></span>()</code>
<div class="block">Gets the numerical id used for identification of a robot id</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <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/properties/RobotID.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <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/properties/RobotID.html#values--">values</a></span>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<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>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a name="ROBOT_1">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROBOT_1</h4>
<pre>public static final&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a> ROBOT_1</pre>
<div class="block">The id of the first robot (white)</div>
</li>
</ul>
<a name="ROBOT_2">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROBOT_2</h4>
<pre>public static final&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a> ROBOT_2</pre>
<div class="block">The id of the second robot (pink)</div>
</li>
</ul>
<a name="ROBOT_3">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROBOT_3</h4>
<pre>public static final&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a> ROBOT_3</pre>
<div class="block">The id of the third robot (light green)</div>
</li>
</ul>
<a name="ROBOT_4">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROBOT_4</h4>
<pre>public static final&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a> ROBOT_4</pre>
<div class="block">The id of the fourth robot (blue)</div>
</li>
</ul>
<a name="ROBOT_5">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROBOT_5</h4>
<pre>public static final&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a> ROBOT_5</pre>
<div class="block">The id of the fifth robot (yellow)</div>
</li>
</ul>
<a name="ROBOT_6">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROBOT_6</h4>
<pre>public static final&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a> ROBOT_6</pre>
<div class="block">The id of the sixth robot (dark green)</div>
</li>
</ul>
<a name="ROBOT_7">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROBOT_7</h4>
<pre>public static final&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a> ROBOT_7</pre>
<div class="block">The id of the seventh robot (orange)</div>
</li>
</ul>
<a name="ROBOT_8">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ROBOT_8</h4>
<pre>public static final&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a> ROBOT_8</pre>
<div class="block">The id of the eight robot (red)</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="values--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre>public static&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (RobotID c : RobotID.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a name="valueOf-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
<a name="getRobotIDFromID-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRobotIDFromID</h4>
<pre>public static&nbsp;<a href="../../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title="enum in inf112.fiasko.roborally.objects.properties">RobotID</a>&nbsp;getRobotIDFromID(int&nbsp;robotID)</pre>
<div class="block">Gets a robot ID value from its numerical representation</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>robotID</code> - The numerical representation of a robot id</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The enum value representing the robot ID, or null if the id is invalid</dd>
</dl>
</li>
</ul>
<a name="getRobotIDID--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRobotIDID</h4>
<pre>public&nbsp;int&nbsp;getRobotIDID()</pre>
<div class="block">Gets the numerical id used for identification of a robot id</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The numerical id of the robot id</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/properties/Position.html" title="class in inf112.fiasko.roborally.objects.properties"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../inf112/fiasko/roborally/objects/properties/TileType.html" title="enum in inf112.fiasko.roborally.objects.properties"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?inf112/fiasko/roborally/objects/properties/RobotID.html" target="_top">Frames</a></li>
<li><a href="RobotID.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><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&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