Docs and rebuild

Offroaders123 · Jun 16, 2021 · 68bc218 · 68bc218
1 parent 2745ac0
commit 68bc218
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -55,6 +55,8 @@ See [history.md](docs/history.md) for changes and migration for each version.
 
 Recent changes:
 
+ * `v0.31`: 
+   * Change the speed of the world with `noa.timeScale`
  * `v0.30`: 
    * Engine now a named class, use `import {Engine} from 'noa-engine'`
    * many performance and size optimizations

diff --git a/dist/src/index.d.ts b/dist/src/index.d.ts
@@ -94,6 +94,14 @@ export class Engine extends EventEmitter {
      * @prop world
      * @type {World}
     */
+    /**
+     * Multiplier for how fast time moves. Setting this to a value other than
+     * `1` will make the game speed up or slow down. Note that can significantly
+     * affect how core systems behave (particularly physics!).
+     *
+     * @prop timeScale
+     * @type {number}
+    */
     /** @internal @prop _paused */
     /** @internal @prop _dragOutsideLock */
     /** @internal @prop _originRebaseDistance */
@@ -148,6 +156,7 @@ export class Engine extends EventEmitter {
     _originRebaseDistance: any;
     positionInCurrentTick: number;
     worldName: string;
+    timeScale: number;
     container: Container;
     tickRate: any;
     maxRenderRate: any;

diff --git a/docs/API/assets/js/search.js b/docs/API/assets/js/search.js
diff --git a/docs/API/classes/index.engine.html b/docs/API/classes/index.engine.html
@@ -161,6 +161,7 @@ <h3>Properties</h3>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="index.engine.html#rendering" class="tsd-kind-icon">rendering</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="index.engine.html#targetedblock" class="tsd-kind-icon">targeted<wbr>Block</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="index.engine.html#tickrate" class="tsd-kind-icon">tick<wbr>Rate</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-class"><a href="index.engine.html#timescale" class="tsd-kind-icon">time<wbr>Scale</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="index.engine.html#vec3" class="tsd-kind-icon">vec3</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="index.engine.html#version" class="tsd-kind-icon">version</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-class"><a href="index.engine.html#world" class="tsd-kind-icon">world</a></li>
@@ -646,6 +647,13 @@ <h3>tick<wbr>Rate</h3>
 					<aside class="tsd-sources">
 					</aside>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
+					<a name="timescale" class="tsd-anchor"></a>
+					<h3>time<wbr>Scale</h3>
+					<div class="tsd-signature tsd-kind-icon">time<wbr>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
+					<aside class="tsd-sources">
+					</aside>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
 					<a name="vec3" class="tsd-anchor"></a>
 					<h3>vec3</h3>
@@ -694,7 +702,7 @@ <h3>_local<wbr>Pick</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in src/index.js:647</li>
+									<li>Defined in src/index.js:661</li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -762,7 +770,7 @@ <h3>add<wbr>Block</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in src/index.js:526</li>
+									<li>Defined in src/index.js:540</li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -871,7 +879,7 @@ <h3>get<wbr>Block</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in src/index.js:509</li>
+									<li>Defined in src/index.js:523</li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -923,7 +931,7 @@ <h3>global<wbr>ToLocal</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in src/index.js:562</li>
+									<li>Defined in src/index.js:576</li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -990,7 +998,7 @@ <h3>local<wbr>ToGlobal</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in src/index.js:591</li>
+									<li>Defined in src/index.js:605</li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -1063,7 +1071,7 @@ <h3>pick</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in src/index.js:622</li>
+									<li>Defined in src/index.js:636</li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -1264,7 +1272,7 @@ <h3>set<wbr>Block</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in src/index.js:518</li>
+									<li>Defined in src/index.js:532</li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -1326,7 +1334,7 @@ <h3>set<wbr>Paused</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in src/index.js:498</li>
+									<li>Defined in src/index.js:512</li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -1457,6 +1465,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
 							<li class=" tsd-kind-property tsd-parent-kind-class">
 								<a href="index.engine.html#tickrate" class="tsd-kind-icon">tick<wbr>Rate</a>
 							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-class">
+								<a href="index.engine.html#timescale" class="tsd-kind-icon">time<wbr>Scale</a>
+							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-class">
 								<a href="index.engine.html#vec3" class="tsd-kind-icon">vec3</a>
 							</li>

diff --git a/docs/API/interfaces/index.pickresult.html b/docs/API/interfaces/index.pickresult.html
@@ -108,7 +108,7 @@ <h3>_local<wbr>Position</h3>
 					<div class="tsd-signature tsd-kind-icon">_local<wbr>Position<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in src/index.js:214</li>
+							<li>Defined in src/index.js:223</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -123,7 +123,7 @@ <h3>normal</h3>
 					<div class="tsd-signature tsd-kind-icon">normal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in src/index.js:213</li>
+							<li>Defined in src/index.js:222</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography tsd-comment-shorttext">
@@ -138,7 +138,7 @@ <h3>position</h3>
 					<div class="tsd-signature tsd-kind-icon">position<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in src/index.js:212</li>
+							<li>Defined in src/index.js:221</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography tsd-comment-shorttext">

diff --git a/docs/history.md b/docs/history.md
@@ -3,6 +3,7 @@
 
 This is a summary of new features and breaking changes in recent `noa` versions.
 
+ * [0.31.0](#0310)
  * [0.30.0](#0300)
  * [0.29.0](#0290)
  * [0.28.0](#0280)
@@ -19,6 +20,11 @@ This is a summary of new features and breaking changes in recent `noa` versions.
 
 ----
 
+### 0.31.0
+
+   * Change the speed of the world with `noa.timeScale`
+
+
 ### 0.30.0
 
    * Engine now a named class, use `import {Engine} from 'noa-engine'`