Leahnaya/asphyxia-core.github.io
1
0
Fork 0
mirror of https://github.com/asphyxia-core/asphyxia-core.github.io.git synced 2026-07-04 17:56:54 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

update v1.19

Browse Source
This commit is contained in:
Freddie Wang 2020-12-03 14:12:33 +08:00
parent 8426673241
commit f84d82e636
18 changed files with 621 additions and 2938 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
index.md
View File

@ -16,13 +16,13 @@ This is a "e-amuse emulator".
## FAQ
- Does it supports the X game.
- Asphyxia CORE have no game support out of the box.
- Please checkout the [community plugins](https://github.com/asphyxia-core/asphyxia-core.github.io/releases) for game support or find some other plugins
- Please checkout [community plugins](https://github.com/asphyxia-core/asphyxia-core.github.io/releases) for game support or find some other plugins
- Can I run Asphyxia on cabinet
- Asphyxia CORE can only ran on Windows 7 or newer, and we do not have any plans for Windows XP support.
- Also, Asphyxia CORE is ram heavy. Depends on the plugins, it may takes up 60MB ~ 400MB of memory.
- It is recommended to setup a dedicated small server box.
- Can I have more than 16 profiles
- Well, that means you have more than 15 friends irl that have similar interests. Congratulations.
- Well, that means you have more than 15 friends irl who have similar interests. Congratulations.
- But unfortunately the profile limit is in place to prevent commercial or malicious usage. You can, for some additional effort, swap in and out your save files or use multiple instances of CORE.
- Open-source?
- The plugins are always open-source in nature.

2680
typedoc/assets/css/main.css
View File

File diff suppressed because one or more lines are too long

52
typedoc/assets/js/main.js
View File

File diff suppressed because one or more lines are too long

2
typedoc/assets/js/search.json
View File

File diff suppressed because one or more lines are too long

196
typedoc/classes/kdatareader.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>KDataReader | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>KDataReader | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -126,7 +126,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L318">asphyxia-core.d.ts:318</a></li>
<li>Defined in asphyxia-core.d.ts:321</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -148,7 +148,7 @@
<div class="tsd-signature tsd-kind-icon">obj<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L318">asphyxia-core.d.ts:318</a></li>
<li>Defined in asphyxia-core.d.ts:321</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -170,7 +170,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L351">asphyxia-core.d.ts:351</a></li>
<li>Defined in asphyxia-core.d.ts:354</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -179,23 +179,23 @@
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">tag</span> <span class="hljs-attr">status</span>=<span class="hljs-string">"1"</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">tag</span> <span class="hljs-attr">status</span>=<span class="hljs-string">&quot;1&quot;</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">tag</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">tag</span>: K.ATTR({ <span class="hljs-attr">status</span>: <span class="hljs-string">"1"</span> }, {
<span class="hljs-attr">tag</span>: K.ATTR({ <span class="hljs-attr">status</span>: <span class="hljs-string">&quot;1&quot;</span> }, {
<span class="hljs-attr">inner</span>: [
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>),
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">1</span>),
K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">2</span>)
]
})
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).attr(<span class="hljs-string">"tag"</span>) <span class="hljs-comment">// { status: "1" }</span>
$(data).element(<span class="hljs-string">"tag"</span>).attr().status <span class="hljs-comment">// "1"</span>
$(data).attr(<span class="hljs-string">"tag.inner.0"</span>).__type <span class="hljs-comment">// "s32"</span></code></pre>
<pre><code class="language-javascript">$(data).attr(<span class="hljs-string">&quot;tag&quot;</span>) <span class="hljs-comment">// { status: &quot;1&quot; }</span>
$(data).element(<span class="hljs-string">&quot;tag&quot;</span>).attr().status <span class="hljs-comment">// &quot;1&quot;</span>
$(data).attr(<span class="hljs-string">&quot;tag.inner.0&quot;</span>).__type <span class="hljs-comment">// &quot;s32&quot;</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -217,7 +217,7 @@ $(data).attr(<span class="hljs-string">"tag.inner.0"</span>).__type <span class=
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L384">asphyxia-core.d.ts:384</a></li>
<li>Defined in asphyxia-core.d.ts:387</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -226,21 +226,21 @@ $(data).attr(<span class="hljs-string">"tag.inner.0"</span>).__type <span class=
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>&gt;</span>abc<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s64&quot;</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;str&quot;</span>&gt;</span>abc<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">inner</span>: [
K.ITEM(<span class="hljs-string">"s64"</span>, <span class="hljs-number">1n</span>),
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
K.ITEM(<span class="hljs-string">&quot;s64&quot;</span>, <span class="hljs-number">1n</span>),
K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">2</span>)
],
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>)
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">&quot;str&quot;</span>, <span class="hljs-string">&quot;abc&quot;</span>)
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">"inner"</span>).bigint() <span class="hljs-comment">// 1n</span>
$(data).bigint(<span class="hljs-string">"inner.1"</span>) <span class="hljs-comment">// 2n</span>
$(data).bigint(<span class="hljs-string">"invalid"</span>, <span class="hljs-number">3n</span>) <span class="hljs-comment">// 3n</span></code></pre>
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">&quot;inner&quot;</span>).bigint() <span class="hljs-comment">// 1n</span>
$(data).bigint(<span class="hljs-string">&quot;inner.1&quot;</span>) <span class="hljs-comment">// 2n</span>
$(data).bigint(<span class="hljs-string">&quot;invalid&quot;</span>, <span class="hljs-number">3n</span>) <span class="hljs-comment">// 3n</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -269,7 +269,7 @@ $(data).bigint(<span class="hljs-string">"invalid"</span>, <span class="hljs-num
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L410">asphyxia-core.d.ts:410</a></li>
<li>Defined in asphyxia-core.d.ts:413</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -279,16 +279,16 @@ $(data).bigint(<span class="hljs-string">"invalid"</span>, <span class="hljs-num
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>&gt;</span>1 2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>&gt;</span>3 4<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s64&quot;</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">&quot;2&quot;</span>&gt;</span>1 2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">&quot;2&quot;</span>&gt;</span>3 4<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">inner</span>: K.ARRAY(<span class="hljs-string">"s64"</span>, [<span class="hljs-number">1n</span>, <span class="hljs-number">2n</span>]),
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">"s32"</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
<span class="hljs-attr">inner</span>: K.ARRAY(<span class="hljs-string">&quot;s64&quot;</span>, [<span class="hljs-number">1n</span>, <span class="hljs-number">2n</span>]),
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">&quot;s32&quot;</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// [1n, 2n]</span>
$(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span></code></pre>
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// [1n, 2n]</span>
$(data).bigints(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// undefined</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -313,7 +313,7 @@ $(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-co
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L438">asphyxia-core.d.ts:438</a></li>
<li>Defined in asphyxia-core.d.ts:441</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -322,19 +322,19 @@ $(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-co
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"bool"</span>&gt;</span>0<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;bool&quot;</span>&gt;</span>0<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">inner</span>: [
K.ITEM(<span class="hljs-string">"bool"</span>, <span class="hljs-literal">false</span>),
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
K.ITEM(<span class="hljs-string">&quot;bool&quot;</span>, <span class="hljs-literal">false</span>),
K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">2</span>)
]
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).bool(<span class="hljs-string">"inner.0"</span>) <span class="hljs-comment">// false</span>
$(data).bool(<span class="hljs-string">"inner.1"</span>) <span class="hljs-comment">// true</span>
$(data).bool(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// false</span></code></pre>
<pre><code class="language-javascript">$(data).bool(<span class="hljs-string">&quot;inner.0&quot;</span>) <span class="hljs-comment">// false</span>
$(data).bool(<span class="hljs-string">&quot;inner.1&quot;</span>) <span class="hljs-comment">// true</span>
$(data).bool(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// false</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -356,7 +356,7 @@ $(data).bool(<span class="hljs-string">"invalid"</span>) <span class="hljs-comme
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L464">asphyxia-core.d.ts:464</a></li>
<li>Defined in asphyxia-core.d.ts:467</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -366,16 +366,16 @@ $(data).bool(<span class="hljs-string">"invalid"</span>) <span class="hljs-comme
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"bin"</span>&gt;</span>00ff<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"u8"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"3"</span>&gt;</span>1 2 3<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;bin&quot;</span>&gt;</span>00ff<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;u8&quot;</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">&quot;3&quot;</span>&gt;</span>1 2 3<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">"bin"</span>, Buffer.from([<span class="hljs-number">0x00</span>, <span class="hljs-number">0xff</span>])),
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">"u8"</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>])
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">&quot;bin&quot;</span>, Buffer.from([<span class="hljs-number">0x00</span>, <span class="hljs-number">0xff</span>])),
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">&quot;u8&quot;</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>])
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).buffer(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// &lt;Buffer 00 ff&gt;</span>
$(data).buffer(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span></code></pre>
<pre><code class="language-javascript">$(data).buffer(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// &lt;Buffer 00 ff&gt;</span>
$(data).buffer(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// undefined</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -400,7 +400,7 @@ $(data).buffer(<span class="hljs-string">"invalid"</span>) <span class="hljs-com
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L492">asphyxia-core.d.ts:492</a></li>
<li>Defined in asphyxia-core.d.ts:495</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -409,19 +409,19 @@ $(data).buffer(<span class="hljs-string">"invalid"</span>) <span class="hljs-com
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">number</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">number</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">array</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"u8"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"3"</span>&gt;</span>1 2 3<span class="hljs-tag">&lt;/<span class="hljs-name">array</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">string</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>&gt;</span>abc<span class="hljs-tag">&lt;/<span class="hljs-name">string</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">number</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">number</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">array</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;u8&quot;</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">&quot;3&quot;</span>&gt;</span>1 2 3<span class="hljs-tag">&lt;/<span class="hljs-name">array</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">string</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;str&quot;</span>&gt;</span>abc<span class="hljs-tag">&lt;/<span class="hljs-name">string</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">number</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>),
<span class="hljs-attr">array</span>: K.ARRAY(<span class="hljs-string">"u8"</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]),
<span class="hljs-attr">string</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>)
<span class="hljs-attr">number</span>: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">1</span>),
<span class="hljs-attr">array</span>: K.ARRAY(<span class="hljs-string">&quot;u8&quot;</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]),
<span class="hljs-attr">string</span>: K.ITEM(<span class="hljs-string">&quot;str&quot;</span>, <span class="hljs-string">&quot;abc&quot;</span>)
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).content(<span class="hljs-string">"number"</span>) <span class="hljs-comment">// [1]</span>
$(data).content(<span class="hljs-string">"array"</span>) <span class="hljs-comment">// [1, 2, 3]</span>
$(data).content(<span class="hljs-string">"string"</span>) <span class="hljs-comment">// "abc"</span></code></pre>
<pre><code class="language-javascript">$(data).content(<span class="hljs-string">&quot;number&quot;</span>) <span class="hljs-comment">// [1]</span>
$(data).content(<span class="hljs-string">&quot;array&quot;</span>) <span class="hljs-comment">// [1, 2, 3]</span>
$(data).content(<span class="hljs-string">&quot;string&quot;</span>) <span class="hljs-comment">// &quot;abc&quot;</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -446,7 +446,7 @@ $(data).content(<span class="hljs-string">"string"</span>) <span class="hljs-com
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L524">asphyxia-core.d.ts:524</a></li>
<li>Defined in asphyxia-core.d.ts:527</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -456,22 +456,22 @@ $(data).content(<span class="hljs-string">"string"</span>) <span class="hljs-com
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">id</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">id</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">id</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">id</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">inner</span>: [
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>) },
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>) }
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">1</span>) },
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">2</span>) }
]
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// &lt;KDataReader&gt;</span>
$(data).element(<span class="hljs-string">"inner"</span>).obj <span class="hljs-comment">// { id: [object] }</span>
$(data).element(<span class="hljs-string">"inner"</span>).number(<span class="hljs-string">"id"</span>) <span class="hljs-comment">// 1</span></code></pre>
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// &lt;KDataReader&gt;</span>
$(data).element(<span class="hljs-string">&quot;inner&quot;</span>).obj <span class="hljs-comment">// { id: [object] }</span>
$(data).element(<span class="hljs-string">&quot;inner&quot;</span>).number(<span class="hljs-string">&quot;id&quot;</span>) <span class="hljs-comment">// 1</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -493,7 +493,7 @@ $(data).element(<span class="hljs-string">"inner"</span>).number(<span class="hl
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L555">asphyxia-core.d.ts:555</a></li>
<li>Defined in asphyxia-core.d.ts:558</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -503,21 +503,21 @@ $(data).element(<span class="hljs-string">"inner"</span>).number(<span class="hl
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">id</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">id</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">id</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">id</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">id</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">inner</span>: [
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>) },
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>) }
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">1</span>) },
{ <span class="hljs-attr">id</span>: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">2</span>) }
]
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).elements(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// [&lt;KDataReader&gt;, &lt;KDataReader&gt;]</span>
$(data).elements(<span class="hljs-string">"inner"</span>)[<span class="hljs-number">1</span>].number(<span class="hljs-string">"id"</span>) <span class="hljs-comment">// 2</span></code></pre>
<pre><code class="language-javascript">$(data).elements(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// [&lt;KDataReader&gt;, &lt;KDataReader&gt;]</span>
$(data).elements(<span class="hljs-string">&quot;inner&quot;</span>)[<span class="hljs-number">1</span>].number(<span class="hljs-string">&quot;id&quot;</span>) <span class="hljs-comment">// 2</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -539,7 +539,7 @@ $(data).elements(<span class="hljs-string">"inner"</span>)[<span class="hljs-num
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L588">asphyxia-core.d.ts:588</a></li>
<li>Defined in asphyxia-core.d.ts:591</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -548,21 +548,21 @@ $(data).elements(<span class="hljs-string">"inner"</span>)[<span class="hljs-num
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>&gt;</span>abc<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s64&quot;</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;str&quot;</span>&gt;</span>abc<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">inner</span>: [
K.ITEM(<span class="hljs-string">"s64"</span>, <span class="hljs-number">1n</span>),
K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">2</span>)
K.ITEM(<span class="hljs-string">&quot;s64&quot;</span>, <span class="hljs-number">1n</span>),
K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">2</span>)
],
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>)
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">&quot;str&quot;</span>, <span class="hljs-string">&quot;abc&quot;</span>)
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">"inner"</span>).number() <span class="hljs-comment">// 1</span>
$(data).number(<span class="hljs-string">"inner.1"</span>) <span class="hljs-comment">// 2</span>
$(data).number(<span class="hljs-string">"invalid"</span>, <span class="hljs-number">3</span>) <span class="hljs-comment">// 3</span></code></pre>
<pre><code class="language-javascript">$(data).element(<span class="hljs-string">&quot;inner&quot;</span>).number() <span class="hljs-comment">// 1</span>
$(data).number(<span class="hljs-string">&quot;inner.1&quot;</span>) <span class="hljs-comment">// 2</span>
$(data).number(<span class="hljs-string">&quot;invalid&quot;</span>, <span class="hljs-number">3</span>) <span class="hljs-comment">// 3</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -591,7 +591,7 @@ $(data).number(<span class="hljs-string">"invalid"</span>, <span class="hljs-num
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L614">asphyxia-core.d.ts:614</a></li>
<li>Defined in asphyxia-core.d.ts:617</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -601,16 +601,16 @@ $(data).number(<span class="hljs-string">"invalid"</span>, <span class="hljs-num
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s64"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>&gt;</span>1 2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">"2"</span>&gt;</span>3 4<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s64&quot;</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">&quot;2&quot;</span>&gt;</span>1 2<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">&quot;2&quot;</span>&gt;</span>3 4<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">"s64"</span>, [<span class="hljs-number">1n</span>, <span class="hljs-number">2n</span>]),
<span class="hljs-attr">inner</span>: K.ARRAY(<span class="hljs-string">"s32"</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
<span class="hljs-attr">invalid</span>: K.ARRAY(<span class="hljs-string">&quot;s64&quot;</span>, [<span class="hljs-number">1n</span>, <span class="hljs-number">2n</span>]),
<span class="hljs-attr">inner</span>: K.ARRAY(<span class="hljs-string">&quot;s32&quot;</span>, [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>])
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span>
$(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// [3, 4]</span></code></pre>
<pre><code class="language-javascript">$(data).bigints(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// undefined</span>
$(data).bigints(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// [3, 4]</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -635,7 +635,7 @@ $(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comm
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L640">asphyxia-core.d.ts:640</a></li>
<li>Defined in asphyxia-core.d.ts:643</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -645,16 +645,16 @@ $(data).bigints(<span class="hljs-string">"inner"</span>) <span class="hljs-comm
</div>
<p>Example:</p>
<pre><code class="language-xml"><span class="hljs-tag">&lt;<span class="hljs-name">data</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"str"</span>&gt;</span>abc<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">"s32"</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;str&quot;</span>&gt;</span>abc<span class="hljs-tag">&lt;/<span class="hljs-name">inner</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">invalid</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span>&gt;</span>1<span class="hljs-tag">&lt;/<span class="hljs-name">invalid</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">data</span>&gt;</span></code></pre>
<pre><code class="language-javascript"><span class="hljs-keyword">const</span> data = {
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">"str"</span>, <span class="hljs-string">"abc"</span>),
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>)
<span class="hljs-attr">inner</span>: K.ITEM(<span class="hljs-string">&quot;str&quot;</span>, <span class="hljs-string">&quot;abc&quot;</span>),
<span class="hljs-attr">invalid</span>: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">1</span>)
}</code></pre>
<p>Evals:</p>
<pre><code class="language-javascript">$(data).str(<span class="hljs-string">"inner"</span>) <span class="hljs-comment">// "abc"</span>
$(data).str(<span class="hljs-string">"invalid"</span>) <span class="hljs-comment">// undefined</span></code></pre>
<pre><code class="language-javascript">$(data).str(<span class="hljs-string">&quot;inner&quot;</span>) <span class="hljs-comment">// &quot;abc&quot;</span>
$(data).str(<span class="hljs-string">&quot;invalid&quot;</span>) <span class="hljs-comment">// undefined</span></code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@ -741,6 +741,9 @@ $(data).str(<span class="hljs-string">"invalid"</span>) <span class="hljs-commen
<li class=" tsd-kind-interface">
<a href="../interfaces/eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
</li>
@ -790,6 +793,5 @@ $(data).str(<span class="hljs-string">"invalid"</span>) <span class="hljs-commen
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

29
typedoc/globals.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -54,7 +54,7 @@
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>Asphyxia CORE Plugin API</h1>
<h1>Asphyxia CORE Module API</h1>
</div>
</div>
</header>
@ -89,6 +89,7 @@
<li class="tsd-kind-interface"><a href="interfaces/eamuseinfo.html" class="tsd-kind-icon">Eamuse<wbr>Info</a></li>
<li class="tsd-kind-interface"><a href="interfaces/eamusesend.html" class="tsd-kind-icon">Eamuse<wbr>Send</a></li>
<li class="tsd-kind-interface"><a href="interfaces/eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a></li>
<li class="tsd-kind-interface"><a href="interfaces/fileoption.html" class="tsd-kind-icon">File<wbr>Option</a></li>
</ul>
</section>
<section class="tsd-index-section ">
@ -115,7 +116,7 @@
<div class="tsd-signature tsd-kind-icon">EPR<span class="tsd-signature-symbol">:</span> <a href="globals.html#eamusepluginroute" class="tsd-signature-type">EamusePluginRoute</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L235">asphyxia-core.d.ts:235</a></li>
<li>Defined in asphyxia-core.d.ts:232</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -131,7 +132,7 @@
<div class="tsd-signature tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="interfaces/eamuseinfo.html" class="tsd-signature-type">EamuseInfo</a>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, send<span class="tsd-signature-symbol">: </span><a href="interfaces/eamusesend.html" class="tsd-signature-type">EamuseSend</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L224">asphyxia-core.d.ts:224</a></li>
<li>Defined in asphyxia-core.d.ts:225</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -173,7 +174,7 @@
<div class="tsd-signature tsd-kind-icon">KAttr<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L61">asphyxia-core.d.ts:61</a></li>
<li>Defined in asphyxia-core.d.ts:61</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -196,7 +197,7 @@
<div class="tsd-signature tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vs8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vu8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vs16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vu16"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L46">asphyxia-core.d.ts:46</a></li>
<li>Defined in asphyxia-core.d.ts:46</li>
</ul>
</aside>
</section>
@ -206,7 +207,7 @@
<div class="tsd-signature tsd-kind-icon">KBig<wbr>Int<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"s64"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u64"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L16">asphyxia-core.d.ts:16</a></li>
<li>Defined in asphyxia-core.d.ts:16</li>
</ul>
</aside>
</section>
@ -216,7 +217,7 @@
<div class="tsd-signature tsd-kind-icon">KEncoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"shift_jis"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"utf8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"euc-jp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ascii"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"iso-8859-1"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L66">asphyxia-core.d.ts:66</a></li>
<li>Defined in asphyxia-core.d.ts:66</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -231,7 +232,7 @@
<div class="tsd-signature tsd-kind-icon">KNumber<wbr>Group<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"2s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2f"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3f"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4f"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4d"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"2b"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"3b"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"4b"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"vb"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L17">asphyxia-core.d.ts:17</a></li>
<li>Defined in asphyxia-core.d.ts:17</li>
</ul>
</aside>
</section>
@ -241,7 +242,7 @@
<div class="tsd-signature tsd-kind-icon">KNumber<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"s8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"s16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u16"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"s32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"u32"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"time"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ip4"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"float"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"double"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"bool"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L4">asphyxia-core.d.ts:4</a></li>
<li>Defined in asphyxia-core.d.ts:4</li>
</ul>
</aside>
</section>
@ -290,6 +291,9 @@
<li class=" tsd-kind-interface">
<a href="interfaces/eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#epr" class="tsd-kind-icon">EPR</a>
</li>
@ -339,6 +343,5 @@
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>

12
typedoc/index.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -54,7 +54,7 @@
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>Asphyxia CORE Plugin API</h1>
<h1>Asphyxia CORE Module API</h1>
</div>
</div>
</header>
@ -111,6 +111,9 @@
<li class=" tsd-kind-interface">
<a href="interfaces/eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#epr" class="tsd-kind-icon">EPR</a>
</li>
@ -160,6 +163,5 @@
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>

28
typedoc/interfaces/configoption.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ConfigOption | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>ConfigOption | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -67,7 +67,7 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Detail of a config</p>
<p>Details of a config</p>
</div>
</div>
</section>
@ -107,7 +107,7 @@
<div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L101">asphyxia-core.d.ts:101</a></li>
<li>Defined in asphyxia-core.d.ts:96</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -122,7 +122,7 @@
<div class="tsd-signature tsd-kind-icon">desc<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L89">asphyxia-core.d.ts:89</a></li>
<li>Defined in asphyxia-core.d.ts:84</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -137,7 +137,7 @@
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L87">asphyxia-core.d.ts:87</a></li>
<li>Defined in asphyxia-core.d.ts:82</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -152,7 +152,7 @@
<div class="tsd-signature tsd-kind-icon">need<wbr>Restart<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L99">asphyxia-core.d.ts:99</a></li>
<li>Defined in asphyxia-core.d.ts:94</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -167,7 +167,7 @@
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L97">asphyxia-core.d.ts:97</a></li>
<li>Defined in asphyxia-core.d.ts:92</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -182,7 +182,7 @@
<div class="tsd-signature tsd-kind-icon">range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><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 <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L93">asphyxia-core.d.ts:93</a></li>
<li>Defined in asphyxia-core.d.ts:88</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -197,7 +197,7 @@
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"string"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"integer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"float"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"boolean"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L91">asphyxia-core.d.ts:91</a></li>
<li>Defined in asphyxia-core.d.ts:86</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -212,7 +212,7 @@
<div class="tsd-signature tsd-kind-icon">validator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L95">asphyxia-core.d.ts:95</a></li>
<li>Defined in asphyxia-core.d.ts:90</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -299,6 +299,9 @@
<li class=" tsd-kind-interface">
<a href="eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
</li>
@ -348,6 +351,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

16
typedoc/interfaces/eamuseinfo.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>EamuseInfo | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>EamuseInfo | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -102,7 +102,7 @@
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L78">asphyxia-core.d.ts:78</a></li>
<li>Defined in asphyxia-core.d.ts:73</li>
</ul>
</aside>
</section>
@ -112,7 +112,7 @@
<div class="tsd-signature tsd-kind-icon">model<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L79">asphyxia-core.d.ts:79</a></li>
<li>Defined in asphyxia-core.d.ts:74</li>
</ul>
</aside>
</section>
@ -122,7 +122,7 @@
<div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L77">asphyxia-core.d.ts:77</a></li>
<li>Defined in asphyxia-core.d.ts:72</li>
</ul>
</aside>
</section>
@ -168,6 +168,9 @@
<li class=" tsd-kind-interface">
<a href="eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
</li>
@ -217,6 +220,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

36
typedoc/interfaces/eamusesend.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>EamuseSend | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>EamuseSend | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -100,7 +100,7 @@
<div class="tsd-signature tsd-kind-icon">deny<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L137">asphyxia-core.d.ts:137</a></li>
<li>Defined in asphyxia-core.d.ts:146</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -136,7 +136,7 @@
<div class="tsd-signature tsd-kind-icon">object<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L170">asphyxia-core.d.ts:170</a></li>
<li>Defined in asphyxia-core.d.ts:179</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -144,18 +144,18 @@
<p>Send plain javascript object.
When constructing objects, make sure to use helper <a href="../modules/k.html">K</a>:</p>
<pre><code>{
<span class="hljs-attribute">outter</span>: K.<span class="hljs-built_in">ATTR</span>({ status: <span class="hljs-string">"1"</span> }, {
inner: K.ITEM(<span class="hljs-string">"s32"</span>, <span class="hljs-number">1</span>)
<span class="hljs-attribute">outter</span>: K.<span class="hljs-built_in">ATTR</span>({ status: <span class="hljs-string">&quot;1&quot;</span> }, {
inner: K.ITEM(<span class="hljs-string">&quot;s32&quot;</span>, <span class="hljs-number">1</span>)
})
}</code></pre>
</div>
<p>Or follow xml-like format manually:</p>
<pre><code>{
outter: {
<span class="hljs-string">"@attr"</span>: { status: <span class="hljs-string">"1"</span> },
<span class="hljs-string">&quot;@attr&quot;</span>: { status: <span class="hljs-string">&quot;1&quot;</span> },
inner: {
<span class="hljs-string">"@attr"</span>: { __type: <span class="hljs-string">"s32"</span> },
<span class="hljs-string">"@content"</span>: [<span class="hljs-number">1</span>]
<span class="hljs-string">&quot;@attr&quot;</span>: { __type: <span class="hljs-string">&quot;s32&quot;</span> },
<span class="hljs-string">&quot;@content&quot;</span>: [<span class="hljs-number">1</span>]
}
}
}</code></pre>
@ -199,7 +199,7 @@
<div class="tsd-signature tsd-kind-icon">pug<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L190">asphyxia-core.d.ts:190</a></li>
<li>Defined in asphyxia-core.d.ts:199</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -253,7 +253,7 @@
<div class="tsd-signature tsd-kind-icon">pug<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L214">asphyxia-core.d.ts:214</a></li>
<li>Defined in asphyxia-core.d.ts:219</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -307,7 +307,7 @@
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L142">asphyxia-core.d.ts:142</a></li>
<li>Defined in asphyxia-core.d.ts:151</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -346,7 +346,7 @@
<div class="tsd-signature tsd-kind-icon">success<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L132">asphyxia-core.d.ts:132</a></li>
<li>Defined in asphyxia-core.d.ts:141</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -382,7 +382,7 @@
<div class="tsd-signature tsd-kind-icon">xml<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L180">asphyxia-core.d.ts:180</a></li>
<li>Defined in asphyxia-core.d.ts:189</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -436,7 +436,7 @@
<div class="tsd-signature tsd-kind-icon">xml<wbr>File<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>file<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">?: </span><a href="eamusesendoption.html" class="tsd-signature-type">EamuseSendOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L200">asphyxia-core.d.ts:200</a></li>
<li>Defined in asphyxia-core.d.ts:209</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -541,6 +541,9 @@
<li class=" tsd-kind-interface">
<a href="eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
</li>
@ -590,6 +593,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

22
typedoc/interfaces/eamusesendoption.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>EamuseSendOption | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>EamuseSendOption | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -105,7 +105,7 @@
<div class="tsd-signature tsd-kind-icon">compress<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L123">asphyxia-core.d.ts:123</a></li>
<li>Defined in asphyxia-core.d.ts:132</li>
</ul>
</aside>
</section>
@ -115,7 +115,7 @@
<div class="tsd-signature tsd-kind-icon">encoding<span class="tsd-signature-symbol">:</span> <a href="../globals.html#kencoding" class="tsd-signature-type">KEncoding</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L114">asphyxia-core.d.ts:114</a></li>
<li>Defined in asphyxia-core.d.ts:123</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -131,7 +131,7 @@
<div class="tsd-signature tsd-kind-icon">encrypt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L125">asphyxia-core.d.ts:125</a></li>
<li>Defined in asphyxia-core.d.ts:134</li>
</ul>
</aside>
</section>
@ -141,7 +141,7 @@
<div class="tsd-signature tsd-kind-icon">kencode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L124">asphyxia-core.d.ts:124</a></li>
<li>Defined in asphyxia-core.d.ts:133</li>
</ul>
</aside>
</section>
@ -151,7 +151,7 @@
<div class="tsd-signature tsd-kind-icon">root<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L121">asphyxia-core.d.ts:121</a></li>
<li>Defined in asphyxia-core.d.ts:130</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -168,7 +168,7 @@
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L108">asphyxia-core.d.ts:108</a></li>
<li>Defined in asphyxia-core.d.ts:117</li>
</ul>
</aside>
</section>
@ -223,6 +223,9 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
</li>
@ -272,6 +275,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

258
typedoc/interfaces/fileoption.html Normal file
View File

@ -0,0 +1,258 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FileOption | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="fileoption.html">FileOption</a>
</li>
</ul>
<h1>Interface FileOption</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Details of a datafile</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">FileOption</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="fileoption.html#accept" class="tsd-kind-icon">accept</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="fileoption.html#desc" class="tsd-kind-icon">desc</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="fileoption.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="fileoption.html#required" class="tsd-kind-icon">required</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="accept" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> accept</h3>
<div class="tsd-signature tsd-kind-icon">accept<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:108</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The accept attribute of the file input element. See <a href="https://www.w3schools.com/tags/att_input_accept.asp" class="external">https://www.w3schools.com/tags/att_input_accept.asp</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="desc" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> desc</h3>
<div class="tsd-signature tsd-kind-icon">desc<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:106</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Provide a description for the entry</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:104</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Provide a name to display in webui. If not provided, webui will use filename as the label.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="required" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> required</h3>
<div class="tsd-signature tsd-kind-icon">required<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:110</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Whether the file required for the plugin to work, defaults to false</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/kdatareader.html" class="tsd-kind-icon">KData<wbr>Reader</a>
</li>
<li class=" tsd-kind-interface">
<a href="configoption.html" class="tsd-kind-icon">Config<wbr>Option</a>
</li>
<li class=" tsd-kind-interface">
<a href="eamuseinfo.html" class="tsd-kind-icon">Eamuse<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="eamusesend.html" class="tsd-kind-icon">Eamuse<wbr>Send</a>
</li>
<li class=" tsd-kind-interface">
<a href="eamusesendoption.html" class="tsd-kind-icon">Eamuse<wbr>Send<wbr>Option</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="fileoption.html" class="tsd-kind-icon">File<wbr>Option</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="fileoption.html#accept" class="tsd-kind-icon">accept</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="fileoption.html#desc" class="tsd-kind-icon">desc</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="fileoption.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="fileoption.html#required" class="tsd-kind-icon">required</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias">
<a href="../globals.html#epr" class="tsd-kind-icon">EPR</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#eamusepluginroute" class="tsd-kind-icon">Eamuse<wbr>Plugin<wbr>Route</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#kattrmap" class="tsd-kind-icon">KAttr<wbr>Map</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#kbigintgrouptype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Group<wbr>Type</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#kbiginttype" class="tsd-kind-icon">KBig<wbr>Int<wbr>Type</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#kencoding" class="tsd-kind-icon">KEncoding</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#knumbergrouptype" class="tsd-kind-icon">KNumber<wbr>Group<wbr>Type</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#knumbertype" class="tsd-kind-icon">KNumber<wbr>Type</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

31
typedoc/modules/_.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>$ | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>$ | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -73,7 +73,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L646">asphyxia-core.d.ts:646</a></li>
<li>Defined in asphyxia-core.d.ts:649</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -126,7 +126,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L648">asphyxia-core.d.ts:648</a></li>
<li>Defined in asphyxia-core.d.ts:651</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -152,7 +152,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L649">asphyxia-core.d.ts:649</a></li>
<li>Defined in asphyxia-core.d.ts:652</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -181,7 +181,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L650">asphyxia-core.d.ts:650</a></li>
<li>Defined in asphyxia-core.d.ts:653</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -210,7 +210,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L651">asphyxia-core.d.ts:651</a></li>
<li>Defined in asphyxia-core.d.ts:654</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -236,7 +236,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L652">asphyxia-core.d.ts:652</a></li>
<li>Defined in asphyxia-core.d.ts:655</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -265,7 +265,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L653">asphyxia-core.d.ts:653</a></li>
<li>Defined in asphyxia-core.d.ts:656</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -294,7 +294,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L654">asphyxia-core.d.ts:654</a></li>
<li>Defined in asphyxia-core.d.ts:657</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -323,7 +323,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L655">asphyxia-core.d.ts:655</a></li>
<li>Defined in asphyxia-core.d.ts:658</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -352,7 +352,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L656">asphyxia-core.d.ts:656</a></li>
<li>Defined in asphyxia-core.d.ts:659</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -381,7 +381,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L657">asphyxia-core.d.ts:657</a></li>
<li>Defined in asphyxia-core.d.ts:660</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -410,7 +410,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L658">asphyxia-core.d.ts:658</a></li>
<li>Defined in asphyxia-core.d.ts:661</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -517,6 +517,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

43
typedoc/modules/db.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DB | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>DB | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -79,8 +79,8 @@
you should refrain from referencing refid in your document to prevent getting unclearable garbage data.</p>
<p>If you need to make rival/friend feature, we recommend you to get all profile data by passing null to <code>refid</code>.
There will be 16 profiles maximum which is small enough to manage.</p>
<p>All query and doc should not have any fields start with &quot;<strong>&quot; with &quot;</strong>refid&quot; being the only exception.
However, &quot;<strong>refid&quot; field will still be ignored while other &quot;</strong>&quot; starting fields will cause an error to be thrown.</p>
<p>All query and doc should not have any fields start with <code>__</code> while <code>__refid</code> being the only exception.
However, <code>__refid</code> field will still be ignored while other <code>__</code> starting fields will cause an error to be thrown.</p>
</div>
</section>
<section class="tsd-panel-group tsd-index-group">
@ -115,7 +115,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1109">asphyxia-core.d.ts:1109</a></li>
<li>Defined in asphyxia-core.d.ts:1054</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -138,7 +138,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1110">asphyxia-core.d.ts:1110</a></li>
<li>Defined in asphyxia-core.d.ts:1055</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -168,7 +168,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1063">asphyxia-core.d.ts:1063</a></li>
<li>Defined in asphyxia-core.d.ts:1011</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -191,7 +191,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1067">asphyxia-core.d.ts:1067</a></li>
<li>Defined in asphyxia-core.d.ts:1012</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -221,7 +221,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1057">asphyxia-core.d.ts:1057</a></li>
<li>Defined in asphyxia-core.d.ts:1008</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -244,7 +244,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1061">asphyxia-core.d.ts:1061</a></li>
<li>Defined in asphyxia-core.d.ts:1009</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -274,7 +274,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1069">asphyxia-core.d.ts:1069</a></li>
<li>Defined in asphyxia-core.d.ts:1014</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -297,7 +297,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1070">asphyxia-core.d.ts:1070</a></li>
<li>Defined in asphyxia-core.d.ts:1015</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -327,7 +327,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1072">asphyxia-core.d.ts:1072</a></li>
<li>Defined in asphyxia-core.d.ts:1017</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -350,7 +350,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1073">asphyxia-core.d.ts:1073</a></li>
<li>Defined in asphyxia-core.d.ts:1018</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -380,7 +380,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1075">asphyxia-core.d.ts:1075</a></li>
<li>Defined in asphyxia-core.d.ts:1020</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -406,7 +406,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1083">asphyxia-core.d.ts:1083</a></li>
<li>Defined in asphyxia-core.d.ts:1028</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -432,14 +432,14 @@
<a name="upsert" class="tsd-anchor"></a>
<h3>Upsert</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">Upsert&lt;T&gt;<span class="tsd-signature-symbol">(</span>refid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, update<span class="tsd-signature-symbol">: </span><a href="db.html#update" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>upsert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">Upsert&lt;T&gt;<span class="tsd-signature-symbol">(</span>refid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, update<span class="tsd-signature-symbol">: </span><a href="db.html#update" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileDoc</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>upsert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">Upsert&lt;T&gt;<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span>, update<span class="tsd-signature-symbol">: </span><a href="db.html#update" class="tsd-signature-type">Update</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>docs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Doc</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>updated<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>upsert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1091">asphyxia-core.d.ts:1091</a></li>
<li>Defined in asphyxia-core.d.ts:1036</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -451,7 +451,7 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>refid: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
<h5>refid: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>query: <span class="tsd-signature-type">Query</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h5>
@ -465,7 +465,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L1100">asphyxia-core.d.ts:1100</a></li>
<li>Defined in asphyxia-core.d.ts:1045</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -563,6 +563,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

25
typedoc/modules/io.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IO | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>IO | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -69,7 +69,7 @@
<div class="lead">
<p>Filesystem IO</p>
</div>
<p>These are designed to match nodejs <code>fs</code> module. Along with custom filesystem implementation for reading compressed data.</p>
<p>These are designed to match nodejs <code>fs</code> module.</p>
<p><strong>DO NOT</strong> use IO for savedata. Please use <a href="db.html">DB</a> namespace so your data can be managed by WebUI.</p>
<p>Also, due to difference between operating systems, you should always prepare your files using ascii path.
Both UTF-8 and local encodings will have cross-platform compatibility issues.</p>
@ -103,7 +103,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L828">asphyxia-core.d.ts:828</a></li>
<li>Defined in asphyxia-core.d.ts:799</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -137,7 +137,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L867">asphyxia-core.d.ts:867</a></li>
<li>Defined in asphyxia-core.d.ts:833</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -167,7 +167,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L879">asphyxia-core.d.ts:879</a></li>
<li>Defined in asphyxia-core.d.ts:845</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -197,7 +197,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L891">asphyxia-core.d.ts:891</a></li>
<li>Defined in asphyxia-core.d.ts:857</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -227,7 +227,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L905">asphyxia-core.d.ts:905</a></li>
<li>Defined in asphyxia-core.d.ts:867</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -259,7 +259,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L822">asphyxia-core.d.ts:822</a></li>
<li>Defined in asphyxia-core.d.ts:793</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -288,7 +288,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L843">asphyxia-core.d.ts:843</a></li>
<li>Defined in asphyxia-core.d.ts:812</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -327,7 +327,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L858">asphyxia-core.d.ts:858</a></li>
<li>Defined in asphyxia-core.d.ts:824</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -422,6 +422,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

52
typedoc/modules/k.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>K | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>K | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -101,16 +101,17 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L791">asphyxia-core.d.ts:791</a></li>
<li>Defined in asphyxia-core.d.ts:774</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Example:</p>
<pre><code>{
<span class="hljs-attribute">tag</span>: K.<span class="hljs-built_in">ARRAY</span>(<span class="hljs-string">'s32'</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], {attr: <span class="hljs-string">"4"</span>})
}</code></pre><p>Represents:</p>
<pre><code>&lt;tag __type=<span class="hljs-string">"s32"</span> __count=<span class="hljs-string">"3"</span> attr=<span class="hljs-string">"2"</span>&gt;<span class="hljs-number">1</span> <span class="hljs-number">2</span> <span class="hljs-number">3</span>&lt;/tag&gt;</code></pre>
<span class="hljs-attribute">tag</span>: K.<span class="hljs-built_in">ARRAY</span>(<span class="hljs-string">&#x27;s32&#x27;</span>, [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>], {attr: <span class="hljs-string">&quot;4&quot;</span>})
}</code></pre>
<p>Represents:</p>
<pre><code><span class="hljs-tag">&lt;<span class="hljs-name">tag</span> <span class="hljs-attr">__type</span>=<span class="hljs-string">&quot;s32&quot;</span> <span class="hljs-attr">__count</span>=<span class="hljs-string">&quot;3&quot;</span> <span class="hljs-attr">attr</span>=<span class="hljs-string">&quot;2&quot;</span>&gt;</span>1 2 3<span class="hljs-tag">&lt;/<span class="hljs-name">tag</span>&gt;</span></code></pre>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -145,7 +146,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L796">asphyxia-core.d.ts:796</a></li>
<li>Defined in asphyxia-core.d.ts:775</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -171,7 +172,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L801">asphyxia-core.d.ts:801</a></li>
<li>Defined in asphyxia-core.d.ts:776</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -206,18 +207,19 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L734">asphyxia-core.d.ts:734</a></li>
<li>Defined in asphyxia-core.d.ts:733</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Example:</p>
<pre><code>{
tag: K.ATTR({attr: <span class="hljs-string">"1"</span>}, {
tag: K.ATTR({attr: <span class="hljs-string">&quot;1&quot;</span>}, {
inner: [{}, {}]
})
}</code></pre><p>Represents:</p>
<pre><code><span class="hljs-tag">&lt;<span class="hljs-name">tag</span> <span class="hljs-attr">attr</span>=<span class="hljs-string">"1"</span>&gt;</span>
}</code></pre>
<p>Represents:</p>
<pre><code><span class="hljs-tag">&lt;<span class="hljs-name">tag</span> <span class="hljs-attr">attr</span>=<span class="hljs-string">&quot;1&quot;</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span>/&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">inner</span>/&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">tag</span>&gt;</span></code></pre>
@ -268,16 +270,17 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L751">asphyxia-core.d.ts:751</a></li>
<li>Defined in asphyxia-core.d.ts:750</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Example:</p>
<pre><code>{
<span class="hljs-attribute">tag</span>: K.<span class="hljs-built_in">ITEM</span>(<span class="hljs-string">'s32'</span>, <span class="hljs-number">1</span>, {attr: <span class="hljs-string">"2"</span>})
}</code></pre><p>Represents:</p>
<pre><code>&lt;tag <span class="hljs-attribute">__type</span>=<span class="hljs-string">"s32"</span> <span class="hljs-attribute">attr</span>=<span class="hljs-string">"2"</span>&gt;1&lt;/tag&gt;</code></pre>
<span class="hljs-attribute">tag</span>: K.<span class="hljs-built_in">ITEM</span>(<span class="hljs-string">&#x27;s32&#x27;</span>, <span class="hljs-number">1</span>, {attr: <span class="hljs-string">&quot;2&quot;</span>})
}</code></pre>
<p>Represents:</p>
<pre><code>&lt;tag <span class="hljs-attribute">__type</span>=<span class="hljs-string">&quot;s32&quot;</span> <span class="hljs-attribute">attr</span>=<span class="hljs-string">&quot;2&quot;</span>&gt;1&lt;/tag&gt;</code></pre>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -306,7 +309,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L752">asphyxia-core.d.ts:752</a></li>
<li>Defined in asphyxia-core.d.ts:751</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -326,7 +329,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L753">asphyxia-core.d.ts:753</a></li>
<li>Defined in asphyxia-core.d.ts:752</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -346,7 +349,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L754">asphyxia-core.d.ts:754</a></li>
<li>Defined in asphyxia-core.d.ts:753</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -366,7 +369,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L755">asphyxia-core.d.ts:755</a></li>
<li>Defined in asphyxia-core.d.ts:754</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -392,7 +395,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L760">asphyxia-core.d.ts:760</a></li>
<li>Defined in asphyxia-core.d.ts:755</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -418,7 +421,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L765">asphyxia-core.d.ts:765</a></li>
<li>Defined in asphyxia-core.d.ts:756</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -444,7 +447,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L770">asphyxia-core.d.ts:770</a></li>
<li>Defined in asphyxia-core.d.ts:757</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -533,6 +536,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

60
typedoc/modules/r.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>R | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>R | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -81,6 +81,7 @@
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#config" class="tsd-kind-icon">Config</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#contributor" class="tsd-kind-icon">Contributor</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#datafile" class="tsd-kind-icon">Data<wbr>File</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#gamecode" class="tsd-kind-icon">Game<wbr>Code</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#route" class="tsd-kind-icon">Route</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="r.html#unhandled" class="tsd-kind-icon">Unhandled</a></li>
@ -102,7 +103,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L296">asphyxia-core.d.ts:296</a></li>
<li>Defined in asphyxia-core.d.ts:293</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -140,7 +141,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L286">asphyxia-core.d.ts:286</a></li>
<li>Defined in asphyxia-core.d.ts:283</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -168,6 +169,43 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="datafile" class="tsd-anchor"></a>
<h3>Data<wbr>File</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">Data<wbr>File<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/fileoption.html" class="tsd-signature-type">FileOption</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:302</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register a data file upload entry.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>a path (with filename) where the uploaded file will be saved to.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/fileoption.html" class="tsd-signature-type">FileOption</a></h5>
<div class="tsd-comment tsd-typography">
<p>See <a href="../interfaces/fileoption.html">FileOption</a></p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="gamecode" class="tsd-anchor"></a>
<h3>Game<wbr>Code</h3>
@ -178,7 +216,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L276">asphyxia-core.d.ts:276</a></li>
<li>Defined in asphyxia-core.d.ts:273</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -211,7 +249,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L255">asphyxia-core.d.ts:255</a></li>
<li>Defined in asphyxia-core.d.ts:252</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -253,7 +291,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L265">asphyxia-core.d.ts:265</a></li>
<li>Defined in asphyxia-core.d.ts:262</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -286,7 +324,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L305">asphyxia-core.d.ts:305</a></li>
<li>Defined in asphyxia-core.d.ts:311</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -363,6 +401,9 @@
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="r.html#contributor" class="tsd-kind-icon">Contributor</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="r.html#datafile" class="tsd-kind-icon">Data<wbr>File</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="r.html#gamecode" class="tsd-kind-icon">Game<wbr>Code</a>
</li>
@ -400,6 +441,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>

13
typedoc/modules/u.html
View File

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>U | Asphyxia CORE Plugin API</title>
<meta name="description" content="Documentation for Asphyxia CORE Plugin API">
<title>U | Asphyxia CORE Module API</title>
<meta name="description" content="Documentation for Asphyxia CORE Module API">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Asphyxia CORE Plugin API</a>
<a href="../index.html" class="title">Asphyxia CORE Module API</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -99,7 +99,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L933">asphyxia-core.d.ts:933</a></li>
<li>Defined in asphyxia-core.d.ts:895</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -129,7 +129,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L927">asphyxia-core.d.ts:927</a></li>
<li>Defined in asphyxia-core.d.ts:889</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -166,7 +166,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/asphyxia-core/plugins/blob/510453c/asphyxia-core.d.ts#L919">asphyxia-core.d.ts:919</a></li>
<li>Defined in asphyxia-core.d.ts:881</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -251,6 +251,5 @@
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>