Skip to content

Commit d831ee0

Browse files
author
Bytekeeper
committed
docs
1 parent 717681e commit d831ee0

File tree

90 files changed

+6054
-73
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+6054
-73
lines changed

‎README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Add the maven repo:
4747
And the dependency:
4848

4949
dependencies {
50-
implementation 'com.github.Bytekeeper:ass:1.0'
50+
implementation 'com.github.Bytekeeper:ass:1.1'
5151
}
5252

5353

@@ -67,7 +67,7 @@ And the dependency:
6767
<dependency>
6868
<groupId>com.github.Bytekeeper</groupId>
6969
<artifactId>ass</artifactId>
70-
<version>1.0</version>
70+
<version>1.1</version>
7171
</dependency>
7272

7373
### JAR file
@@ -84,6 +84,22 @@ The main class is `Simulator`. You can add `Agents` for player A or player B her
8484
After doing that, you can simulate a number of frames (default: 96). Next, you
8585
retrieve the result and check if it's to your liking (some of your units survived?).
8686

87+
```java
88+
BWMirrorAgentFactory factory = new BWMirrorAgentFactory(game);
89+
Simulator simulator = new Builder().build(); // You can also customize the simulator
90+
91+
simulator.addAgentA(factory.of(someOfMyUnit));
92+
simulator.addAgentB(factory.of(someEnemy));
93+
94+
simulator.simulate(240); // Simulate 24 seconds
95+
96+
if (simulatior.getAgentsA().isEmpty()) {
97+
// Uh oh
98+
} else {
99+
// Hurray
100+
}
101+
```
102+
87103
## Features
88104
Simulates:
89105
* Medics
@@ -97,12 +113,12 @@ Simulates:
97113
* Cloaked units
98114
* Splash (Radial, Line and "Bounce" aka Tanks, Lurkers and Mutas)
99115
* Stim, Armor, Weapon, Range and Speed upgrades
100-
* `master`: Effects like plague, lockdown, stasis, dark swarm
101-
* `master`: Frame skipping to improve simulation performance at cost of precision
116+
* Effects like plague, lockdown, stasis, dark swarm
117+
* Frame skipping to improve simulation performance at cost of precision
102118

103119
## Limitations
104120
* Elevation is deemed "constant" within the simulation
105-
* Visibility is ignored (`master`: visibility is "constant" within the simulation)
121+
* Visibility is ignored (visibility is "constant" within the simulation)
106122
* Spellcasters are doing nothing
107123
* Distance mechanism does not match BW's "boxed" distances
108124
* Instant acceleration
@@ -160,7 +176,7 @@ An implementation of the algorithm described here: https://zerowidth.com/2013/05
160176

161177
Generally much faster that a normal A* while still being optimal.
162178

163-
## `Master`-only
179+
## Resource management classes
164180
* GMS class to manage gas, minerals and supply in one value type.
165181
* Can be used to manage existing resources vs cost of units, tech or upgrades
166182

‎docs/allclasses-frame.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 09:39:16 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 18:35:29 CEST 2019 -->
66
<title>All Classes (ass 1.1 API)</title>
77
<meta name="date" content="2019-10-20">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/allclasses-noframe.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 09:39:16 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 18:35:29 CEST 2019 -->
66
<title>All Classes (ass 1.1 API)</title>
77
<meta name="date" content="2019-10-20">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/constant-values.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 09:39:16 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 18:35:29 CEST 2019 -->
66
<title>Constant Field Values (ass 1.1 API)</title>
77
<meta name="date" content="2019-10-20">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/deprecated-list.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 09:39:16 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 18:35:29 CEST 2019 -->
66
<title>Deprecated List (ass 1.1 API)</title>
77
<meta name="date" content="2019-10-20">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/help-doc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 09:39:16 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 18:35:29 CEST 2019 -->
66
<title>API Help (ass 1.1 API)</title>
77
<meta name="date" content="2019-10-20">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/index-all.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 09:39:16 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 18:35:29 CEST 2019 -->
66
<title>Index (ass 1.1 API)</title>
77
<meta name="date" content="2019-10-20">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

‎docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 09:39:16 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 18:35:29 CEST 2019 -->
66
<title>ass 1.1 API</title>
77
<script type="text/javascript">
88
tmpTargetPage = "" + window.location.search;

