Update master documentation for changeset 327cd0e18f
This commit is contained in:
parent
578435dcd6
commit
71ba9e8549
464 changed files with 1790 additions and 1641 deletions
|
|
@ -1222,8 +1222,14 @@ function main() {
|
|||
<li><a class="reference" href="#NimGodotObject"
|
||||
title="NimGodotObject* = ref object of RootObj
|
||||
godotObject: ptr GodotObject
|
||||
isExternalRef: bool
|
||||
isOwn: bool"><wbr />Nim<wbr />Godot<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
linkedObject: NimGodotObject ## Wrapper around native object that is the container of the Nim "script"
|
||||
## This is needed for `of` checks and `as` conversions to work as
|
||||
## expected. For example, Nim type may inherit from ``Spatial``, but the
|
||||
## script is attached to ``Particles``. In this case conversion to
|
||||
## ``Particles`` is valid, but Nim type system is not aware of that.
|
||||
## This works in both directions - for linked native object this
|
||||
## reference points to Nim object.
|
||||
isExternalRef: bool"><wbr />Nim<wbr />Godot<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#ConversionResult"
|
||||
title="ConversionResult* = enum
|
||||
OK, TypeError, ## Type mismatch
|
||||
|
|
@ -1232,13 +1238,23 @@ function main() {
|
|||
<li><a class="reference" href="#CallError"
|
||||
title="CallError* = object of Exception
|
||||
err*: VariantCallError ## The error as returned by Godot"><wbr />Call<wbr />Error<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#GodotTypeInfo"
|
||||
title="GodotTypeInfo* = object
|
||||
variantType*: VariantType
|
||||
hint*: GodotPropertyHint
|
||||
hintStr*: string ## Format depends on the type and the hint.
|
||||
## For example, for Enum ``hint`` this is a comma separated list of
|
||||
## values.
|
||||
## See documentation of ``GodotPropertyHint`` for description of formats."><wbr />Godot<wbr />Type<wbr />Info<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a class="reference reference-toplevel" href="#8" id="58">Vars</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#refClasses"
|
||||
<li><a class="reference" href="#classRegistryStatic"
|
||||
title="classRegistryStatic*: TableRef[cstring, ObjectInfo]"><wbr />class<wbr />Registry<wbr />Static<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#refClasses"
|
||||
title="refClasses* = newSeq[string]()"><wbr />ref<wbr />Classes<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
|
||||
</ul>
|
||||
|
|
@ -1246,16 +1262,17 @@ function main() {
|
|||
<li>
|
||||
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||||
<ul class="simple simple-toc-section">
|
||||
<li><a class="reference" href="#print,string"
|
||||
title="print*(message: string)"><wbr />print<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#print,cstring"
|
||||
title="print*(message: cstring)"><wbr />print<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>
|
||||
<li><a class="reference" href="#getClassName,NimGodotObject"
|
||||
title="getClassName*(o: NimGodotObject): string"><wbr />get<wbr />Class<wbr />Name<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#deinit,NimGodotObject"
|
||||
title="deinit*(obj: NimGodotObject)"><wbr />deinit<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#asNimGodotObject,ptr.GodotObject"
|
||||
title="asNimGodotObject*[T: NimGodotObject](godotObject: ptr GodotObject): T"><wbr />as<wbr />Nim<wbr />Godot<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#nimGodotObjectFinalizer,T"
|
||||
title="nimGodotObjectFinalizer*[T: NimGodotObject](obj: T)"><wbr />nim<wbr />Godot<wbr />Object<wbr />Finalizer<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#asNimGodotObject,ptr.GodotObject,bool"
|
||||
title="asNimGodotObject*[T: NimGodotObject](godotObject: ptr GodotObject;
|
||||
noRef: bool = false): T"><wbr />as<wbr />Nim<wbr />Godot<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#newVariant,NimGodotObject"
|
||||
title="newVariant*(obj: NimGodotObject): Variant"><wbr />new<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#asObject,Variant"
|
||||
|
|
@ -1264,6 +1281,8 @@ function main() {
|
|||
title="asObject*(v: Variant; T: typedesc[NimGodotObject]): T"><wbr />as<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#as,NimGodotObject,typedesc[T]"
|
||||
title="`as`*[T: NimGodotObject](obj: NimGodotObject; t: typedesc[T]): T">`<wbr />as`<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#~,NimGodotObject,typedesc[T]"
|
||||
title="`~`*[T: NimGodotObject](obj: NimGodotObject; t: typedesc[T]): bool">`<wbr />~`<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#getSingleton,"
|
||||
title="getSingleton*[T: NimGodotObject](): T"><wbr />get<wbr />Singleton<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#gdnew,"
|
||||
|
|
@ -1274,56 +1293,60 @@ function main() {
|
|||
title="newConversionError*(err: ConversionResult): ref ValueError"><wbr />new<wbr />Conversion<wbr />Error<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#setGodotObject,NimGodotObject,ptr.GodotObject"
|
||||
title="setGodotObject*(nimObj: NimGodotObject; obj: ptr GodotObject)"><wbr />set<wbr />Godot<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#setOwn,NimGodotObject"
|
||||
title="setOwn*(nimObj: NimGodotObject)"><wbr />set<wbr />Own<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#setNativeObject,NimGodotObject,NimGodotObject"
|
||||
title="setNativeObject*(nimObj: NimGodotObject; nativeObj: NimGodotObject)"><wbr />set<wbr />Native<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#removeGodotObject,NimGodotObject"
|
||||
title="removeGodotObject*(nimObj: NimGodotObject)"><wbr />remove<wbr />Godot<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#==,NimGodotObject,NimGodotObject"
|
||||
title="`==`*(self, other: NimGodotObject): bool">`<wbr />==`<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#godotObject,NimGodotObject"
|
||||
title="godotObject*(nimObj: NimGodotObject): ptr GodotObject"><wbr />godot<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#variantType,typedesc[NimGodotObject]"
|
||||
title="variantType*(T: typedesc[NimGodotObject]): VariantType"><wbr />variant<wbr />Type<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#godotTypeInfo,typedesc[NimGodotObject]"
|
||||
title="godotTypeInfo*(T: typedesc[NimGodotObject]): GodotTypeInfo"><wbr />godot<wbr />Type<wbr />Info<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#toVariant,NimGodotObject"
|
||||
title="toVariant*(self: NimGodotObject): Variant"><wbr />to<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,T,Variant"
|
||||
title="fromVariant*[T: NimGodotObject](self: var T; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#variantType,typedesc[]"
|
||||
title="variantType*(T: typedesc[enum]): VariantType"><wbr />variant<wbr />Type<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#toVariant,T"
|
||||
title="toVariant*[T: enum](self: T): Variant"><wbr />to<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,T,Variant_2"
|
||||
title="fromVariant*[T: enum](self: var T; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#toVariant,Variant"
|
||||
title="toVariant*(self: Variant): Variant"><wbr />to<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,Variant,Variant"
|
||||
title="fromVariant*(self: var Variant; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#variantType,typedesc[SomeGodotOrNum]"
|
||||
title="variantType*(T: typedesc[SomeGodotOrNum]): VariantType"><wbr />variant<wbr />Type<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#toVariant,T_2"
|
||||
<li><a class="reference" href="#godotTypeInfo,typedesc[SomeGodotOrNum]"
|
||||
title="godotTypeInfo*(T: typedesc[SomeGodotOrNum]): GodotTypeInfo"><wbr />godot<wbr />Type<wbr />Info<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#godotTypeInfo,typedesc[range]"
|
||||
title="godotTypeInfo*(T: typedesc[range]): VariantType"><wbr />godot<wbr />Type<wbr />Info<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#toVariant,T"
|
||||
title="toVariant*[T: SomeGodotOrNum](val: T): Variant"><wbr />to<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,T,Variant_3"
|
||||
<li><a class="reference" href="#fromVariant,T,Variant_2"
|
||||
title="fromVariant*[T: SomeSignedInt or SomeUnsignedInt](self: var T; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#godotTypeInfo,typedesc[]"
|
||||
title="godotTypeInfo*(T: typedesc[enum]): GodotTypeInfo"><wbr />godot<wbr />Type<wbr />Info<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#toVariant,T_2"
|
||||
title="toVariant*[T: enum](self: T): Variant"><wbr />to<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,T,Variant_3"
|
||||
title="fromVariant*[T: enum](self: var T; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,T,Variant_4"
|
||||
title="fromVariant*[T: SomeFloat](self: var T; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,T,Variant_5"
|
||||
title="fromVariant*[T: SomeGodot](self: var T; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#variantType,typedesc[string]"
|
||||
title="variantType*(T: typedesc[string]): VariantType"><wbr />variant<wbr />Type<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#godotTypeInfo,typedesc[string]"
|
||||
title="godotTypeInfo*(T: typedesc[string]): GodotTypeInfo"><wbr />godot<wbr />Type<wbr />Info<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#toVariant,string"
|
||||
title="toVariant*(s: string): Variant"><wbr />to<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,string,Variant"
|
||||
title="fromVariant*(s: var string; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#variantType,typedesc[seq]"
|
||||
title="variantType*(T: typedesc[seq]): VariantType"><wbr />variant<wbr />Type<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#variantType,typedesc[array]"
|
||||
title="variantType*(T: typedesc[array]): VariantType"><wbr />variant<wbr />Type<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#godotTypeInfo,typedesc[seq]"
|
||||
title="godotTypeInfo*(T: typedesc[seq]): GodotTypeInfo"><wbr />godot<wbr />Type<wbr />Info<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#godotTypeInfo,typedesc[array]"
|
||||
title="godotTypeInfo*(T: typedesc[array]): GodotTypeInfo"><wbr />godot<wbr />Type<wbr />Info<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#toVariant,openarray[T]"
|
||||
title="toVariant*[T](s: openarray[T]): Variant"><wbr />to<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,seq[T],Variant"
|
||||
title="fromVariant*[T](s: var seq[T]; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,T,Variant_6"
|
||||
title="fromVariant*[T: array](s: var T; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#variantType,typedesc[]_2"
|
||||
title="variantType*(T: typedesc[Table | TableRef]): VariantType"><wbr />variant<wbr />Type<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#godotTypeInfo,typedesc[]_2"
|
||||
title="godotTypeInfo*(T: typedesc[Table | TableRef]): GodotTypeInfo"><wbr />godot<wbr />Type<wbr />Info<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#toVariant,T_3"
|
||||
title="toVariant*[T: Table or TableRef](t: T): Variant"><wbr />to<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
||||
<li><a class="reference" href="#fromVariant,T,Variant_7"
|
||||
|
|
@ -1353,9 +1376,10 @@ function main() {
|
|||
<div id="tocRoot"></div>
|
||||
<p class="module-desc"><p>This module defines <tt class="docutils literal"><span class="pre">NimGodotObject</span></tt> and <tt class="docutils literal"><span class="pre">toVariant</span></tt>/<tt class="docutils literal"><span class="pre">fromVariant</span></tt> converters for Nim types. The converters are used by <a class="reference external" href="godotmacros.html#gdobj.m,untyped,typed">gdobj</a> macro to import/export values from/to Godot (editor, GDScript).</p>
|
||||
<p>You can also allow conversion of any custom type <tt class="docutils literal"><span class="pre">MyType</span></tt> by implementing:</p>
|
||||
<pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">variantType</span><span class="Operator">*</span><span class="Punctuation">(</span><span class="Identifier">T</span><span class="Punctuation">:</span> <span class="Identifier">typedesc</span><span class="Punctuation">[</span><span class="Identifier">MyType</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">VariantType</span>
|
||||
<pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">godotTypeInfo</span><span class="Operator">*</span><span class="Punctuation">(</span><span class="Identifier">T</span><span class="Punctuation">:</span> <span class="Identifier">typedesc</span><span class="Punctuation">[</span><span class="Identifier">MyType</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">GodotTypeInfo</span>
|
||||
<span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</span><span class="Punctuation">(</span><span class="Identifier">self</span><span class="Punctuation">:</span> <span class="Identifier">MyType</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">Variant</span>
|
||||
<span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Punctuation">(</span><span class="Identifier">self</span><span class="Punctuation">:</span> <span class="Keyword">var</span> <span class="Identifier">MyType</span><span class="Punctuation">,</span> <span class="Identifier">val</span><span class="Punctuation">:</span> <span class="Identifier">Variant</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">ConversionResult</span></pre></p>
|
||||
<span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Punctuation">(</span><span class="Identifier">self</span><span class="Punctuation">:</span> <span class="Keyword">var</span> <span class="Identifier">MyType</span><span class="Punctuation">,</span> <span class="Identifier">val</span><span class="Punctuation">:</span> <span class="Identifier">Variant</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">ConversionResult</span></pre><p>Implementing <tt class="docutils literal"><span class="pre">godotTypeInfo</span></tt> is optional and is necessary only if you want the type to be editable from the editor.</p>
|
||||
</p>
|
||||
<div class="section" id="6">
|
||||
<h1><a class="toc-backref" href="#6">Imports</a></h1>
|
||||
<dl class="item">
|
||||
|
|
@ -1366,15 +1390,21 @@ function main() {
|
|||
<dl class="item">
|
||||
<dt id="NimGodotObject"><a name="NimGodotObject"></a><pre><span class="Identifier">NimGodotObject</span><span class="Operator">*</span> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">RootObj</span>
|
||||
<span class="Identifier">godotObject</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">GodotObject</span>
|
||||
<span class="Identifier">linkedObject</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span> <span class="Comment">## Wrapper around native object that is the container of the Nim "script"</span>
|
||||
<span class="Comment">## This is needed for `of` checks and `as` conversions to work as</span>
|
||||
<span class="Comment">## expected. For example, Nim type may inherit from ``Spatial``, but the</span>
|
||||
<span class="Comment">## script is attached to ``Particles``. In this case conversion to</span>
|
||||
<span class="Comment">## ``Particles`` is valid, but Nim type system is not aware of that.</span>
|
||||
<span class="Comment">## This works in both directions - for linked native object this</span>
|
||||
<span class="Comment">## reference points to Nim object.</span>
|
||||
<span class="Identifier">isExternalRef</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
<span class="Identifier">isOwn</span><span class="Other">:</span> <span class="Identifier">bool</span>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
The base type all Godot types inherit from. Manages lifecycle of the wrapped GodotObject.
|
||||
The base type all Godot types inherit from. Manages lifecycle of the wrapped <tt class="docutils literal"><span class="pre">GodotObject</span></tt>.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L26"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L29"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L26" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L29" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="ConversionResult"><a name="ConversionResult"></a><pre><span class="Identifier">ConversionResult</span><span class="Operator">*</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">pure</span></div><span class="Other pragmaend">.}</span> <span class="Other">=</span> <span class="Keyword">enum</span>
|
||||
|
|
@ -1384,9 +1414,9 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<dd>
|
||||
Conversion result to return from <tt class="docutils literal"><span class="pre">fromVariant</span></tt> procedure.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L33"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L43"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L33" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L43" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="CallError"><a name="CallError"></a><pre><span class="Identifier">CallError</span><span class="Operator">*</span> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">Exception</span>
|
||||
|
|
@ -1395,9 +1425,25 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<dd>
|
||||
Raised by wrappers in case of an incorrect dynamic invocation. For example, if incorrect number of arguments were passed or they had unexpected types.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L56"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L66"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L56" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L66" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="GodotTypeInfo"><a name="GodotTypeInfo"></a><pre><span class="Identifier">GodotTypeInfo</span><span class="Operator">*</span> <span class="Other">=</span> <span class="Keyword">object</span>
|
||||
<span class="Identifier">variantType</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">VariantType</span>
|
||||
<span class="Identifier">hint</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">GodotPropertyHint</span>
|
||||
<span class="Identifier">hintStr</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Comment">## Format depends on the type and the hint.</span>
|
||||
<span class="Comment">## For example, for Enum ``hint`` this is a comma separated list of</span>
|
||||
<span class="Comment">## values.</span>
|
||||
<span class="Comment">## See documentation of ``GodotPropertyHint`` for description of formats.</span>
|
||||
</pre></dt>
|
||||
<dd>
|
||||
Type information provided to Godot editor
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L79"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L79" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
|
@ -1405,13 +1451,22 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="section" id="8">
|
||||
<h1><a class="toc-backref" href="#8">Vars</a></h1>
|
||||
<dl class="item">
|
||||
<dt id="classRegistryStatic"><a name="classRegistryStatic"></a><pre><span class="Identifier">classRegistryStatic</span><span class="Operator">*</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">compileTime</span></div><span class="Other pragmaend">.}</span><span class="Other">:</span> <span class="Identifier">TableRef</span><span class="Other">[</span><span class="Identifier">cstring</span><span class="Other">,</span> <span class="Identifier">ObjectInfo</span><span class="Other">]</span></pre></dt>
|
||||
<dd>
|
||||
Compile-time variable used for implementation of several procedures and macros
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L109"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L109" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="refClasses"><a name="refClasses"></a><pre><span class="Identifier">refClasses</span><span class="Operator">*</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">compileTime</span></div><span class="Other pragmaend">.}</span> <span class="Other">=</span> <span class="Identifier">newSeq</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">(</span><span class="Other">)</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L99"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L118"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L99" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L118" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
|
@ -1419,76 +1474,77 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="section" id="12">
|
||||
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||||
<dl class="item">
|
||||
<dt id="print"><a name="print,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">print</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">message</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dt id="print"><a name="print,varargs[string,]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">print</span><span class="Operator">*</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></pre></dt>
|
||||
<dd>
|
||||
Prints <tt class="docutils literal"><span class="pre">message</span></tt> to Godot log.
|
||||
Prints concatenated <tt class="docutils literal"><span class="pre">parts</span></tt> to Godot log.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L79"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L99"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L79" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="print"><a name="print,cstring"></a><pre><span class="Keyword">proc</span> <span class="Identifier">print</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">message</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">)</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
Prints <tt class="docutils literal"><span class="pre">message</span></tt> to Godot log.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L85"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L85" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L99" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="getClassName"><a name="getClassName,NimGodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">getClassName</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">o</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L101"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L120"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L101" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L120" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="deinit"><a name="deinit,NimGodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">deinit</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">)</span></pre></dt>
|
||||
<dd>
|
||||
Destroy the object. You only need to call this for objects not inherited from Reference, where manual lifecycle control is necessary.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L118"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L137"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L118" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L137" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="asNimGodotObject"><a name="asNimGodotObject,ptr.GodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">asNimGodotObject</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">godotObject</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">GodotObject</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
|
||||
<dt id="nimGodotObjectFinalizer"><a name="nimGodotObjectFinalizer,T"></a><pre><span class="Keyword">proc</span> <span class="Identifier">nimGodotObjectFinalizer</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L146"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L146" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="asNimGodotObject"><a name="asNimGodotObject,ptr.GodotObject,bool"></a><pre><span class="Keyword">proc</span> <span class="Identifier">asNimGodotObject</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">godotObject</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">GodotObject</span><span class="Other">;</span>
|
||||
<span class="Identifier">noRef</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
|
||||
<dd>
|
||||
Wraps <tt class="docutils literal"><span class="pre">godotObject</span></tt> into Nim type <tt class="docutils literal"><span class="pre">T</span></tt>. This is used by <a class="reference external" href="godotapigen.html">godotapigen</a> and should rarely be used by anything else.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L212"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L233"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L212" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L233" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="newVariant"><a name="newVariant,NimGodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">newVariant</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Variant</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L227"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L249"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L227" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L249" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="asObject"><a name="asObject,Variant"></a><pre><span class="Keyword">proc</span> <span class="Identifier">asObject</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">v</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
Converts <tt class="docutils literal"><span class="pre">v</span></tt> to object of type <tt class="docutils literal"><span class="pre">T</span></tt>. Returns <tt class="docutils literal"><span class="pre">nil</span></tt> if the conversion cannot be performed (<tt class="docutils literal"><span class="pre">v</span></tt>'s type is not an Object or it's an object of an incompatible type)
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L230"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L252"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L230" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L252" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="asObject"><a name="asObject,Variant,typedesc[NimGodotObject]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">asObject</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">v</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">;</span> <span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
Converts <tt class="docutils literal"><span class="pre">v</span></tt> to object of type <tt class="docutils literal"><span class="pre">T</span></tt>. Returns <tt class="docutils literal"><span class="pre">nil</span></tt> if the conversion cannot be performed (<tt class="docutils literal"><span class="pre">v</span></tt>'s type is not an Object or it's an object of an incompatible type)
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L236"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L258"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L236" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L258" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="as"><a name="as,NimGodotObject,typedesc[T]"></a><pre><span class="Keyword">proc</span> <span class="Other">`</span><span class="Keyword">as</span><span class="Other">`</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">;</span> <span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
|
||||
|
|
@ -1497,306 +1553,333 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<p>This can be used either in dot notation (<tt class="docutils literal"><span class="pre">node.as(Button)</span></tt>) or infix notation (<tt class="docutils literal"><span class="pre">node as Button</span></tt>).</p>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L242"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L264"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L242" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L264" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="~"><a name="~,NimGodotObject,typedesc[T]"></a><pre><span class="Keyword">proc</span> <span class="Other">`</span><span class="Operator">~</span><span class="Other">`</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">;</span> <span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
|
||||
<dd>
|
||||
Godot-specific inheritance check. You must use this over Nim's standard <tt class="docutils literal"><span class="pre">of</span></tt> operator, because Nim does not know which object your script is attached to in runtime. For example, if you create a <tt class="docutils literal"><span class="pre">gdobj Bullet of Spatial</span></tt> and the <tt class="docutils literal"><span class="pre">Bullet</span></tt> is attached to a <tt class="docutils literal"><span class="pre">MeshInstance</span></tt>, <tt class="docutils literal"><span class="pre">myBullet of MeshInstance</span></tt> will return <tt class="docutils literal"><span class="pre">false</span></tt>, but <tt class="docutils literal"><span class="pre">myBullet ~ MeshInstance</span></tt> will return <tt class="docutils literal"><span class="pre">true</span></tt>. This is going to be changed to <tt class="docutils literal"><span class="pre">of</span></tt> in later versions, when Nim starts supporting overloading <tt class="docutils literal"><span class="pre">of</span></tt> operator.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L282"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L282" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="getSingleton"><a name="getSingleton,"></a><pre><span class="Keyword">proc</span> <span class="Identifier">getSingleton</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
|
||||
<dd>
|
||||
Returns singleton of type <tt class="docutils literal"><span class="pre">T</span></tt>. Normally, this should not be used, because <a class="reference external" href="godotapigen.html">godotapigen</a> wraps singleton methods so that singleton objects don't have to be provided as parameters.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L275"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L319"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L275" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L319" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="gdnew"><a name="gdnew,"></a><pre><span class="Keyword">proc</span> <span class="Identifier">gdnew</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
|
||||
<dd>
|
||||
Instantiates new object of type <tt class="docutils literal"><span class="pre">T</span></tt>.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L322"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L366"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L322" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L366" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="newCallError"><a name="newCallError,VariantCallError"></a><pre><span class="Keyword">proc</span> <span class="Identifier">newCallError</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">err</span><span class="Other">:</span> <span class="Identifier">VariantCallError</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">CallError</span></pre></dt>
|
||||
<dd>
|
||||
Instantiates <tt class="docutils literal"><span class="pre">CallError</span></tt> from Godot <tt class="docutils literal"><span class="pre">err</span></tt>.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L330"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L374"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L330" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L374" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="newConversionError"><a name="newConversionError,ConversionResult"></a><pre><span class="Keyword">proc</span> <span class="Identifier">newConversionError</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">err</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">ValueError</span></pre></dt>
|
||||
<dd>
|
||||
Instantiates error raised by <a class="reference external" href="godotapigen.html">godotapigen</a> generated code in case of a conversion error.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L346"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L390"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L346" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L390" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="setGodotObject"><a name="setGodotObject,NimGodotObject,ptr.GodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">setGodotObject</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">nimObj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">;</span> <span class="Identifier">obj</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">GodotObject</span><span class="Other">)</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
Used from Godot constructor. Don't call this.
|
||||
Used from Godot constructor produced by <tt class="docutils literal"><span class="pre">gdobj</span></tt> macro. Do not call.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L359"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L403"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L359" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L403" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="setOwn"><a name="setOwn,NimGodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">setOwn</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">nimObj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">)</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dt id="setNativeObject"><a name="setNativeObject,NimGodotObject,NimGodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">setNativeObject</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">nimObj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">;</span> <span class="Identifier">nativeObj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">)</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
Used from Godot constructor. Don't call this.
|
||||
Used from Godot constructor produced by <tt class="docutils literal"><span class="pre">gdobj</span></tt> macro. Do not call.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L365"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L409"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L365" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L409" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="removeGodotObject"><a name="removeGodotObject,NimGodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">removeGodotObject</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">nimObj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">)</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
Used from Godot destructor. Don't call this.
|
||||
Used from Godot destructor produced by <tt class="docutils literal"><span class="pre">gdobj</span></tt> macro. Do not call.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L369"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L415"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L369" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L415" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="=="><a name="==,NimGodotObject,NimGodotObject"></a><pre><span class="Keyword">proc</span> <span class="Other">`</span><span class="Operator">==</span><span class="Other">`</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">,</span> <span class="Identifier">other</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</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></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
Compares objects by referential equality.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L420"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L420" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="godotObject"><a name="godotObject,NimGodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotObject</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">nimObj</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">GodotObject</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
Returns internal poitner to <tt class="docutils literal"><span class="pre">GodotObject</span></tt>. Use only if you know what you are doing.
|
||||
Returns raw poitner to <tt class="docutils literal"><span class="pre">GodotObject</span></tt>. Use only if you know what you are doing.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L373"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L424"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L373" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L424" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="variantType"><a name="variantType,typedesc[NimGodotObject]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">variantType</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">VariantType</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dt id="godotTypeInfo"><a name="godotTypeInfo,typedesc[NimGodotObject]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotTypeInfo</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotTypeInfo</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L378"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L429"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L378" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L429" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="toVariant"><a name="toVariant,NimGodotObject"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Variant</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L381"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L436"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L381" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L436" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,T,Variant"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">NimGodotObject</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L384"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L439"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L384" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="variantType"><a name="variantType,typedesc[]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">variantType</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Keyword">enum</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">VariantType</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L396"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L396" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="toVariant"><a name="toVariant,T"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Variant</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L399"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L399" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,T,Variant_2"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L402"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L402" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L439" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="toVariant"><a name="toVariant,Variant"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Variant</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L409"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L451"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L409" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L451" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,Variant,Variant"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">Variant</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L412"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L454"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L412" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L454" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="variantType"><a name="variantType,typedesc[SomeGodotOrNum]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">variantType</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">SomeGodotOrNum</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">VariantType</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dt id="godotTypeInfo"><a name="godotTypeInfo,typedesc[SomeGodotOrNum]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotTypeInfo</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">SomeGodotOrNum</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotTypeInfo</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L416"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L458"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L416" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L458" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="toVariant"><a name="toVariant,T_2"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">SomeGodotOrNum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Variant</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dt id="godotTypeInfo"><a name="godotTypeInfo,typedesc[range]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotTypeInfo</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">range</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">VariantType</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L472"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L515"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L472" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L515" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,T,Variant_3"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">SomeSignedInt</span> <span class="Keyword">or</span> <span class="Identifier">SomeUnsignedInt</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span></pre></dt>
|
||||
<dt id="toVariant"><a name="toVariant,T"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">SomeGodotOrNum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Variant</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L475"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L522"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L475" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L522" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,T,Variant_2"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">SomeSignedInt</span> <span class="Keyword">or</span> <span class="Identifier">SomeUnsignedInt</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L525"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L525" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="godotTypeInfo"><a name="godotTypeInfo,typedesc[]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotTypeInfo</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Keyword">enum</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotTypeInfo</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L542"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L542" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="toVariant"><a name="toVariant,T_2"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Variant</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L553"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L553" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,T,Variant_3"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L556"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L556" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,T,Variant_4"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">SomeFloat</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L489"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L563"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L489" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L563" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,T,Variant_5"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">SomeGodot</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L497"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L571"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L497" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L571" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="variantType"><a name="variantType,typedesc[string]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">variantType</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">VariantType</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dt id="godotTypeInfo"><a name="godotTypeInfo,typedesc[string]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotTypeInfo</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">string</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotTypeInfo</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L552"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L629"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L552" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L629" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="toVariant"><a name="toVariant,string"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</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">Variant</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L555"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L632"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L555" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L632" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,string,Variant"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L558"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L635"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L558" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L635" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="variantType"><a name="variantType,typedesc[seq]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">variantType</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">VariantType</span></pre></dt>
|
||||
<dt id="godotTypeInfo"><a name="godotTypeInfo,typedesc[seq]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotTypeInfo</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotTypeInfo</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L566"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L659"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L566" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L659" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="variantType"><a name="variantType,typedesc[array]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">variantType</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">array</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">VariantType</span></pre></dt>
|
||||
<dt id="godotTypeInfo"><a name="godotTypeInfo,typedesc[array]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotTypeInfo</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">array</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotTypeInfo</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L569"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L662"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L569" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L662" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="toVariant"><a name="toVariant,openarray[T]"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Identifier">openarray</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Variant</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L572"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L665"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L572" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L665" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,seq[T],Variant"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L579"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L672"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L579" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L672" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,T,Variant_6"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">array</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L592"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L687"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L592" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L687" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="variantType"><a name="variantType,typedesc[]_2"></a><pre><span class="Keyword">proc</span> <span class="Identifier">variantType</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">Table</span> <span class="Operator">|</span> <span class="Identifier">TableRef</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">VariantType</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dt id="godotTypeInfo"><a name="godotTypeInfo,typedesc[]_2"></a><pre><span class="Keyword">proc</span> <span class="Identifier">godotTypeInfo</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><span class="Identifier">Table</span> <span class="Operator">|</span> <span class="Identifier">TableRef</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">GodotTypeInfo</span> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L605"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L705"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L605" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L705" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="toVariant"><a name="toVariant,T_3"></a><pre><span class="Keyword">proc</span> <span class="Identifier">toVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">Table</span> <span class="Keyword">or</span> <span class="Identifier">TableRef</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Variant</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L608"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L708"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L608" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L708" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="fromVariant"><a name="fromVariant,T,Variant_7"></a><pre><span class="Keyword">proc</span> <span class="Identifier">fromVariant</span><span class="Operator">*</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">Table</span> <span class="Keyword">or</span> <span class="Identifier">TableRef</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">Variant</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">ConversionResult</span></pre></dt>
|
||||
<dd>
|
||||
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L615"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L715"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L615" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L715" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="getNativeLibHandle"><a name="getNativeLibHandle,"></a><pre><span class="Keyword">proc</span> <span class="Identifier">getNativeLibHandle</span><span class="Operator">*</span><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">pointer</span></pre></dt>
|
||||
<dd>
|
||||
Returns NativeScript library handle used to register type information in Godot. Use only if you know what you are doing.
|
||||
Returns NativeScript library handle used to register type information in Godot.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L646"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L750"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L646" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L750" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
|
@ -1808,27 +1891,27 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<dd>
|
||||
Prints <tt class="docutils literal"><span class="pre">warning</span></tt> to Godot log, adding filename and line information.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L69"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L89"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L69" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L89" 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="Operator">*</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.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L74"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L94"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L74" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L94" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
<dt id="registerClass"><a name="registerClass.t,typedesc,cstring,bool"></a><pre><span class="Keyword">template</span> <span class="Identifier">registerClass</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">;</span> <span class="Identifier">godotClassName</span><span class="Other">:</span> <span class="Identifier">cstring</span><span class="Other">;</span> <span class="Identifier">native</span><span class="Other">:</span> <span class="Identifier">bool</span><span class="Other">)</span></pre></dt>
|
||||
<dd>
|
||||
Registers the specified Godot type. Used by <tt class="docutils literal"><span class="pre">gdobj</span></tt> macro and <a class="reference external" href="godotapigen.html">godotapigen</a>.
|
||||
<a
|
||||
href="https://github.com/pragmagic/godot-nim/tree/afa48455f6ee1871068adc6c2e948ed4b1cdccdf/godot/nim/godotnim.nim#L164"
|
||||
href="https://github.com/pragmagic/godot-nim/tree/327cd0e18fa5112909daa5f2b7d73565c46a1b0a/godot/nim/godotnim.nim#L185"
|
||||
class="link-seesrc" target="_blank">Source</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L164" class="link-seesrc" target="_blank" >Edit</a>
|
||||
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L185" class="link-seesrc" target="_blank" >Edit</a>
|
||||
|
||||
</dd>
|
||||
|
||||
|
|
@ -1841,7 +1924,7 @@ class="link-seesrc" target="_blank">Source</a>
|
|||
<div class="twelve-columns footer">
|
||||
<span class="nim-sprite"></span>
|
||||
<br/>
|
||||
<small>Made with Nim. Generated: 2017-08-04 06:45:23 UTC</small>
|
||||
<small>Made with Nim. Generated: 2017-08-06 12:49:55 UTC</small>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue