tukkek
/
javelin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
javelin/doc/javadoc/javelin/Javelin.html

917 lines
36 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_91) on Fri Jul 15 16:06:25 BRT 2016 -->
<title>Javelin</title>
<meta name="date" content="2016-07-15">
<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="Javelin";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../javelin/JavelinApp.html" title="class in javelin"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?javelin/Javelin.html" target="_top">Frames</a></li>
<li><a href="Javelin.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="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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">javelin</div>
<h2 title="Class Javelin" class="title">Class Javelin</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>javelin.Javelin</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Javelin</span>
extends java.lang.Object</pre>
<div class="block">Utility class for broad-level rules and game-behavior. Add -Ddebug=true to
the java command line for easier debugging and logging.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>alex</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../javelin/Javelin.html#DEBUG"><code>DEBUG</code></a></dd>
</dl>
</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">&nbsp;</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>static java.util.List&lt;<a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit">Monster</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#ALLMONSTERS">ALLMONSTERS</a></span></code>
<div class="block">All loaded XML <a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit"><code>Monster</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../javelin/JavelinApp.html" title="class in javelin">JavelinApp</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#app">app</a></span></code>
<div class="block">Singleton.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit">Combatant</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#captured">captured</a></span></code>
<div class="block">Monster captured on a <a href="../javelin/controller/fight/LairFight.html" title="class in javelin.controller.fight"><code>LairFight</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#DEBUG">DEBUG</a></span></code>
<div class="block">Add -Ddebug=true to the java VM command line for easier debugging and
logging.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.TreeMap&lt;java.lang.String,java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#DESCRIPTIONS">DESCRIPTIONS</a></span></code>
<div class="block">Monster descriptions, separate from <a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit"><code>Monster</code></a> data to avoid
duplication in memory when using <a href="../javelin/model/unit/Monster.html#clone--"><code>Monster.clone()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.TreeMap&lt;java.lang.Float,java.util.List&lt;<a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit">Monster</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#MONSTERSBYCR">MONSTERSBYCR</a></span></code>
<div class="block">All loaded monster mapped by challenge rating.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#PERIODEVENING">PERIODEVENING</a></span></code>
<div class="block">TODO turn into <code>Enum</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#PERIODMORNING">PERIODMORNING</a></span></code>
<div class="block">TODO turn into <code>Enum</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#PERIODNIGHT">PERIODNIGHT</a></span></code>
<div class="block">TODO turn into <code>Enum</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#PERIODNOON">PERIODNOON</a></span></code>
<div class="block">TODO turn into <code>Enum</code></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">&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="../javelin/Javelin.html#Javelin--">Javelin</a></span>()</code>&nbsp;</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="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="../javelin/model/unit/Squad.html" title="class in javelin.model.unit">Squad</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#act--">act</a></span>()</code>
<div class="block">This is also the only function that should write to <a href="../javelin/model/unit/Squad.html#active"><code>Squad.active</code></a>
so it should be called with extreme caution to avoid changing it in the
middle of an action.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#choose-java.lang.String-java.util.List-boolean-boolean-">choose</a></span>(java.lang.String&nbsp;output,
java.util.List&lt;?&gt;&nbsp;names,
boolean&nbsp;fullscreen,
boolean&nbsp;forceselection)</code>
<div class="block">Utility function for user-input selection.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit">Combatant</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#getCombatant-int-">getCombatant</a></span>(int&nbsp;id)</code>
<div class="block">TODO remove?</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit">Combatant</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#getCombatant-tyrant.mikera.engine.Thing-">getCombatant</a></span>(tyrant.mikera.engine.Thing&nbsp;t)</code>
<div class="block">TODO remove on 2.0+</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#getDayPeriod--">getDayPeriod</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#gethighscore--">gethighscore</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#getHour--">getHour</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit">Monster</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#getmonster-java.lang.String-">getmonster</a></span>(java.lang.String&nbsp;name)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#lose--">lose</a></span>()</code>
<div class="block">Once the player has no more <a href="../javelin/model/unit/Squad.html" title="class in javelin.model.unit"><code>Squad</code></a>s and <a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit"><code>Combatant</code></a>s under
his control call this to stop the current game, invalidate the save file,
record the highscore and exit the application.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#main-java.lang.String:A-">main</a></span>(java.lang.String[]&nbsp;args)</code>
<div class="block">First method to be called.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static java.awt.event.KeyEvent</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#message-java.lang.String-boolean-">message</a></span>(java.lang.String&nbsp;text,
boolean&nbsp;requireenter)</code>
<div class="block">Main output function for <a href="../javelin/view/screen/WorldScreen.html" title="class in javelin.view.screen"><code>WorldScreen</code></a>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="../javelin/model/unit/Squad.html" title="class in javelin.model.unit">Squad</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#nexttoact--">nexttoact</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static java.lang.Character</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#prompt-java.lang.String-">prompt</a></span>(java.lang.String&nbsp;prompt)</code>
<div class="block">Prompts a message in the <a href="../javelin/view/screen/WorldScreen.html" title="class in javelin.view.screen"><code>WorldScreen</code></a>.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static java.lang.Integer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#randomdifficulty--">randomdifficulty</a></span>()</code>
<div class="block">2 chances of an easy encounter, 10 chances of a moderate encounter, 4
chances of a difficult encounter and 1 chance of an overwhelming
encounter</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#record--">record</a></span>()</code>
<div class="block">Sets the highscore and...</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static <a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit">Combatant</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#recruit-javelin.model.unit.Monster-">recruit</a></span>(<a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit">Monster</a>&nbsp;pick)</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#roll-int-">roll</a></span>(int&nbsp;take10)</code>
<div class="block">Most of the time take-10 rules are used to prevent players from boring
themselves.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#sayWelcome--">sayWelcome</a></span>()</code>
<div class="block">Pure fluff/flavor.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#sethighscore-long-">sethighscore</a></span>(long&nbsp;score)</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#settexture-java.awt.Image-">settexture</a></span>(java.awt.Image&nbsp;file)</code>&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../javelin/Javelin.html#translatetochance-int-">translatetochance</a></span>(int&nbsp;rolltohit)</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, toString, 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="DEBUG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEBUG</h4>
<pre>public static final&nbsp;boolean DEBUG</pre>
<div class="block">Add -Ddebug=true to the java VM command line for easier debugging and
logging.</div>
</li>
</ul>
<a name="PERIODMORNING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERIODMORNING</h4>
<pre>public static final&nbsp;java.lang.String PERIODMORNING</pre>
<div class="block">TODO turn into <code>Enum</code></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#javelin.Javelin.PERIODMORNING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PERIODNOON">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERIODNOON</h4>
<pre>public static final&nbsp;java.lang.String PERIODNOON</pre>
<div class="block">TODO turn into <code>Enum</code></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#javelin.Javelin.PERIODNOON">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PERIODEVENING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERIODEVENING</h4>
<pre>public static final&nbsp;java.lang.String PERIODEVENING</pre>
<div class="block">TODO turn into <code>Enum</code></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#javelin.Javelin.PERIODEVENING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PERIODNIGHT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PERIODNIGHT</h4>
<pre>public static final&nbsp;java.lang.String PERIODNIGHT</pre>
<div class="block">TODO turn into <code>Enum</code></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#javelin.Javelin.PERIODNIGHT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DESCRIPTIONS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DESCRIPTIONS</h4>
<pre>public static&nbsp;java.util.TreeMap&lt;java.lang.String,java.lang.String&gt; DESCRIPTIONS</pre>
<div class="block">Monster descriptions, separate from <a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit"><code>Monster</code></a> data to avoid
duplication in memory when using <a href="../javelin/model/unit/Monster.html#clone--"><code>Monster.clone()</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Combatant#clonedeeply()</code></dd>
</dl>
</li>
</ul>
<a name="MONSTERSBYCR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MONSTERSBYCR</h4>
<pre>public static&nbsp;java.util.TreeMap&lt;java.lang.Float,java.util.List&lt;<a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit">Monster</a>&gt;&gt; MONSTERSBYCR</pre>
<div class="block">All loaded monster mapped by challenge rating.</div>
</li>
</ul>
<a name="ALLMONSTERS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ALLMONSTERS</h4>
<pre>public static&nbsp;java.util.List&lt;<a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit">Monster</a>&gt; ALLMONSTERS</pre>
<div class="block">All loaded XML <a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit"><code>Monster</code></a>s. See <a href="../javelin/controller/db/reader/MonsterReader.html" title="class in javelin.controller.db.reader"><code>MonsterReader</code></a>.</div>
</li>
</ul>
<a name="app">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>app</h4>
<pre>public static&nbsp;<a href="../javelin/JavelinApp.html" title="class in javelin">JavelinApp</a> app</pre>
<div class="block">Singleton.</div>
</li>
</ul>
<a name="captured">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>captured</h4>
<pre>public static&nbsp;<a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit">Combatant</a> captured</pre>
<div class="block">Monster captured on a <a href="../javelin/controller/fight/LairFight.html" title="class in javelin.controller.fight"><code>LairFight</code></a>.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Javelin--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Javelin</h4>
<pre>public&nbsp;Javelin()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)</pre>
<div class="block">First method to be called.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - See <a href="../javelin/Javelin.html#DEBUG"><code>DEBUG</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getCombatant-tyrant.mikera.engine.Thing-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCombatant</h4>
<pre>public static&nbsp;<a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit">Combatant</a>&nbsp;getCombatant(tyrant.mikera.engine.Thing&nbsp;t)</pre>
<div class="block">TODO remove on 2.0+</div>
</li>
</ul>
<a name="getDayPeriod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDayPeriod</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getDayPeriod()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../javelin/Javelin.html#PERIODEVENING"><code>PERIODEVENING</code></a>, <a href="../javelin/Javelin.html#PERIODMORNING"><code>PERIODMORNING</code></a>,
<a href="../javelin/Javelin.html#PERIODNIGHT"><code>PERIODNIGHT</code></a> or <a href="../javelin/Javelin.html#PERIODNOON">"Noon"</a>.</dd>
</dl>
</li>
</ul>
<a name="getHour--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHour</h4>
<pre>public static&nbsp;long&nbsp;getHour()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Hour of the day, from 0 to 23.</dd>
</dl>
</li>
</ul>
<a name="act--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>act</h4>
<pre>public static&nbsp;<a href="../javelin/model/unit/Squad.html" title="class in javelin.model.unit">Squad</a>&nbsp;act()</pre>
<div class="block">This is also the only function that should write to <a href="../javelin/model/unit/Squad.html#active"><code>Squad.active</code></a>
so it should be called with extreme caution to avoid changing it in the
middle of an action.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Next squad to act.</dd>
</dl>
</li>
</ul>
<a name="nexttoact--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nexttoact</h4>
<pre>public static&nbsp;<a href="../javelin/model/unit/Squad.html" title="class in javelin.model.unit">Squad</a>&nbsp;nexttoact()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Next squad to act.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../javelin/model/unit/Squad.html#hourselapsed"><code>Squad.hourselapsed</code></a></dd>
</dl>
</li>
</ul>
<a name="sayWelcome--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sayWelcome</h4>
<pre>public static&nbsp;java.lang.String&nbsp;sayWelcome()</pre>
<div class="block">Pure fluff/flavor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Welcomes the playet to the game based on the current time of the
day.</dd>
</dl>
</li>
</ul>
<a name="lose--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lose</h4>
<pre>public static&nbsp;void&nbsp;lose()</pre>
<div class="block">Once the player has no more <a href="../javelin/model/unit/Squad.html" title="class in javelin.model.unit"><code>Squad</code></a>s and <a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit"><code>Combatant</code></a>s under
his control call this to stop the current game, invalidate the save file,
record the highscore and exit the application.</div>
</li>
</ul>
<a name="record--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>record</h4>
<pre>public static&nbsp;java.lang.String&nbsp;record()</pre>
<div class="block">Sets the highscore and...</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a message with previous and current score.</dd>
</dl>
</li>
</ul>
<a name="sethighscore-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sethighscore</h4>
<pre>public static&nbsp;void&nbsp;sethighscore(long&nbsp;score)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>score</code> - Updates the highscore record with this value.</dd>
</dl>
</li>
</ul>
<a name="gethighscore--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>gethighscore</h4>
<pre>public static&nbsp;long&nbsp;gethighscore()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The current highscore value.</dd>
</dl>
</li>
</ul>
<a name="recruit-javelin.model.unit.Monster-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recruit</h4>
<pre>public static&nbsp;<a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit">Combatant</a>&nbsp;recruit(<a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit">Monster</a>&nbsp;pick)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pick</code> - Source statistics to make an unit from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An actual unit with said statistics.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../javelin/model/unit/Combatant.html#clone--"><code>Combatant.clone()</code></a>,
<a href="../javelin/view/screen/town/RecruitScreen.html#namingscreen-java.lang.String-"><code>RecruitScreen.namingscreen(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="settexture-java.awt.Image-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>settexture</h4>
<pre>public static&nbsp;void&nbsp;settexture(java.awt.Image&nbsp;file)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - Uses the given image as background.</dd>
</dl>
</li>
</ul>
<a name="getCombatant-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCombatant</h4>
<pre>public static&nbsp;<a href="../javelin/model/unit/Combatant.html" title="class in javelin.model.unit">Combatant</a>&nbsp;getCombatant(int&nbsp;id)</pre>
<div class="block">TODO remove?</div>
</li>
</ul>
<a name="translatetochance-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>translatetochance</h4>
<pre>public static&nbsp;java.lang.String&nbsp;translatetochance(int&nbsp;rolltohit)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rolltohit</code> - The number that needs to be rolled on a d20 for this action to
succeed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A textual representation of how easy or hard this action is to
achieve.</dd>
</dl>
</li>
</ul>
<a name="randomdifficulty--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>randomdifficulty</h4>
<pre>public static&nbsp;java.lang.Integer&nbsp;randomdifficulty()</pre>
<div class="block">2 chances of an easy encounter, 10 chances of a moderate encounter, 4
chances of a difficult encounter and 1 chance of an overwhelming
encounter</div>
</li>
</ul>
<a name="choose-java.lang.String-java.util.List-boolean-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>choose</h4>
<pre>public static&nbsp;int&nbsp;choose(java.lang.String&nbsp;output,
java.util.List&lt;?&gt;&nbsp;names,
boolean&nbsp;fullscreen,
boolean&nbsp;forceselection)</pre>
<div class="block">Utility function for user-input selection.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>output</code> - Text to show the user.</dd>
<dd><code>names</code> - Will show each's <code>Object.toString()</code> as an option.</dd>
<dd><code>fullscreen</code> - <code>true</code> to open in a new screen. Otherwise uses the
message panel.</dd>
<dd><code>forceselection</code> - If <code>false</code> will allow the user to abort the
operation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The index of the selected element or -1 if aborted.</dd>
</dl>
</li>
</ul>
<a name="message-java.lang.String-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>message</h4>
<pre>public static&nbsp;java.awt.event.KeyEvent&nbsp;message(java.lang.String&nbsp;text,
boolean&nbsp;requireenter)</pre>
<div class="block">Main output function for <a href="../javelin/view/screen/WorldScreen.html" title="class in javelin.view.screen"><code>WorldScreen</code></a>. Waits for user input for
confirmation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>text</code> - Prints this message in the status panel.</dd>
<dd><code>requireenter</code> - If <code>true</code> will wait for the player to press ENTER,
otherwise any key will do.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the key pressed by the user as confirmation for seeing the
message.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../javelin/controller/old/Game.html#message-java.lang.String-javelin.model.unit.Combatant-javelin.controller.old.Game.Delay-"><code>Game.message(String, Combatant, Delay)</code></a></dd>
</dl>
</li>
</ul>
<a name="prompt-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prompt</h4>
<pre>public static&nbsp;java.lang.Character&nbsp;prompt(java.lang.String&nbsp;prompt)</pre>
<div class="block">Prompts a message in the <a href="../javelin/view/screen/WorldScreen.html" title="class in javelin.view.screen"><code>WorldScreen</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prompt</code> - Text to show.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Any <a href="../javelin/view/screen/InfoScreen.html#feedback--"><code>InfoScreen.feedback()</code></a>.</dd>
</dl>
</li>
</ul>
<a name="getmonster-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getmonster</h4>
<pre>public static&nbsp;<a href="../javelin/model/unit/Monster.html" title="class in javelin.model.unit">Monster</a>&nbsp;getmonster(java.lang.String&nbsp;name)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Monster type. Example: orc, kobold, young white dragon... Case
insensitive.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A clone.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../javelin/model/unit/Monster.html#clone--"><code>Monster.clone()</code></a></dd>
</dl>
</li>
</ul>
<a name="roll-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>roll</h4>
<pre>public static&nbsp;int&nbsp;roll(int&nbsp;take10)</pre>
<div class="block">Most of the time take-10 rules are used to prevent players from boring
themselves. For example: trying repeatedly to use
<code>Skills#perception</code> to see what's inside a <a href="../javelin/model/world/location/fortification/Fortification.html" title="class in javelin.model.world.location.fortification"><code>Fortification</code></a>.
That's no fun. On other scenarios though it's more interesting to make
these rolls random - for example, if always using take-10 rolls
<a href="../javelin/controller/terrain/hazard/PartyHazard.html" title="class in javelin.controller.terrain.hazard"><code>PartyHazard</code></a>s would become obsolete when a character with enough
<code>Skills#survival</code> is in the party.
Note also that randomization can't be used without proper treatment
inside <a href="../javelin/controller/ai/BattleAi.html" title="class in javelin.controller.ai"><code>BattleAi</code></a> computing, which is why take-10 rolls makes
things easier while in-battle.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>take10</code> - A take-10 result.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>result of the same roll, but rolling a d20 instead.</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-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../javelin/JavelinApp.html" title="class in javelin"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?javelin/Javelin.html" target="_top">Frames</a></li>
<li><a href="Javelin.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="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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 View Git Blame Copy Permalink