‎docs/org/bk/ass/PositionOutOfBoundsException.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 09:39:16 CEST 2019 -->
5+
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 18:35:29 CEST 2019 -->
66
<title>PositionOutOfBoundsException (ass 1.1 API)</title>
77
<meta name="date" content="2019-10-20">
88
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

‎docs/org/bk/ass/buildorder/Action.html

Lines changed: 235 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="de">
4+
<head>
5+
<!-- Generated by javadoc (1.8.0_222) on Sun Oct 20 18:35:29 CEST 2019 -->
6+
<title>Action (ass 1.1 API)</title>
7+
<meta name="date" content="2019-10-20">
8+
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9+
<script type="text/javascript" src="../../../../script.js"></script>
10+
</head>
11+
<body>
12+
<script type="text/javascript"><!--
13+
try {
14+
if (location.href.indexOf('is-external=true') == -1) {
15+
parent.document.title="Action (ass 1.1 API)";
16+
}
17+
}
18+
catch(err) {
19+
}
20+
//-->
21+
</script>
22+
<noscript>
23+
<div>JavaScript is disabled on your browser.</div>
24+
</noscript>
25+
<!-- ========= START OF TOP NAVBAR ======= -->
26+
<div class="topNav"><a name="navbar.top">
27+
<!-- -->
28+
</a>
29+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
30+
<a name="navbar.top.firstrow">
31+
<!-- -->
32+
</a>
33+
<ul class="navList" title="Navigation">
34+
<li><a href="../../../../overview-summary.html">Overview</a></li>
35+
<li><a href="package-summary.html">Package</a></li>
36+
<li class="navBarCell1Rev">Class</li>
37+
<li><a href="package-tree.html">Tree</a></li>
38+
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
39+
<li><a href="../../../../index-all.html">Index</a></li>
40+
<li><a href="../../../../help-doc.html">Help</a></li>
41+
</ul>
42+
</div>
43+
<div class="subNav">
44+
<ul class="navList">
45+
<li>Prev&nbsp;Class</li>
46+
<li><a href="../../../../org/bk/ass/buildorder/AgentType.html" title="class in org.bk.ass.buildorder"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
47+
</ul>
48+
<ul class="navList">
49+
<li><a href="../../../../index.html?org/bk/ass/buildorder/Action.html" target="_top">Frames</a></li>
50+
<li><a href="Action.html" target="_top">No&nbsp;Frames</a></li>
51+
</ul>
52+
<ul class="navList" id="allclasses_navbar_top">
53+
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
54+
</ul>
55+
<div>
56+
<script type="text/javascript"><!--
57+
allClassesLink = document.getElementById("allclasses_navbar_top");
58+
if(window==top) {
59+
allClassesLink.style.display = "block";
60+
}
61+
else {
62+
allClassesLink.style.display = "none";
63+
}
64+
//-->
65+
</script>
66+
</div>
67+
<div>
68+
<ul class="subNavList">
69+
<li>Summary:&nbsp;</li>
70+
<li>Nested&nbsp;|&nbsp;</li>
71+
<li>Field&nbsp;|&nbsp;</li>
72+
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
73+
<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
74+
</ul>
75+
<ul class="subNavList">
76+
<li>Detail:&nbsp;</li>
77+
<li>Field&nbsp;|&nbsp;</li>
78+
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
79+
<li>Method</li>
80+
</ul>
81+
</div>
82+
<a name="skip.navbar.top">
83+
<!-- -->
84+
</a></div>
85+
<!-- ========= END OF TOP NAVBAR ========= -->
86+
<!-- ======== START OF CLASS DATA ======== -->
87+
<div class="header">
88+
<div class="subTitle">org.bk.ass.buildorder</div>
89+
<h2 title="Class Action" class="title">Class Action</h2>
90+
</div>
91+
<div class="contentContainer">
92+
<ul class="inheritance">
93+
<li>java.lang.Object</li>
94+
<li>
95+
<ul class="inheritance">
96+
<li>org.bk.ass.buildorder.Action</li>
97+
</ul>
98+
</li>
99+
</ul>
100+
<div class="description">
101+
<ul class="blockList">
102+
<li class="blockList">
103+
<hr>
104+
<br>
105+
<pre>public class <span class="typeNameLabel">Action</span>
106+
extends java.lang.Object</pre>
107+
</li>
108+
</ul>
109+
</div>
110+
<div class="summary">
111+
<ul class="blockList">
112+
<li class="blockList">
113+
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
114+
<ul class="blockList">
115+
<li class="blockList"><a name="constructor.summary">
116+
<!-- -->
117+
</a>
118+
<h3>Constructor Summary</h3>
119+
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
120+
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
121+
<tr>
122+
<th class="colOne" scope="col">Constructor and Description</th>
123+
</tr>
124+
<tr class="altColor">
125+
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/bk/ass/buildorder/Action.html#Action--">Action</a></span>()</code>&nbsp;</td>
126+
</tr>
127+
</table>
128+
</li>
129+
</ul>
130+
<!-- ========== METHOD SUMMARY =========== -->
131+
<ul class="blockList">
132+
<li class="blockList"><a name="method.summary">
133+
<!-- -->
134+
</a>
135+
<h3>Method Summary</h3>
136+
<ul class="blockList">
137+
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
138+
<!-- -->
139+
</a>
140+
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
141+
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
142+
</ul>
143+
</li>
144+
</ul>
145+
</li>
146+
</ul>
147+
</div>
148+
<div class="details">
149+
<ul class="blockList">
150+
<li class="blockList">
151+
<!-- ========= CONSTRUCTOR DETAIL ======== -->
152+
<ul class="blockList">
153+
<li class="blockList"><a name="constructor.detail">
154+
<!-- -->
155+
</a>
156+
<h3>Constructor Detail</h3>
157+
<a name="Action--">
158+
<!-- -->
159+
</a>
160+
<ul class="blockListLast">
161+
<li class="blockList">
162+
<h4>Action</h4>
163+
<pre>public&nbsp;Action()</pre>
164+
</li>
165+
</ul>
166+
</li>
167+
</ul>
168+
</li>
169+
</ul>
170+
</div>
171+
</div>
172+
<!-- ========= END OF CLASS DATA ========= -->
173+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
174+
<div class="bottomNav"><a name="navbar.bottom">
175+
<!-- -->
176+
</a>
177+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
178+
<a name="navbar.bottom.firstrow">
179+
<!-- -->
180+
</a>
181+
<ul class="navList" title="Navigation">
182+
<li><a href="../../../../overview-summary.html">Overview</a></li>
183+
<li><a href="package-summary.html">Package</a></li>
184+
<li class="navBarCell1Rev">Class</li>
185+
<li><a href="package-tree.html">Tree</a></li>
186+
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
187+
<li><a href="../../../../index-all.html">Index</a></li>
188+
<li><a href="../../../../help-doc.html">Help</a></li>
189+
</ul>
190+
</div>
191+
<div class="subNav">
192+
<ul class="navList">
193+
<li>Prev&nbsp;Class</li>
194+
<li><a href="../../../../org/bk/ass/buildorder/AgentType.html" title="class in org.bk.ass.buildorder"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
195+
</ul>
196+
<ul class="navList">
197+
<li><a href="../../../../index.html?org/bk/ass/buildorder/Action.html" target="_top">Frames</a></li>
198+
<li><a href="Action.html" target="_top">No&nbsp;Frames</a></li>
199+
</ul>
200+
<ul class="navList" id="allclasses_navbar_bottom">
201+
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
202+
</ul>
203+
<div>
204+
<script type="text/javascript"><!--
205+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
206+
if(window==top) {
207+
allClassesLink.style.display = "block";
208+
}
209+
else {
210+
allClassesLink.style.display = "none";
211+
}
212+
//-->
213+
</script>
214+
</div>
215+
<div>
216+
<ul class="subNavList">
217+
<li>Summary:&nbsp;</li>
218+
<li>Nested&nbsp;|&nbsp;</li>
219+
<li>Field&nbsp;|&nbsp;</li>
220+
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
221+
<li><a href="#methods.inherited.from.class.java.lang.Object">Method</a></li>
222+
</ul>
223+
<ul class="subNavList">
224+
<li>Detail:&nbsp;</li>
225+
<li>Field&nbsp;|&nbsp;</li>
226+
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
227+
<li>Method</li>
228+
</ul>
229+
</div>
230+
<a name="skip.navbar.bottom">
231+
<!-- -->
232+
</a></div>
233+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
234+
</body>
235+
</html>

0 commit comments

Comments
 (0)