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/Particle.html

382 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>Particle</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="Particle";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/ListGrid.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../inf112/fiasko/roborally/objects/Phase.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/Particle.html" target="_top">Frames</a></li>
<li><a href="Particle.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 Particle" class="title">Class Particle</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>inf112.fiasko.roborally.objects.Particle</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html" title="interface in inf112.fiasko.roborally.objects">BoardElement</a>&lt;<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Particle</span>
extends java.lang.Object
implements <a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html" title="interface in inf112.fiasko.roborally.objects">BoardElement</a>&lt;<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&gt;</pre>
<div class="block">This class represents a particle</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/Particle.html#Particle-inf112.fiasko.roborally.objects.properties.ParticleType-inf112.fiasko.roborally.objects.properties.Direction-">Particle</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&nbsp;particleType,
<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">Instantiates a new particle</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/BoardElement.html" title="interface in inf112.fiasko.roborally.objects">BoardElement</a>&lt;<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Particle.html#copy--">copy</a></span>()</code>
<div class="block">Makes a copy of the board element</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../inf112/fiasko/roborally/objects/properties/Direction.html" title="enum in inf112.fiasko.roborally.objects.properties">Direction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Particle.html#getDirection--">getDirection</a></span>()</code>
<div class="block">Gets the direction of the element</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Particle.html#getType--">getType</a></span>()</code>
<div class="block">Gets the type of the element</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Particle.html#setDirection-inf112.fiasko.roborally.objects.properties.Direction-">setDirection</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/properties/Direction.html" title="enum in inf112.fiasko.roborally.objects.properties">Direction</a>&nbsp;newDirection)</code>
<div class="block">Changes the direction of the element</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/objects/Particle.html#toString--">toString</a></span>()</code>&nbsp;</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, 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="Particle-inf112.fiasko.roborally.objects.properties.ParticleType-inf112.fiasko.roborally.objects.properties.Direction-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Particle</h4>
<pre>public&nbsp;Particle(<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&nbsp;particleType,
<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">Instantiates a new particle</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>particleType</code> - The type of the particle</dd>
<dd><code>direction</code> - The direction of the particle</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>public&nbsp;<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&nbsp;getType()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html#getType--">BoardElement</a></code></span></div>
<div class="block">Gets the type of the element</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html#getType--">getType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html" title="interface in inf112.fiasko.roborally.objects">BoardElement</a>&lt;<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An enum value of type K</dd>
</dl>
</li>
</ul>
<a name="getDirection--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirection</h4>
<pre>public&nbsp;<a href="../../../../inf112/fiasko/roborally/objects/properties/Direction.html" title="enum in inf112.fiasko.roborally.objects.properties">Direction</a>&nbsp;getDirection()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html#getDirection--">BoardElement</a></code></span></div>
<div class="block">Gets the direction of the element</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html#getDirection--">getDirection</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html" title="interface in inf112.fiasko.roborally.objects">BoardElement</a>&lt;<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The element's direction</dd>
</dl>
</li>
</ul>
<a name="setDirection-inf112.fiasko.roborally.objects.properties.Direction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDirection</h4>
<pre>public&nbsp;void&nbsp;setDirection(<a href="../../../../inf112/fiasko/roborally/objects/properties/Direction.html" title="enum in inf112.fiasko.roborally.objects.properties">Direction</a>&nbsp;newDirection)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html#setDirection-inf112.fiasko.roborally.objects.properties.Direction-">BoardElement</a></code></span></div>
<div class="block">Changes the direction of the element</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html#setDirection-inf112.fiasko.roborally.objects.properties.Direction-">setDirection</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html" title="interface in inf112.fiasko.roborally.objects">BoardElement</a>&lt;<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newDirection</code> - The element's new direction</dd>
</dl>
</li>
</ul>
<a name="copy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public&nbsp;<a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html" title="interface in inf112.fiasko.roborally.objects">BoardElement</a>&lt;<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&gt;&nbsp;copy()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html#copy--">BoardElement</a></code></span></div>
<div class="block">Makes a copy of the board element</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html#copy--">copy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../inf112/fiasko/roborally/objects/BoardElement.html" title="interface in inf112.fiasko.roborally.objects">BoardElement</a>&lt;<a href="../../../../inf112/fiasko/roborally/objects/properties/ParticleType.html" title="enum in inf112.fiasko.roborally.objects.properties">ParticleType</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A copy of the element</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></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/ListGrid.html" title="class in inf112.fiasko.roborally.objects"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../inf112/fiasko/roborally/objects/Phase.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/Particle.html" target="_top">Frames</a></li>
<li><a href="Particle.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