gameplay.html
api/sleela/3.0/version-001/package/gameplay.html · 537 line(s) · html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Package gameplay — SleelaDoc API</title>
<link rel="stylesheet" href="../style.css">
</head>
<body>
<header class="top">
<div class="brand"><a href="../index.html">SleelaDoc API</a></div>
<div class="tag">HTML documentation for the SLeeLa standard library (/lib)</div>
</header>
<div class="wrap">
<nav class="side">
<a href="../index.html"><strong>Home</strong></a>
<a href="../packages.html"><strong>All packages</strong></a>
<a href="../glossary.html"><strong>Glossary</strong></a>
<a href="../authorship.html"><strong>Authorship</strong></a>
<h2>Packages</h2><ul>
<li><a href="../package/alphabet.html">alphabet</a></li>
<li><a href="../package/antivirus.html">antivirus</a></li>
<li><a href="../package/api.html">api</a></li>
<li><a href="../package/audio.html">audio</a></li>
<li><a href="../package/autocad.html">autocad</a></li>
<li><a href="../package/ballum.html">ballum</a></li>
<li><a href="../package/bash.html">bash</a></li>
<li><a href="../package/boolean.html">boolean</a></li>
<li><a href="../package/cdma.html">cdma</a></li>
<li><a href="../package/character.html">character</a></li>
<li><a href="../package/churn.html">churn</a></li>
<li><a href="../package/citizen.html">citizen</a></li>
<li><a href="../package/codecs.html">codecs</a></li>
<li><a href="../package/collections.html">collections</a></li>
<li><a href="../package/common-rails.html">common-rails</a></li>
<li><a href="../package/compiler.html">compiler</a></li>
<li><a href="../package/compression.html">compression</a></li>
<li><a href="../package/config.html">config</a></li>
<li><a href="../package/connector.html">connector</a></li>
<li><a href="../package/coorenagraph.html">coorenagraph</a></li>
<li><a href="../package/core.html">core</a></li>
<li><a href="../package/cpu.html">cpu</a></li>
<li><a href="../package/crypto.html">crypto</a></li>
<li><a href="../package/data.html">data</a></li>
<li><a href="../package/data-structures.html">data-structures</a></li>
<li><a href="../package/database.html">database</a></li>
<li><a href="../package/debugger.html">debugger</a></li>
<li><a href="../package/decompiler.html">decompiler</a></li>
<li><a href="../package/deliberation.html">deliberation</a></li>
<li><a href="../package/drivers.html">drivers</a></li>
<li><a href="../package/examples.html">examples</a></li>
<li><a href="../package/filesystem.html">filesystem</a></li>
<li><a href="../package/gameplay.html">gameplay</a></li>
<li><a href="../package/gui.html">gui</a></li>
<li><a href="../package/html.html">html</a></li>
<li><a href="../package/http.html">http</a></li>
<li><a href="../package/http-1.0.html">http-1.0</a></li>
<li><a href="../package/http-2.0.html">http-2.0</a></li>
<li><a href="../package/http-3.0.html">http-3.0</a></li>
<li><a href="../package/http-4.0.html">http-4.0</a></li>
<li><a href="../package/http-5.0.html">http-5.0</a></li>
<li><a href="../package/http-6.0.html">http-6.0</a></li>
<li><a href="../package/http-7.0.html">http-7.0</a></li>
<li><a href="../package/http-8.0.html">http-8.0</a></li>
<li><a href="../package/http-9.0.html">http-9.0</a></li>
<li><a href="../package/http-servers.html">http-servers</a></li>
<li><a href="../package/ide.html">ide</a></li>
<li><a href="../package/ide-workbench.html">ide-workbench</a></li>
<li><a href="../package/idea.html">idea</a></li>
<li><a href="../package/inference-model.html">inference-model</a></li>
<li><a href="../package/inputs.html">inputs</a></li>
<li><a href="../package/international-criminal-court.html">international-criminal-court</a></li>
<li><a href="../package/io.html">io</a></li>
<li><a href="../package/java.html">java</a></li>
<li><a href="../package/java28.html">java28</a></li>
<li><a href="../package/journey.html">journey</a></li>
<li><a href="../package/languages.html">languages</a></li>
<li><a href="../package/ledger.html">ledger</a></li>
<li><a href="../package/linux-editors.html">linux-editors</a></li>
<li><a href="../package/manifesto.html">manifesto</a></li>
<li><a href="../package/math.html">math</a></li>
<li><a href="../package/memory.html">memory</a></li>
<li><a href="../package/modules.html">modules</a></li>
<li><a href="../package/moral-capacitor.html">moral-capacitor</a></li>
<li><a href="../package/munction.html">munction</a></li>
<li><a href="../package/native.html">native</a></li>
<li><a href="../package/net.html">net</a></li>
<li><a href="../package/nordshrift.html">nordshrift</a></li>
<li><a href="../package/opcodes.html">opcodes</a></li>
<li><a href="../package/operating-system.html">operating-system</a></li>
<li><a href="../package/os-level-support.html">os-level-support</a></li>
<li><a href="../package/philosophers.html">philosophers</a></li>
<li><a href="../package/philosophy.html">philosophy</a></li>
<li><a href="../package/politico.html">politico</a></li>
<li><a href="../package/process.html">process</a></li>
<li><a href="../package/psychiatry.html">psychiatry</a></li>
<li><a href="../package/public.html">public</a></li>
<li><a href="../package/reflection.html">reflection</a></li>
<li><a href="../package/regex.html">regex</a></li>
<li><a href="../package/registry.html">registry</a></li>
<li><a href="../package/rmi.html">rmi</a></li>
<li><a href="../package/runtime.html">runtime</a></li>
<li><a href="../package/security.html">security</a></li>
<li><a href="../package/server-edition.html">server-edition</a></li>
<li><a href="../package/signal-processing.html">signal-processing</a></li>
<li><a href="../package/sldocument.html">sldocument</a></li>
<li><a href="../package/sleela.html">sleela</a></li>
<li><a href="../package/sleela-sql.html">sleela-sql</a></li>
<li><a href="../package/sleela-terminal.html">sleela-terminal</a></li>
<li><a href="../package/sleeladoc.html">sleeladoc</a></li>
<li><a href="../package/social-model.html">social-model</a></li>
<li><a href="../package/sommeliers.html">sommeliers</a></li>
<li><a href="../package/spatial.html">spatial</a></li>
<li><a href="../package/sst.html">sst</a></li>
<li><a href="../package/synchro.html">synchro</a></li>
<li><a href="../package/systems.html">systems</a></li>
<li><a href="../package/telephony-skya.html">telephony-skya</a></li>
<li><a href="../package/terminal.html">terminal</a></li>
<li><a href="../package/terminal_pixel.html">terminal_pixel</a></li>
<li><a href="../package/text.html">text</a></li>
<li><a href="../package/ui.html">ui</a></li>
<li><a href="../package/us-infrastructure.html">us-infrastructure</a></li>
<li><a href="../package/user-interface.html">user-interface</a></li>
<li><a href="../package/video.html">video</a></li>
<li><a href="../package/vm.html">vm</a></li>
<li><a href="../package/web-server-technology.html">web-server-technology</a></li>
<li><a href="../package/website.html">website</a></li>
<li><a href="../package/wifi.html">wifi</a></li>
<li><a href="../package/xlt.html">xlt</a></li>
<li><a href="../package/xml.html">xml</a></li>
</ul>
</nav>
<main>
<div class="crumbs"><a href="../index.html">Home</a> › <a href="../packages.html">Packages</a> › gameplay</div>
<h1>Package <code>gameplay</code></h1>
<div class="lead">This package contains <strong>14</strong> source unit(s) defining <strong>14</strong> class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.</div>
<input class="search" placeholder="Filter on this page (Ctrl+F also works)…" oninput="flt(this.value)">
<h2 class="section" data-u="askforhelpmove">AskForHelpMove <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/AskForHelpMove.sleela)</span></h2>
<div data-u="askforhelpmove askforhelpmove">
<h3 id="AskForHelpMove">AskForHelpMove <span class="pill">class</span> <span class="muted">extends <code>GameMove</code></span></h3>
<p class="desc">Move (b) — ask for help or new routes. A straight 50/50. Win the flip and the Inference Engine lets you LOOK at your Expected Future as it is being modeled, so you can see whether you are on schedule in your own custom game. Lose the flip and your Boss instead hands you a Detailed Report with some Game-Engineering moves already decided — and you pay for that information based on the Quality of your Person/Citizen. A concrete GameMove: override resolve() to flip, then either read the future or buy the report. The future it modeled and the report it bought are stashed on the move so the turn can show them. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>BASE_REPORT_COST</code></td><td><span class="sig">static final int BASE_REPORT_COST = 2000</span></td><td class="desc">cents, before quality scaling</td></tr>
<tr><td><code>lastFuture</code></td><td><span class="sig">ExpectedFuture lastFuture</span></td><td class="desc">populated on a winning flip</td></tr>
<tr><td><code>lastReport</code></td><td><span class="sig">DetailedReport lastReport</span></td><td class="desc">populated on a losing flip</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>resolve</code></td><td><span class="sig">MoveOutcome resolve(Player p)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>future</code></td><td><span class="sig">ExpectedFuture future()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>report</code></td><td><span class="sig">DetailedReport report()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="detailedreport">DetailedReport <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/DetailedReport.sleela)</span></h2>
<div data-u="detailedreport detailedreport">
<h3 id="DetailedReport">DetailedReport <span class="pill">class</span></h3>
<p class="desc">Defines DetailedReport, the document the Boss hands a Player on a LOSING "ask for help" roll — the consolation prize that is often the better prize. Where ExpectedFuture only shows the schedule, a DetailedReport comes with some Game-Engineering moves ALREADY decided, so the player gets a plan instead of a prophecy. The player pays for it based on their own quality. DetailedReport is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It holds an ordered list of pre-decided engineering moves and the price that was charged for it. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "DetailedReport"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>MAX_MOVES</code></td><td><span class="sig">static final int MAX_MOVES = 16</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>title</code></td><td><span class="sig">String title</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>decidedMoves</code></td><td><span class="sig">String[] decidedMoves</span></td><td class="desc">Game-Engineering moves the boss already chose</td></tr>
<tr><td><code>moveCount</code></td><td><span class="sig">int moveCount</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>pricePaidCents</code></td><td><span class="sig">int pricePaidCents</span></td><td class="desc">what the player paid, by their quality</td></tr>
<tr><td><code>affordable</code></td><td><span class="sig">boolean affordable</span></td><td class="desc">whether the player could pay at all</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>name</code></td><td><span class="sig">void name(String t)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setPrice</code></td><td><span class="sig">void setPrice(int cents, boolean couldPay)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>decide</code></td><td><span class="sig">void decide(String move)</span></td><td class="desc">Record one pre-decided Game-Engineering move.</td></tr>
<tr><td><code>moveAt</code></td><td><span class="sig">String moveAt(int i)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moves</code></td><td><span class="sig">int moves()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>paid</code></td><td><span class="sig">boolean paid()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>price</code></td><td><span class="sig">int price()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>yn</code></td><td><span class="sig">String yn(boolean v)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="diceroll">DiceRoll <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/DiceRoll.sleela)</span></h2>
<div data-u="diceroll diceroll">
<h3 id="DiceRoll">DiceRoll <span class="pill">class</span></h3>
<p class="desc">Defines DiceRoll, the deterministic percent-roller at the heart of the gameplay package. Every "80% then 20%" and "50/50" in a turn is a DiceRoll. It is a seeded linear-congruential generator, so a given seed always replays the same game — the archive must repeat, even the luck. DiceRoll is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It holds a single 32-bit-ish state word and advances it on every roll. No native randomness is used; "live play" is modeled by advancing the same deterministic stream. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "DiceRoll"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>MODULUS</code></td><td><span class="sig">static final int MODULUS = 2147483647</span></td><td class="desc">2^31 - 1, a classic LCG modulus</td></tr>
<tr><td><code>MULT</code></td><td><span class="sig">static final int MULT = 48271</span></td><td class="desc">MINSTD multiplier</td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>state</code></td><td><span class="sig">int state</span></td><td class="desc">current generator state, 1..MODULUS-1</td></tr>
<tr><td><code>rollCount</code></td><td><span class="sig">int rollCount</span></td><td class="desc">how many rolls this stream has produced</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>seed</code></td><td><span class="sig">void seed(int s)</span></td><td class="desc">Seed the stream. The same seed replays the same sequence, every time.</td></tr>
<tr><td><code>next</code></td><td><span class="sig">int next()</span></td><td class="desc">Advance and return the next raw value in 1..MODULUS-1.</td></tr>
<tr><td><code>percent</code></td><td><span class="sig">int percent()</span></td><td class="desc">A percentage result in 0..99 for the next step of play.</td></tr>
<tr><td><code>rollUnder</code></td><td><span class="sig">boolean rollUnder(int chance)</span></td><td class="desc">Roll against a target: returns true when the roll "succeeds" at `chance` percent. chance<=0 never succeeds; chance>=100 always does.</td></tr>
<tr><td><code>coinFlip</code></td><td><span class="sig">boolean coinFlip()</span></td><td class="desc">The 50/50 your "ask for help" move leans on.</td></tr>
<tr><td><code>between</code></td><td><span class="sig">int between(int lo, int hi)</span></td><td class="desc">A value in [lo, hi] inclusive, for picking amounts and indices.</td></tr>
<tr><td><code>rolls</code></td><td><span class="sig">int rolls()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="expectedfuture">ExpectedFuture <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/ExpectedFuture.sleela)</span></h2>
<div data-u="expectedfuture expectedfuture">
<h3 id="ExpectedFuture">ExpectedFuture <span class="pill">class</span></h3>
<p class="desc">Defines ExpectedFuture, the forward-looking projection the Inference Engine shows a Player on a winning "ask for help" roll. It answers the one question move (b) exists to answer: am I on schedule in my own custom game? It holds a projected turn, a target turn, and the gap between. ExpectedFuture is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is produced by InferenceEngine; a Player reads onSchedule() and the projected end to decide whether to push, coast, or panic (professionally). Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "ExpectedFuture"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>currentTurn</code></td><td><span class="sig">int currentTurn</span></td><td class="desc">where the player is now</td></tr>
<tr><td><code>projectedEnd</code></td><td><span class="sig">int projectedEnd</span></td><td class="desc">when, at this pace, they finish</td></tr>
<tr><td><code>targetTurn</code></td><td><span class="sig">int targetTurn</span></td><td class="desc">when the custom game says they SHOULD finish</td></tr>
<tr><td><code>confidence</code></td><td><span class="sig">int confidence</span></td><td class="desc">0..100, how sure the engine is</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>project</code></td><td><span class="sig">void project(int now, int projected, int target, int conf)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>scheduleGap</code></td><td><span class="sig">int scheduleGap()</span></td><td class="desc">Negative = ahead of schedule, 0 = exactly on, positive = behind.</td></tr>
<tr><td><code>onSchedule</code></td><td><span class="sig">boolean onSchedule()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>behind</code></td><td><span class="sig">boolean behind()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>turnsRemaining</code></td><td><span class="sig">int turnsRemaining()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>confidenceScore</code></td><td><span class="sig">int confidenceScore()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>yn</code></td><td><span class="sig">String yn(boolean v)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="gamemove">GameMove <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/GameMove.sleela)</span></h2>
<div data-u="gamemove gamemove">
<h3 id="GameMove">GameMove <span class="pill">class</span></h3>
<p class="desc">Defines GameMove, the base contract for the three moves a Player may make on a turn: (a) create a help index / friend, (b) ask for help or new routes, (c) create a new desire. A developer adds a move by subclassing GameMove and overriding resolve(), which rolls the dice and returns a MoveOutcome. The base owns identity, the shared context, and the module contract — exactly the base/subclass pattern used by lib/compiler. GameMove is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). A move is handed the shared engine and roller through bind(); resolve() does the rest. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "GameMove"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>CHOICE_HELP_INDEX</code></td><td><span class="sig">static final int CHOICE_HELP_INDEX = 1</span></td><td class="desc">The three move choices a turn offers. (a) create a help index / friend</td></tr>
<tr><td><code>CHOICE_ASK_HELP</code></td><td><span class="sig">static final int CHOICE_ASK_HELP = 2</span></td><td class="desc">(b) ask for help or new routes</td></tr>
<tr><td><code>CHOICE_NEW_DESIRE</code></td><td><span class="sig">static final int CHOICE_NEW_DESIRE = 3</span></td><td class="desc">(c) create a new desire</td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moveName</code></td><td><span class="sig">String moveName</span></td><td class="desc">human-readable move name</td></tr>
<tr><td><code>choice</code></td><td><span class="sig">int choice</span></td><td class="desc">one of CHOICE_*</td></tr>
<tr><td><code>dice</code></td><td><span class="sig">DiceRoll dice</span></td><td class="desc">the shared roller for this turn</td></tr>
<tr><td><code>engine</code></td><td><span class="sig">InferenceEngine engine</span></td><td class="desc">the shared modeler for this turn</td></tr>
<tr><td><code>turnNumber</code></td><td><span class="sig">int turnNumber</span></td><td class="desc">which turn this move is being played on</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>declare</code></td><td><span class="sig">void declare(String name, int whichChoice)</span></td><td class="desc">A subclass calls this to declare its identity.</td></tr>
<tr><td><code>bind</code></td><td><span class="sig">void bind(DiceRoll roller, InferenceEngine inf, int turn)</span></td><td class="desc">Bind the shared turn context before resolve().</td></tr>
<tr><td><code>resolve</code></td><td><span class="sig">MoveOutcome resolve(Player p)</span></td><td class="desc">Overridable: run the move and return its outcome. The base move does nothing and reports failure, so an un-overridden move is honest.</td></tr>
<tr><td><code>name</code></td><td><span class="sig">String name()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>choiceKind</code></td><td><span class="sig">int choiceKind()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="gameturn">GameTurn <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/GameTurn.sleela)</span></h2>
<div data-u="gameturn gameturn">
<h3 id="GameTurn">GameTurn <span class="pill">class</span></h3>
<p class="desc">Defines GameTurn, the orchestrator that runs one turn of the gameplay package. It holds the shared DiceRoll and InferenceEngine, offers the Player a choice of the three moves — (a) help index / friend, (b) ask for help / new routes, (c) create a new desire — binds the chosen move to the turn context, resolves it, and applies the resulting MoveOutcome to the Player. GameTurn is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). One GameTurn can be reused across many turns; it increments its own turn counter each time play() runs. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "GameTurn"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>dice</code></td><td><span class="sig">DiceRoll dice</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>engine</code></td><td><span class="sig">InferenceEngine engine</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>turnNumber</code></td><td><span class="sig">int turnNumber</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>lastOutcome</code></td><td><span class="sig">MoveOutcome lastOutcome</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure(int seed, int targetTurn)</span></td><td class="desc">Configure the shared roller seed and the custom game's target turn.</td></tr>
<tr><td><code>play</code></td><td><span class="sig">MoveOutcome play(Player p, GameMove move)</span></td><td class="desc">Play one turn: bind the chosen move, resolve it, apply it to the player. The move is any GameMove subclass, already set up by the caller.</td></tr>
<tr><td><code>turn</code></td><td><span class="sig">int turn()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>roller</code></td><td><span class="sig">DiceRoll roller()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>inference</code></td><td><span class="sig">InferenceEngine inference()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>latest</code></td><td><span class="sig">MoveOutcome latest()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="helpindexmove">HelpIndexMove <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/HelpIndexMove.sleela)</span></h2>
<div data-u="helpindexmove helpindexmove">
<h3 id="HelpIndexMove">HelpIndexMove <span class="pill">class</span> <span class="muted">extends <code>GameMove</code></span></h3>
<p class="desc">Move (a) — create a help index or a friend. It generally plays as an 80% roll, then a 20% roll. On the first (80%) roll you build the index and bank solid experience; on the rarer second (20%) roll you also pull the BETTER player's index and your boss's deeper understanding. Each reward is a subevent resolved on its own percentage, live-play, so no two turns feel identical even on the same seed stream. A concrete GameMove: override resolve() to roll and fill a MoveOutcome. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>resolve</code></td><td><span class="sig">MoveOutcome resolve(Player p)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="inferenceengine">InferenceEngine <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/InferenceEngine.sleela)</span></h2>
<div data-u="inferenceengine inferenceengine">
<h3 id="InferenceEngine">InferenceEngine <span class="pill">class</span></h3>
<p class="desc">Defines InferenceEngine, the in-game modeler that projects a Player's Expected Future and, when the player instead gets the Boss's help, assembles a DetailedReport with some Game-Engineering moves already decided. This is the brain behind move (b), "ask for help or new routes". InferenceEngine is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is deterministic: given the same player state and turn, it projects the same future and decides the same moves, so a replayed game infers identically. It names, but does not depend on, the lib/inference-model package family. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "InferenceEngine"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>targetTurn</code></td><td><span class="sig">int targetTurn</span></td><td class="desc">the custom game's intended finishing turn</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>setTarget</code></td><td><span class="sig">void setTarget(int turn)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>model</code></td><td><span class="sig">ExpectedFuture model(Player p, int now)</span></td><td class="desc">Project the Player's Expected Future at `now`. Pace is driven by the player's experience: more experience finishes sooner. Confidence rises with the player's Person/Citizen quality — a clearer person is easier to model.</td></tr>
<tr><td><code>brief</code></td><td><span class="sig">DetailedReport brief(Player p, int baseCostCents)</span></td><td class="desc">Assemble the Boss's DetailedReport: concrete Game-Engineering moves already chosen for the player, priced by the player's own quality. The player pays (or cannot), and that is recorded on the report.</td></tr>
<tr><td><code>target</code></td><td><span class="sig">int target()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="managementcourtroom">ManagementCourtroom <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/ManagementCourtroom.sleela)</span></h2>
<div data-u="managementcourtroom managementcourtroom">
<h3 id="ManagementCourtroom">ManagementCourtroom <span class="pill">class</span></h3>
<p class="desc">Defines ManagementCourtroom, the ledger of a Player's standing — the file, tact, and rolls they have accumulated by playing well. Move (c), "create a new desire", is the main way a Player earns a seat here. ManagementCourtroom is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is pure state: three counters that only ever go up through honest play, and a derived "standing" so a Player knows where they sit in the room. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "ManagementCourtroom"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>file</code></td><td><span class="sig">int file</span></td><td class="desc">documented leverage: evidence, memos, the paper trail</td></tr>
<tr><td><code>tact</code></td><td><span class="sig">int tact</span></td><td class="desc">social capital: knowing what to say and when</td></tr>
<tr><td><code>rolls</code></td><td><span class="sig">int rolls</span></td><td class="desc">banked extra rolls the player can spend on future turns</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addFile</code></td><td><span class="sig">void addFile(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addTact</code></td><td><span class="sig">void addTact(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addRolls</code></td><td><span class="sig">void addRolls(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>spendRoll</code></td><td><span class="sig">boolean spendRoll()</span></td><td class="desc">Spend a banked roll, if any. Returns true if one was available.</td></tr>
<tr><td><code>fileCount</code></td><td><span class="sig">int fileCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>tactCount</code></td><td><span class="sig">int tactCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>rollCount</code></td><td><span class="sig">int rollCount()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>standing</code></td><td><span class="sig">int standing()</span></td><td class="desc">Overall standing in the room: the three holdings, weighted. Tact talks loudest, file carries weight, banked rolls are nice to have.</td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="moveoutcome">MoveOutcome <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/MoveOutcome.sleela)</span></h2>
<div data-u="moveoutcome moveoutcome">
<h3 id="MoveOutcome">MoveOutcome <span class="pill">class</span></h3>
<p class="desc">Defines MoveOutcome, the result record every GameMove returns — what happened on this turn, in a form the game loop and the player can both read. It carries a headline, whether the move succeeded, and the concrete gains (experience, cash, file/tact/rolls) the move produced. MoveOutcome is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It is a plain carrier: moves fill it in, the turn applies it to the Player, and describe() narrates it. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "MoveOutcome"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moveName</code></td><td><span class="sig">String moveName</span></td><td class="desc">which move produced this</td></tr>
<tr><td><code>headline</code></td><td><span class="sig">String headline</span></td><td class="desc">one-line summary of what happened</td></tr>
<tr><td><code>success</code></td><td><span class="sig">boolean success</span></td><td class="desc">did the move land?</td></tr>
<tr><td><code>xpGain</code></td><td><span class="sig">int xpGain</span></td><td class="desc">experience granted</td></tr>
<tr><td><code>cashGain</code></td><td><span class="sig">int cashGain</span></td><td class="desc">cash granted (net; may be 0)</td></tr>
<tr><td><code>fileGain</code></td><td><span class="sig">int fileGain</span></td><td class="desc">courtroom file granted</td></tr>
<tr><td><code>tactGain</code></td><td><span class="sig">int tactGain</span></td><td class="desc">courtroom tact granted</td></tr>
<tr><td><code>rollsGain</code></td><td><span class="sig">int rollsGain</span></td><td class="desc">courtroom rolls granted</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>begin</code></td><td><span class="sig">void begin(String move)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>say</code></td><td><span class="sig">void say(String line)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>succeed</code></td><td><span class="sig">void succeed()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addXp</code></td><td><span class="sig">void addXp(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addCash</code></td><td><span class="sig">void addCash(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addFile</code></td><td><span class="sig">void addFile(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addTact</code></td><td><span class="sig">void addTact(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>addRolls</code></td><td><span class="sig">void addRolls(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>applyTo</code></td><td><span class="sig">void applyTo(Player p)</span></td><td class="desc">Apply everything this outcome granted to a Player, in one shot.</td></tr>
<tr><td><code>landed</code></td><td><span class="sig">boolean landed()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>move</code></td><td><span class="sig">String move()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>summary</code></td><td><span class="sig">String summary()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>yn</code></td><td><span class="sig">String yn(boolean v)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="newdesiremove">NewDesireMove <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/NewDesireMove.sleela)</span></h2>
<div data-u="newdesiremove newdesiremove">
<h3 id="NewDesireMove">NewDesireMove <span class="pill">class</span> <span class="muted">extends <code>GameMove</code></span></h3>
<p class="desc">Move (c) — create a new desire. You review a slate of likeable, medium portfolio decisions across realistic industries. Reviewing them earns you standing in your Management Courtroom — file, tact, or banked rolls — and the decision you back resolves into profit and a futures read. The game's one law applies: big bets are always winners, where you find them. So when a BIG one shows up, bet big. A concrete GameMove: override resolve() to offer the slate, grant courtroom standing, and resolve the chosen bet into profit. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>chosen</code></td><td><span class="sig">PortfolioDecision chosen</span></td><td class="desc">the decision the player backed</td></tr>
<tr><td><code>futuresOutlook</code></td><td><span class="sig">int futuresOutlook</span></td><td class="desc">a simple futures read, derived from the result</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>setUp</code></td><td><span class="sig">void setUp()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>resolve</code></td><td><span class="sig">MoveOutcome resolve(Player p)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>offer</code></td><td><span class="sig">PortfolioDecision offer(String industry, int stake, int winPct, int multX10, int size)</span></td><td class="desc">Build one offered decision bound to the player's industry slate.</td></tr>
<tr><td><code>expected</code></td><td><span class="sig">int expected(PortfolioDecision d)</span></td><td class="desc">Expected value of a (non-guaranteed) decision, in cents, for comparison: win% * (stake*mult/10 - stake) - (100-win%)*stake, scaled down by 100.</td></tr>
<tr><td><code>backed</code></td><td><span class="sig">PortfolioDecision backed()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>futures</code></td><td><span class="sig">int futures()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="player">Player <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/Player.sleela)</span></h2>
<div data-u="player player">
<h3 id="Player">Player <span class="pill">class</span></h3>
<p class="desc">Defines Player, the actor who takes a turn in the gameplay package. A Player carries experience, a Person/Citizen quality score (which sets the price they pay for information), cash, and the three things a turn can grant them — file, tact, and rolls — plus a Management Courtroom to keep them in. Player is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). The quality score is the hinge of move (b): a higher-quality Person/Citizen is charged more for the Inference Engine's information, because good information finds the people who can use it. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "Player"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>handle</code></td><td><span class="sig">String handle</span></td><td class="desc">the player's name at the table</td></tr>
<tr><td><code>experience</code></td><td><span class="sig">int experience</span></td><td class="desc">more experience per turn is the whole point</td></tr>
<tr><td><code>quality</code></td><td><span class="sig">int quality</span></td><td class="desc">Person/Citizen quality, 0..100 (sets info price)</td></tr>
<tr><td><code>cashCents</code></td><td><span class="sig">int cashCents</span></td><td class="desc">what they can spend on reports</td></tr>
<tr><td><code>bossUnderstanding</code></td><td><span class="sig">int bossUnderstanding</span></td><td class="desc">0..100 — how much the boss "gets" them this turn</td></tr>
<tr><td><code>courtroom</code></td><td><span class="sig">ManagementCourtroom courtroom</span></td><td class="desc">where file / tact / rolls accumulate</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>introduce</code></td><td><span class="sig">void introduce(String name, int startQuality, int startCash)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>gainExperience</code></td><td><span class="sig">void gainExperience(int xp)</span></td><td class="desc">--- turn rewards -------------------------------------------------------</td></tr>
<tr><td><code>raiseBossUnderstanding</code></td><td><span class="sig">void raiseBossUnderstanding(int d)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>infoPriceCents</code></td><td><span class="sig">int infoPriceCents(int baseCents)</span></td><td class="desc">The price of information scales with the Player's own quality: a better Person/Citizen pays more, because the report is worth more to them.</td></tr>
<tr><td><code>payForInfo</code></td><td><span class="sig">boolean payForInfo(int baseCents)</span></td><td class="desc">Try to pay for information. Returns true if the player could afford it.</td></tr>
<tr><td><code>earn</code></td><td><span class="sig">void earn(int cents)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>gainFile</code></td><td><span class="sig">void gainFile(int n)</span></td><td class="desc">Convenience pass-throughs to the courtroom.</td></tr>
<tr><td><code>gainTact</code></td><td><span class="sig">void gainTact(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>gainRolls</code></td><td><span class="sig">void gainRolls(int n)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>xp</code></td><td><span class="sig">int xp()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>qualityScore</code></td><td><span class="sig">int qualityScore()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>cash</code></td><td><span class="sig">int cash()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>bossRapport</code></td><td><span class="sig">int bossRapport()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>management</code></td><td><span class="sig">ManagementCourtroom management()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>name</code></td><td><span class="sig">String name()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>clamp</code></td><td><span class="sig">int clamp(int v)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="portfoliodecision">PortfolioDecision <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/PortfolioDecision.sleela)</span></h2>
<div data-u="portfoliodecision portfoliodecision">
<h3 id="PortfolioDecision">PortfolioDecision <span class="pill">class</span></h3>
<p class="desc">Defines PortfolioDecision, one likeable, medium-sized bet on a realistic industry that a Player reviews during move (c), "create a new desire". Each decision has an industry, a stake, a win chance, and a multiplier — and a size, because the game's one law is: big bets are always winners, where you find them. Bet big. PortfolioDecision is a NATURAL / LOADABLE MODULE sharing the common module contract (load / loaded / moduleName / describe). It models the bet and resolves it against a DiceRoll into a profit, but it does not touch the Player directly; the move that owns it decides what to do with the result. Family: gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>MODULE</code></td><td><span class="sig">static final String MODULE = "PortfolioDecision"</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>SIZE_SMALL</code></td><td><span class="sig">static final int SIZE_SMALL = 0</span></td><td class="desc">Bet sizes. "Big" is special: in this game a found big bet always pays.</td></tr>
<tr><td><code>SIZE_MEDIUM</code></td><td><span class="sig">static final int SIZE_MEDIUM = 1</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>SIZE_BIG</code></td><td><span class="sig">static final int SIZE_BIG = 2</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>loadedFlag</code></td><td><span class="sig">int loadedFlag</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>industry</code></td><td><span class="sig">String industry</span></td><td class="desc">e.g. "Energy", "Logistics", "Healthcare"</td></tr>
<tr><td><code>stakeCents</code></td><td><span class="sig">int stakeCents</span></td><td class="desc">what the player puts in</td></tr>
<tr><td><code>winPercent</code></td><td><span class="sig">int winPercent</span></td><td class="desc">base chance the bet pays (0..100)</td></tr>
<tr><td><code>multiplierX10</code></td><td><span class="sig">int multiplierX10</span></td><td class="desc">payout multiple x10 (so 25 = 2.5x), on a win</td></tr>
<tr><td><code>size</code></td><td><span class="sig">int size</span></td><td class="desc">one of SIZE_*</td></tr>
<tr><td><code>resolved</code></td><td><span class="sig">boolean resolved</span></td><td class="desc">whether resolve() has run</td></tr>
<tr><td><code>won</code></td><td><span class="sig">boolean won</span></td><td class="desc">the outcome, once resolved</td></tr>
<tr><td><code>profitCents</code></td><td><span class="sig">int profitCents</span></td><td class="desc">net profit (payout - stake) once resolved</td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>load</code></td><td><span class="sig">void load()</span></td><td class="desc">--- loadable-module contract ------------------------------------------</td></tr>
<tr><td><code>loaded</code></td><td><span class="sig">boolean loaded()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>moduleName</code></td><td><span class="sig">String moduleName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>offer</code></td><td><span class="sig">void offer(String ind, int stake, int winChance, int multX10, int betSize)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isGuaranteed</code></td><td><span class="sig">boolean isGuaranteed()</span></td><td class="desc">The game's one law: a BIG bet, once you've found it, always wins. Smaller bets must roll under their win chance like everyone else.</td></tr>
<tr><td><code>effectiveWinPercent</code></td><td><span class="sig">int effectiveWinPercent()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>resolve</code></td><td><span class="sig">int resolve(DiceRoll dice)</span></td><td class="desc">Resolve the bet against a roller. Profit = payout - stake on a win, else the stake is lost. Big bets always land, so bet big where you find them.</td></tr>
<tr><td><code>industryName</code></td><td><span class="sig">String industryName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>stake</code></td><td><span class="sig">int stake()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>multiplierTimesTen</code></td><td><span class="sig">int multiplierTimesTen()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>betSize</code></td><td><span class="sig">int betSize()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>isResolved</code></td><td><span class="sig">boolean isResolved()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>didWin</code></td><td><span class="sig">boolean didWin()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>profit</code></td><td><span class="sig">int profit()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>sizeName</code></td><td><span class="sig">String sizeName()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>yn</code></td><td><span class="sig">String yn(boolean v)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>describe</code></td><td><span class="sig">String describe()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<h2 class="section" data-u="slpackage">SLPackage <span class="pill syntax">#sleela 2.5</span> <span class="muted" style="font-size:13px">(lib/gameplay/SLPackage.sleela)</span></h2>
<div data-u="slpackage slpackage">
<h3 id="SLPackage">SLPackage <span class="pill">class</span></h3>
<p class="desc">Defines the SLeeLa standard-library package for gameplay.</p>
<div class="meta-note">Carries the standard <strong>Metadata Class record</strong> — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.</div>
<p class="muted"><strong>Fields</strong> — the named values this unit stores.</p>
<table class="members"><tr><th>Field</th><th>Declaration</th><th>What it holds</th></tr>
<tr><td><code>packageName</code></td><td><span class="sig">String packageName</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
<p class="muted"><strong>Methods</strong> — the actions this unit can perform.</p>
<table class="members"><tr><th>Method</th><th>Signature</th><th>What it does</th></tr>
<tr><td><code>configure</code></td><td><span class="sig">void configure(String name)</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>name</code></td><td><span class="sig">String name()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
<tr><td><code>available</code></td><td><span class="sig">boolean available()</span></td><td class="desc"><span class="muted">No description in source.</span></td></tr>
</table>
</div>
<script>function flt(q){q=q.toLowerCase();document.querySelectorAll('[data-u]').forEach(function(el){el.style.display = el.getAttribute('data-u').indexOf(q)>=0||q==''?'':'none';});}</script>
<footer>
Generated by <code>tools/generate-sleeladoc-api.py</code> from the live
<code>/lib</code> tree on 2026-11-05 06:10 UTC.
SleelaDoc — the SLeeLa documentation brand. SLeeLa — MEARVK LLC · Max Rupplin · UNCW, NCSU, Harvard · 2026 · George Soros 2507-2608.
</footer>
</main>
</div>
</body>
</html>