jyapayne/godot-nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update master documentation for changeset b3ad6134d9

Browse source
This commit is contained in:
Travis 2018-06-04 10:14:31 +00:00
commit b96f714f22
507 changed files with 687332 additions and 2309 deletions
Download patch file Download diff file Expand all files Collapse all files

71
master/nodepaths.html
View file

@ -1258,6 +1258,8 @@ function main() {
title="godotNodePath(path: NodePath): ptr GodotNodePath"><wbr />godot<wbr />Node<wbr />Path<span class="attachedType" style="visibility:hidden">NodePath</span></a></li>
<li><a class="reference" href="#$,NodePath"
title="`$`(self: NodePath): string"><wbr />`$`<span class="attachedType" style="visibility:hidden">NodePath</span></a></li>
<li><a class="reference" href="#hash,NodePath"
title="hash(self: NodePath): Hash"><wbr />hash<span class="attachedType" style="visibility:hidden">NodePath</span></a></li>
<li><a class="reference" href="#isAbsolute,NodePath"
title="isAbsolute(self: NodePath): bool"><wbr />is<wbr />Absolute<span class="attachedType" style="visibility:hidden">NodePath</span></a></li>
<li><a class="reference" href="#nameCount,NodePath"
@ -1295,7 +1297,7 @@ 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="godotinternaltypes.html">internal/godotinternaltypes</a>, <a class="reference external" href="godotnodepaths.html">internal/godotnodepaths</a>, <a class="reference external" href="godotstrings.html">internal/godotstrings</a>
<a class="reference external" href="hashes.html">hashes</a>, <a class="reference external" href="godotinternaltypes.html">internal/godotinternaltypes</a>, <a class="reference external" href="godotnodepaths.html">internal/godotnodepaths</a>, <a class="reference external" href="godotstrings.html">internal/godotstrings</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
@ -1306,9 +1308,9 @@ function main() {
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L7"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L9"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L7" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L9" class="link-seesrc" target="_blank" >Edit</a>
</dd>
@ -1320,108 +1322,117 @@ class="link-seesrc" target="_blank">Source</a>
<dd>
Moves the GodotNodePath into Nim wrapper. The <tt class="docutils literal"><span class="pre">path</span></tt> will be destroyed automatically when the result is no longer referenced.
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L13"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L15"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L13" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L15" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="newNodePath"><a name="newNodePath,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">newNodePath</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">NodePath</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>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L19"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L21"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L19" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L21" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="godotNodePath"><a name="godotNodePath,NodePath"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotNodePath</span><span class="Other">(</span><span class="Identifier">path</span><span class="Other">:</span> <span class="Identifier">NodePath</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">GodotNodePath</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>
<dd>
WARNING: do not keep the returned value for longer than the lifetime of <tt class="docutils literal"><span class="pre">path</span></tt>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L25"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L27"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L25" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="$"><a name="$,NodePath"></a><pre><span class="Keyword">proc</span> <span class="Identifier">`$`</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NodePath</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L30"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L32"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L30" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L32" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="hash"><a name="hash,NodePath"></a><pre><span class="Keyword">proc</span> <span class="Identifier">hash</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NodePath</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Hash</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L37"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L37" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="isAbsolute"><a name="isAbsolute,NodePath"></a><pre><span class="Keyword">proc</span> <span class="Identifier">isAbsolute</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NodePath</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L35"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L40"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L35" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L40" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="nameCount"><a name="nameCount,NodePath"></a><pre><span class="Keyword">proc</span> <span class="Identifier">nameCount</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NodePath</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L38"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L43"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L38" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L43" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="getName"><a name="getName,NodePath,int"></a><pre><span class="Keyword">proc</span> <span class="Identifier">getName</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NodePath</span><span class="Other">;</span> <span class="Identifier">idx</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L41"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L46"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L41" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="subnameCount"><a name="subnameCount,NodePath"></a><pre><span class="Keyword">proc</span> <span class="Identifier">subnameCount</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NodePath</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L46"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L51"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="getSubname"><a name="getSubname,NodePath,int"></a><pre><span class="Keyword">proc</span> <span class="Identifier">getSubname</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NodePath</span><span class="Other">;</span> <span class="Identifier">idx</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L49"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L54"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L49" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="getConcatenatedSubnames"><a name="getConcatenatedSubnames,NodePath"></a><pre><span class="Keyword">proc</span> <span class="Identifier">getConcatenatedSubnames</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NodePath</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L54"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L59"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L59" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="isEmpty"><a name="isEmpty,NodePath"></a><pre><span class="Keyword">proc</span> <span class="Identifier">isEmpty</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NodePath</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>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L59"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L64"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L59" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L64" class="link-seesrc" target="_blank" >Edit</a>
</dd>
<dt id="=="><a name="==,NodePath,NodePath"></a><pre><span class="Keyword">proc</span> <span class="Identifier">`==`</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">NodePath</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">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/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L62"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L67"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L62" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L67" class="link-seesrc" target="_blank" >Edit</a>
</dd>
@ -1433,9 +1444,9 @@ class="link-seesrc" target="_blank">Source</a>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/pragmagic/godot-nim/tree/dc6ebaf5757b82436d714a779855207c6009afe4/godot/core/nodepaths.nim#L67"
href="https://github.com/pragmagic/godot-nim/tree/b3ad6134d90aafd9da58050fd89943c492cc5351/godot/core/nodepaths.nim#L72"
class="link-seesrc" target="_blank">Source</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L67" class="link-seesrc" target="_blank" >Edit</a>
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/core/nodepaths.nim#L72" class="link-seesrc" target="_blank" >Edit</a>
</dd>
@ -1448,7 +1459,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-03-31 11:12:56 UTC</small>
<small>Made with Nim. Generated: 2018-06-04 09:45:43 UTC</small>
</div>
</div>
</div>