mirror of
https://github.com/inf112-v20/Fiasko.git
synced 2025-11-04 11:43:44 +01:00
332 lines
12 KiB
HTML
332 lines
12 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_201) on Tue May 05 15:44:52 CEST 2020 -->
|
|
<title>RoboRallyUI</title>
|
|
<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>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="RoboRallyUI";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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>Prev Class</li>
|
|
<li><a href="../../../../inf112/fiasko/roborally/ui/RoboRallyWrapper.html" title="class in inf112.fiasko.roborally.ui"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?inf112/fiasko/roborally/ui/RoboRallyUI.html" target="_top">Frames</a></li>
|
|
<li><a href="RoboRallyUI.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.ui</div>
|
|
<h2 title="Interface RoboRallyUI" class="title">Interface RoboRallyUI</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/ui/RoboRallyWrapper.html" title="class in inf112.fiasko.roborally.ui">RoboRallyWrapper</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">RoboRallyUI</span></pre>
|
|
<div class="block">An interface describing necessary methods for a user interface</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><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html" title="interface in inf112.fiasko.roborally.objects">InteractableGame</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/RoboRallyUI.html#getGame--">getGame</a></span>()</code>
|
|
<div class="block">Gets the robo rally game being rendered by the UI</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../inf112/fiasko/roborally/networking/RoboRallyServer.html" title="class in inf112.fiasko.roborally.networking">RoboRallyServer</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/RoboRallyUI.html#getServer--">getServer</a></span>()</code>
|
|
<div class="block">Gets the servers used for receiving objects from clients</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/ui/RoboRallyUI.html#isTesting--">isTesting</a></span>()</code>
|
|
<div class="block">Gets whether the game should be started in test mode</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/ui/RoboRallyUI.html#quit-java.lang.String-">quit</a></span>(java.lang.String message)</code>
|
|
<div class="block">Quits the game in whatever way is appropriate</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/RoboRallyUI.html#setGame-inf112.fiasko.roborally.objects.RoboRallyGame-">setGame</a></span>(<a href="../../../../inf112/fiasko/roborally/objects/RoboRallyGame.html" title="class in inf112.fiasko.roborally.objects">RoboRallyGame</a> game)</code>
|
|
<div class="block">Sets the robo rally game being rendered by the UI</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/ui/RoboRallyUI.html#setShouldHurry-boolean-">setShouldHurry</a></span>(boolean shouldHurry)</code>
|
|
<div class="block">Sets whether the client should hurry with whatever it's doing</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="getGame--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getGame</h4>
|
|
<pre><a href="../../../../inf112/fiasko/roborally/objects/InteractableGame.html" title="interface in inf112.fiasko.roborally.objects">InteractableGame</a> getGame()</pre>
|
|
<div class="block">Gets the robo rally game being rendered by the UI</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The game used by the UI</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setGame-inf112.fiasko.roborally.objects.RoboRallyGame-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setGame</h4>
|
|
<pre>void setGame(<a href="../../../../inf112/fiasko/roborally/objects/RoboRallyGame.html" title="class in inf112.fiasko.roborally.objects">RoboRallyGame</a> game)</pre>
|
|
<div class="block">Sets the robo rally game being rendered by the UI</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>game</code> - The new robo rally game being rendered</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="quit-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>quit</h4>
|
|
<pre>void quit(java.lang.String message)</pre>
|
|
<div class="block">Quits the game in whatever way is appropriate</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>message</code> - The message describing why the game quit</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getServer--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getServer</h4>
|
|
<pre><a href="../../../../inf112/fiasko/roborally/networking/RoboRallyServer.html" title="class in inf112.fiasko.roborally.networking">RoboRallyServer</a> getServer()</pre>
|
|
<div class="block">Gets the servers used for receiving objects from clients</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The server of the game</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setShouldHurry-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setShouldHurry</h4>
|
|
<pre>void setShouldHurry(boolean shouldHurry)</pre>
|
|
<div class="block">Sets whether the client should hurry with whatever it's doing</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>shouldHurry</code> - True if the user should hurry</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isTesting--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>isTesting</h4>
|
|
<pre>boolean isTesting()</pre>
|
|
<div class="block">Gets whether the game should be started in test mode</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the game should be started in test mode</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>Prev Class</li>
|
|
<li><a href="../../../../inf112/fiasko/roborally/ui/RoboRallyWrapper.html" title="class in inf112.fiasko.roborally.ui"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?inf112/fiasko/roborally/ui/RoboRallyUI.html" target="_top">Frames</a></li>
|
|
<li><a href="RoboRallyUI.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>
|