<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="de"> <head> <!-- Generated by javadoc (1.8.0_60) on Sun Sep 11 17:57:30 CEST 2016 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Room</title> <meta name="date" content="2016-09-11"> <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="Room"; } } catch(err) { } //--> var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10}; 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="class-use/Room.html">Use</a></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="../../../../eu/smoser/dungeongenerator/dungeon/Exit.html" title="class in eu.smoser.dungeongenerator.dungeon"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?eu/smoser/dungeongenerator/dungeon/Room.html" target="_top">Frames</a></li> <li><a href="Room.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><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </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">eu.smoser.dungeongenerator.dungeon</div> <h2 title="Class Room" class="title">Class Room</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>eu.smoser.dungeongenerator.dungeon.Room</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">Room</span> extends java.lang.Object</pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../eu/smoser/dungeongenerator/dungeon/Exit.html" title="class in eu.smoser.dungeongenerator.dungeon">Exit</a>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html#exits">exits</a></span></code> <div class="block">The list of exits in this room</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html#number">number</a></span></code> <div class="block">The unique number of the room</div> </td> </tr> </table> </li> </ul> <!-- ======== 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"> </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="../../../../eu/smoser/dungeongenerator/dungeon/Room.html#Room-eu.smoser.dungeongenerator.dungeon.Exit-int-boolean-java.lang.String-eu.smoser.dungeongenerator.util.Counter-">Room</a></span>(<a href="../../../../eu/smoser/dungeongenerator/dungeon/Exit.html" title="class in eu.smoser.dungeongenerator.dungeon">Exit</a> predecessor, int numberOfExits, boolean room, java.lang.String desc, <a href="../../../../eu/smoser/dungeongenerator/util/Counter.html" title="class in eu.smoser.dungeongenerator.util">Counter</a> c)</code> <div class="block">Constructs a room with a given predecessor, number of exits, description and counter</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>java.util.List<<a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html" title="class in eu.smoser.dungeongenerator.dungeon">Room</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html#generate-eu.smoser.dungeongenerator.util.Counter-eu.smoser.dungeongenerator.dungeon.Dungeon.Type-java.util.HashMap-">generate</a></span>(<a href="../../../../eu/smoser/dungeongenerator/util/Counter.html" title="class in eu.smoser.dungeongenerator.util">Counter</a> c, <a href="../../../../eu/smoser/dungeongenerator/dungeon/Dungeon.Type.html" title="enum in eu.smoser.dungeongenerator.dungeon">Dungeon.Type</a> type, java.util.HashMap<java.lang.Integer,java.lang.Integer> map)</code> <div class="block">Generates the content of the room</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html" title="class in eu.smoser.dungeongenerator.dungeon">Room</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html#RandomRoom-boolean-eu.smoser.dungeongenerator.dungeon.Exit-eu.smoser.dungeongenerator.util.Counter-eu.smoser.dungeongenerator.dungeon.Dungeon.Type-java.util.HashMap-">RandomRoom</a></span>(boolean first, <a href="../../../../eu/smoser/dungeongenerator/dungeon/Exit.html" title="class in eu.smoser.dungeongenerator.dungeon">Exit</a> predecessor, <a href="../../../../eu/smoser/dungeongenerator/util/Counter.html" title="class in eu.smoser.dungeongenerator.util">Counter</a> c, <a href="../../../../eu/smoser/dungeongenerator/dungeon/Dungeon.Type.html" title="enum in eu.smoser.dungeongenerator.dungeon">Dungeon.Type</a> type, java.util.HashMap<java.lang.Integer,java.lang.Integer> map)</code> <div class="block">Generates a random room</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html#toLongString--">toLongString</a></span>()</code> <div class="block">Returns a long description</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html#toShortString--">toShortString</a></span>()</code> <div class="block">Returns a short description</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="../../../../eu/smoser/dungeongenerator/dungeon/Room.html#toString--">toString</a></span>()</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class 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"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="number"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>number</h4> <pre>public int number</pre> <div class="block">The unique number of the room</div> </li> </ul> <a name="exits"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>exits</h4> <pre>public <a href="../../../../eu/smoser/dungeongenerator/dungeon/Exit.html" title="class in eu.smoser.dungeongenerator.dungeon">Exit</a>[] exits</pre> <div class="block">The list of exits in this room</div> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Room-eu.smoser.dungeongenerator.dungeon.Exit-int-boolean-java.lang.String-eu.smoser.dungeongenerator.util.Counter-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Room</h4> <pre>public Room(<a href="../../../../eu/smoser/dungeongenerator/dungeon/Exit.html" title="class in eu.smoser.dungeongenerator.dungeon">Exit</a> predecessor, int numberOfExits, boolean room, java.lang.String desc, <a href="../../../../eu/smoser/dungeongenerator/util/Counter.html" title="class in eu.smoser.dungeongenerator.util">Counter</a> c)</pre> <div class="block">Constructs a room with a given predecessor, number of exits, description and counter</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>predecessor</code> - Predecessor room</dd> <dd><code>numberOfExits</code> - Number of exits</dd> <dd><code>room</code> - Whether it is a room</dd> <dd><code>desc</code> - Description of room</dd> <dd><code>c</code> - Room counter</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="generate-eu.smoser.dungeongenerator.util.Counter-eu.smoser.dungeongenerator.dungeon.Dungeon.Type-java.util.HashMap-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>generate</h4> <pre>public java.util.List<<a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html" title="class in eu.smoser.dungeongenerator.dungeon">Room</a>> generate(<a href="../../../../eu/smoser/dungeongenerator/util/Counter.html" title="class in eu.smoser.dungeongenerator.util">Counter</a> c, <a href="../../../../eu/smoser/dungeongenerator/dungeon/Dungeon.Type.html" title="enum in eu.smoser.dungeongenerator.dungeon">Dungeon.Type</a> type, java.util.HashMap<java.lang.Integer,java.lang.Integer> map)</pre> <div class="block">Generates the content of the room</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>c</code> - Room counter</dd> <dd><code>type</code> - Environment type</dd> <dd><code>map</code> - Experimental map</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>Returns more rooms to generate</dd> </dl> </li> </ul> <a name="toString--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> <a name="toLongString--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toLongString</h4> <pre>public java.lang.String toLongString()</pre> <div class="block">Returns a long description</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Long description string</dd> </dl> </li> </ul> <a name="toShortString--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toShortString</h4> <pre>public java.lang.String toShortString()</pre> <div class="block">Returns a short description</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Short description string</dd> </dl> </li> </ul> <a name="RandomRoom-boolean-eu.smoser.dungeongenerator.dungeon.Exit-eu.smoser.dungeongenerator.util.Counter-eu.smoser.dungeongenerator.dungeon.Dungeon.Type-java.util.HashMap-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>RandomRoom</h4> <pre>public static <a href="../../../../eu/smoser/dungeongenerator/dungeon/Room.html" title="class in eu.smoser.dungeongenerator.dungeon">Room</a> RandomRoom(boolean first, <a href="../../../../eu/smoser/dungeongenerator/dungeon/Exit.html" title="class in eu.smoser.dungeongenerator.dungeon">Exit</a> predecessor, <a href="../../../../eu/smoser/dungeongenerator/util/Counter.html" title="class in eu.smoser.dungeongenerator.util">Counter</a> c, <a href="../../../../eu/smoser/dungeongenerator/dungeon/Dungeon.Type.html" title="enum in eu.smoser.dungeongenerator.dungeon">Dungeon.Type</a> type, java.util.HashMap<java.lang.Integer,java.lang.Integer> map)</pre> <div class="block">Generates a random room</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>first</code> - Whether it is the first room</dd> <dd><code>predecessor</code> - Predecessor room</dd> <dd><code>c</code> - Room counter</dd> <dd><code>type</code> - Environment type</dd> <dd><code>map</code> - The map for experimental mode</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>random room</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="class-use/Room.html">Use</a></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="../../../../eu/smoser/dungeongenerator/dungeon/Exit.html" title="class in eu.smoser.dungeongenerator.dungeon"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?eu/smoser/dungeongenerator/dungeon/Room.html" target="_top">Frames</a></li> <li><a href="Room.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><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>