Update master documentation for changeset d11856377e

This commit is contained in:
Travis 2018-02-17 17:21:32 +00:00
commit 7cb156b910
31 changed files with 1966 additions and 1789 deletions

View file

@ -1253,6 +1253,24 @@ function main() {
title="stepify(value, step: float64): float64"><wbr />stepify<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#stepify,float32,float32"
title="stepify(value, step: float32): float32"><wbr />stepify<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#min,float32,float32"
title="min(x, y: float32): float32"><wbr />min<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#abs,float32"
title="abs(x: float32): float32"><wbr />abs<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#max,float32,float32"
title="max(x, y: float32): float32"><wbr />max<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#print,varargs[string,]"
title="print(parts: varargs[string, `$`])"><wbr />print<span class="attachedType" style="visibility:hidden"></span></a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#18" id="68">Templates</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#printWarning.t,typed"
title="printWarning(warning: typed)"><wbr />print<wbr />Warning<span class="attachedType" style="visibility:hidden"></span></a></li>
<li><a class="reference" href="#printError.t,typed"
title="printError(error: typed)"><wbr />print<wbr />Error<span class="attachedType" style="visibility:hidden"></span></a></li>
</ul>
</li>
@ -1266,63 +1284,122 @@ function main() {
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="math.html">math</a>
<a class="reference external" href="math.html">math</a>, <a class="reference external" href="godotinternal.html">godotinternal</a>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<dt id="isEqualApprox"><a name="isEqualApprox,float32,float32"></a><pre><span class="Keyword">proc</span> <span class="Identifier">isEqualApprox</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dt id="isEqualApprox"><a name="isEqualApprox,float32,float32"></a><pre><span class="Keyword">proc</span> <span class="Identifier">isEqualApprox</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/core/godotbase.nim#L8"
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L9"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L8" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L9" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="isEqualApprox"><a name="isEqualApprox,float64,float64"></a><pre><span class="Keyword">proc</span> <span class="Identifier">isEqualApprox</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">float64</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dt id="isEqualApprox"><a name="isEqualApprox,float64,float64"></a><pre><span class="Keyword">proc</span> <span class="Identifier">isEqualApprox</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">float64</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/core/godotbase.nim#L11"
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L12"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L11" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L12" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="sign"><a name="sign,float32"></a><pre><span class="Keyword">proc</span> <span class="Identifier">sign</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float32</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dt id="sign"><a name="sign,float32"></a><pre><span class="Keyword">proc</span> <span class="Identifier">sign</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float32</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/core/godotbase.nim#L14"
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L15"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L14" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L15" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="sign"><a name="sign,float64"></a><pre><span class="Keyword">proc</span> <span class="Identifier">sign</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">float64</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float64</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dt id="sign"><a name="sign,float64"></a><pre><span class="Keyword">proc</span> <span class="Identifier">sign</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">float64</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float64</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/core/godotbase.nim#L17"
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L18"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L17" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L18" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="stepify"><a name="stepify,float64,float64"></a><pre><span class="Keyword">proc</span> <span class="Identifier">stepify</span><span class="Other">(</span><span class="Identifier">value</span><span class="Other">,</span> <span class="Identifier">step</span><span class="Other">:</span> <span class="Identifier">float64</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float64</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dt id="stepify"><a name="stepify,float64,float64"></a><pre><span class="Keyword">proc</span> <span class="Identifier">stepify</span><span class="Other">(</span><span class="Identifier">value</span><span class="Other">,</span> <span class="Identifier">step</span><span class="Other">:</span> <span class="Identifier">float64</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float64</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/core/godotbase.nim#L20"
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L21"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L20" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L21" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="stepify"><a name="stepify,float32,float32"></a><pre><span class="Keyword">proc</span> <span class="Identifier">stepify</span><span class="Other">(</span><span class="Identifier">value</span><span class="Other">,</span> <span class="Identifier">step</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float32</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dt id="stepify"><a name="stepify,float32,float32"></a><pre><span class="Keyword">proc</span> <span class="Identifier">stepify</span><span class="Other">(</span><span class="Identifier">value</span><span class="Other">,</span> <span class="Identifier">step</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float32</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/f05eb090f710df4aed71e6502da8258c5abbb6d9/godot/core/godotbase.nim#L26"
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L27"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L26" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="min"><a name="min,float32,float32"></a><pre><span class="Keyword">proc</span> <span class="Identifier">min</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float32</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L33"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L33" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="abs"><a name="abs,float32"></a><pre><span class="Keyword">proc</span> <span class="Identifier">abs</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float32</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L36"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L36" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="max"><a name="max,float32,float32"></a><pre><span class="Keyword">proc</span> <span class="Identifier">max</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">float32</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">float32</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L39"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L39" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="print"><a name="print,varargs[string,]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">print</span><span class="Other">(</span><span class="Identifier">parts</span><span class="Other">:</span> <span class="Identifier">varargs</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></div><span class="Other pragmaend">.}</span></pre></dt>
<dd>
Prints concatenated <tt class="docutils literal"><span class="pre">parts</span></tt> to Godot log.
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L54"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</dl></div>
<div class="section" id="18">
<h1><a class="toc-backref" href="#18">Templates</a></h1>
<dl class="item">
<dt id="printWarning"><a name="printWarning.t,typed"></a><pre><span class="Keyword">template</span> <span class="Identifier">printWarning</span><span class="Other">(</span><span class="Identifier">warning</span><span class="Other">:</span> <span class="Identifier">typed</span><span class="Other">)</span></pre></dt>
<dd>
Prints <tt class="docutils literal"><span class="pre">warning</span></tt> to Godot log, adding filename and line information.
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L44"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="printError"><a name="printError.t,typed"></a><pre><span class="Keyword">template</span> <span class="Identifier">printError</span><span class="Other">(</span><span class="Identifier">error</span><span class="Other">:</span> <span class="Identifier">typed</span><span class="Other">)</span></pre></dt>
<dd>
Prints <tt class="docutils literal"><span class="pre">error</span></tt> to Godot log, adding filename and line information.
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/d11856377e05212663c72dd06947f9e40456cff3/godot/core/godotbase.nim#L49"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/godotbase.nim#L49" class="link-seesrc" target="_blank" >Edit</a>
</dd>
@ -1335,7 +1412,7 @@ class="link-seesrc" target="_blank">Source</a>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small>Made with Nim. Generated: 2018-01-25 11:57:38 UTC</small>
<small>Made with Nim. Generated: 2018-02-17 17:04:56 UTC</small>
</div>
</div>
</div>