317 lines
14 KiB
HTML
317 lines
14 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>StarterAlgo (algo API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: com.c1games.terminal.starteralgo, class: StarterAlgo">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
|
|
</head>
|
|
<body class="class-declaration">
|
|
<script type="text/javascript">var data = {"i0":10,"i1":9,"i2":10,"i3":10};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<header role="banner">
|
|
<nav role="navigation">
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.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">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navListSearch"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
</nav>
|
|
</header>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<main role="main">
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.c1games.terminal.starteralgo</a></div>
|
|
<h1 title="Class StarterAlgo" class="title">Class StarterAlgo</h1>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance">com.c1games.terminal.starteralgo.StarterAlgo</div>
|
|
</div>
|
|
<section class="description">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="../algo/io/GameLoop.html" title="interface in com.c1games.terminal.algo.io">GameLoop</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">StarterAlgo</span>
|
|
extends java.lang.Object
|
|
implements <a href="../algo/io/GameLoop.html" title="interface in com.c1games.terminal.algo.io">GameLoop</a></pre>
|
|
<div class="block">Java implementation of the standard starter algo.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li class="blockList">
|
|
<section class="constructorSummary"><a id="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Constructor Summary</h2>
|
|
<div class="memberSummary">
|
|
<table>
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">StarterAlgo</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="methodSummary"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Summary</h2>
|
|
<div class="memberSummary">
|
|
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
|
|
<div id="memberSummary_tabpanel" role="tabpanel">
|
|
<table aria-labelledby="t0">
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor" id="i0">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initialize(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.Config)">initialize</a></span>​(<a href="../algo/GameIO.html" title="interface in com.c1games.terminal.algo">GameIO</a> io,
|
|
<a href="../algo/Config.html" title="class in com.c1games.terminal.algo">Config</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Callback for receiving the config data at the beginning of the game.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i1">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#main(java.lang.String%5B%5D)">main</a></span>​(java.lang.String[] args)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="altColor" id="i2">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onActionFrame(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.map.GameState)">onActionFrame</a></span>​(<a href="../algo/GameIO.html" title="interface in com.c1games.terminal.algo">GameIO</a> io,
|
|
<a href="../algo/map/GameState.html" title="class in com.c1games.terminal.algo.map">GameState</a> move)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Save process action frames.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i3">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onTurn(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.map.GameState)">onTurn</a></span>​(<a href="../algo/GameIO.html" title="interface in com.c1games.terminal.algo">GameIO</a> io,
|
|
<a href="../algo/map/GameState.html" title="class in com.c1games.terminal.algo.map">GameState</a> move)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Make a move in the game.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a><code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li class="blockList">
|
|
<section class="constructorDetails"><a id="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Constructor Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="<init>()">StarterAlgo</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">StarterAlgo</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li class="blockList">
|
|
<section class="methodDetails"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="main(java.lang.String[])">main</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">void</span> <span class="memberName">main</span>​(<span class="arguments">java.lang.String[] args)</span></div>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="initialize(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.Config)">initialize</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">initialize</span>​(<span class="arguments"><a href="../algo/GameIO.html" title="interface in com.c1games.terminal.algo">GameIO</a> io,
|
|
<a href="../algo/Config.html" title="class in com.c1games.terminal.algo">Config</a> config)</span></div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../algo/io/GameLoop.html#initialize(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.Config)">GameLoop</a></code></span></div>
|
|
<div class="block">Callback for receiving the config data at the beginning of the game. Not all algos will have a reason
|
|
to process this.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../algo/io/GameLoop.html#initialize(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.Config)">initialize</a></code> in interface <code><a href="../algo/io/GameLoop.html" title="interface in com.c1games.terminal.algo.io">GameLoop</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="onTurn(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.map.GameState)">onTurn</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">onTurn</span>​(<span class="arguments"><a href="../algo/GameIO.html" title="interface in com.c1games.terminal.algo">GameIO</a> io,
|
|
<a href="../algo/map/GameState.html" title="class in com.c1games.terminal.algo.map">GameState</a> move)</span></div>
|
|
<div class="block">Make a move in the game.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../algo/io/GameLoop.html#onTurn(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.map.GameState)">onTurn</a></code> in interface <code><a href="../algo/io/GameLoop.html" title="interface in com.c1games.terminal.algo.io">GameLoop</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="onActionFrame(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.map.GameState)">onActionFrame</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">onActionFrame</span>​(<span class="arguments"><a href="../algo/GameIO.html" title="interface in com.c1games.terminal.algo">GameIO</a> io,
|
|
<a href="../algo/map/GameState.html" title="class in com.c1games.terminal.algo.map">GameState</a> move)</span></div>
|
|
<div class="block">Save process action frames. Careful there are many action frames per turn!</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../algo/io/GameLoop.html#onActionFrame(com.c1games.terminal.algo.GameIO,com.c1games.terminal.algo.map.GameState)">onActionFrame</a></code> in interface <code><a href="../algo/io/GameLoop.html" title="interface in com.c1games.terminal.algo.io">GameLoop</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</main>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.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">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|