1934 lines
103 KiB
HTML
1934 lines
103 KiB
HTML
<?xml version="1.0" encoding="utf-8" ?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<!-- This file is generated by Nim. -->
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<!-- Favicon -->
|
|
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
|
|
|
<!-- Google fonts -->
|
|
<link href='https://fonts.googleapis.com/css?family=Raleway:400,600,900' rel='stylesheet' type='text/css'/>
|
|
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
|
|
|
<!-- CSS -->
|
|
<title>Module godotnim</title>
|
|
<style type="text/css" >
|
|
/*
|
|
Stylesheet for use with Docutils/rst2html.
|
|
|
|
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
|
customize this style sheet.
|
|
|
|
Modified from Chad Skeeters' rst2html-style
|
|
https://bitbucket.org/cskeeters/rst2html-style/
|
|
|
|
Modified by Boyd Greenfield
|
|
*/
|
|
/* SCSS variables */
|
|
/* Text weights */
|
|
/* Body colors */
|
|
/* Text colors */
|
|
/* Link colors */
|
|
/* Syntax highlighting colors */
|
|
/* Pct changes */
|
|
/* Mixins */
|
|
/* Body/layout */
|
|
html {
|
|
font-size: 100%;
|
|
-webkit-text-size-adjust: 100%;
|
|
-ms-text-size-adjust: 100%; }
|
|
|
|
/* Where we want fancier font if available */
|
|
h1, h2, h3, h4, h5, h6, p.module-desc, table.docinfo + blockquote p, table.docinfo blockquote p, h1 + blockquote p {
|
|
font-family: "Raleway", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important; }
|
|
|
|
h1.title {
|
|
font-weight: 900; }
|
|
|
|
body {
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
|
font-weight: 400;
|
|
font-size: 14px;
|
|
line-height: 20px;
|
|
color: #666;
|
|
background-color: rgba(252, 248, 244, 0.75); }
|
|
|
|
/* Skeleton grid */
|
|
.container {
|
|
position: relative;
|
|
width: 100%;
|
|
max-width: 960px;
|
|
margin: 0 auto;
|
|
padding: 0 20px;
|
|
box-sizing: border-box; }
|
|
|
|
.column,
|
|
.columns {
|
|
width: 100%;
|
|
float: left;
|
|
box-sizing: border-box; }
|
|
|
|
/* For devices larger than 400px */
|
|
@media (min-width: 400px) {
|
|
.container {
|
|
width: 100%;
|
|
padding: 0; } }
|
|
/* For devices larger than 650px */
|
|
@media (min-width: 650px) {
|
|
.container {
|
|
width: 100%; }
|
|
|
|
.column,
|
|
.columns {
|
|
margin-left: 4%; }
|
|
|
|
.column:first-child,
|
|
.columns:first-child {
|
|
margin-left: 0; }
|
|
|
|
.one.column,
|
|
.one.columns {
|
|
width: 4.66666666667%; }
|
|
|
|
.two.columns {
|
|
width: 13.3333333333%; }
|
|
|
|
.three.columns {
|
|
width: 22%; }
|
|
|
|
.four.columns {
|
|
width: 30.6666666667%; }
|
|
|
|
.five.columns {
|
|
width: 39.3333333333%; }
|
|
|
|
.six.columns {
|
|
width: 48%; }
|
|
|
|
.seven.columns {
|
|
width: 56.6666666667%; }
|
|
|
|
.eight.columns {
|
|
width: 65.3333333333%; }
|
|
|
|
.nine.columns {
|
|
width: 74.0%; }
|
|
|
|
.ten.columns {
|
|
width: 82.6666666667%; }
|
|
|
|
.eleven.columns {
|
|
width: 91.3333333333%; }
|
|
|
|
.twelve.columns {
|
|
width: 100%;
|
|
margin-left: 0; }
|
|
|
|
.one-third.column {
|
|
width: 30.6666666667%; }
|
|
|
|
.two-thirds.column {
|
|
width: 65.3333333333%; } }
|
|
/* Customer Overrides */
|
|
.footer {
|
|
text-align: center;
|
|
color: #969696;
|
|
padding-top: 10%; }
|
|
|
|
p.module-desc {
|
|
font-size: 1.1em;
|
|
color: #666666; }
|
|
|
|
a.link-seesrc {
|
|
color: #aec7d2;
|
|
font-style: italic; }
|
|
|
|
a.link-seesrc:hover {
|
|
color: #6c9aae; }
|
|
|
|
#toc-list {
|
|
word-wrap: break-word; }
|
|
|
|
ul.simple-toc {
|
|
list-style: none; }
|
|
|
|
ul.simple-toc a.reference-toplevel {
|
|
font-weight: bold;
|
|
color: #0077b3; }
|
|
|
|
ul.simple-toc-section {
|
|
list-style-type: circle;
|
|
color: #6c9aae; }
|
|
|
|
ul.simple-toc-section a.reference {
|
|
color: #0077b3; }
|
|
|
|
cite {
|
|
font-style: italic !important; }
|
|
|
|
dt > pre {
|
|
border-color: rgba(0, 0, 0, 0.15);
|
|
background-color: transparent;
|
|
margin: 15px 0px 5px; }
|
|
|
|
dd > pre {
|
|
border-color: rgba(0, 0, 0, 0.1);
|
|
background-color: whitesmoke;
|
|
margin-top: 8px; }
|
|
|
|
.item > dd {
|
|
margin-left: 10px;
|
|
margin-bottom: 30px; }
|
|
|
|
/* Nim line-numbered tables */
|
|
.line-nums-table {
|
|
width: 100%;
|
|
table-layout: fixed; }
|
|
|
|
table.line-nums-table {
|
|
border-radius: 4px;
|
|
border: 1px solid #cccccc;
|
|
background-color: whitesmoke;
|
|
border-collapse: separate;
|
|
margin-top: 15px;
|
|
margin-bottom: 25px; }
|
|
|
|
.line-nums-table tbody {
|
|
border: none; }
|
|
|
|
.line-nums-table td pre {
|
|
border: none;
|
|
background-color: transparent; }
|
|
|
|
.line-nums-table td.blob-line-nums {
|
|
width: 28px; }
|
|
|
|
.line-nums-table td.blob-line-nums pre {
|
|
color: #b0b0b0;
|
|
-webkit-filter: opacity(75%);
|
|
text-align: right;
|
|
border-color: transparent;
|
|
background-color: transparent;
|
|
padding-left: 0px;
|
|
margin-left: 0px;
|
|
padding-right: 0px;
|
|
margin-right: 0px; }
|
|
|
|
/* Docgen styles */
|
|
/* Links */
|
|
a {
|
|
color: #0077b3;
|
|
text-decoration: none; }
|
|
|
|
a:hover,
|
|
a:focus {
|
|
color: #00334d;
|
|
text-decoration: underline; }
|
|
|
|
a:visited {
|
|
color: #00334d; }
|
|
|
|
a:focus {
|
|
outline: thin dotted #2d2d2d;
|
|
outline: 5px auto -webkit-focus-ring-color;
|
|
outline-offset: -2px; }
|
|
|
|
a:hover,
|
|
a:active {
|
|
outline: 0; }
|
|
|
|
sub,
|
|
sup {
|
|
position: relative;
|
|
font-size: 75%;
|
|
line-height: 0;
|
|
vertical-align: baseline; }
|
|
|
|
sup {
|
|
top: -0.5em; }
|
|
|
|
sub {
|
|
bottom: -0.25em; }
|
|
|
|
img {
|
|
width: auto;
|
|
height: auto;
|
|
max-width: 100%;
|
|
vertical-align: middle;
|
|
border: 0;
|
|
-ms-interpolation-mode: bicubic; }
|
|
|
|
@media print {
|
|
* {
|
|
color: black !important;
|
|
text-shadow: none !important;
|
|
background: transparent !important;
|
|
box-shadow: none !important; }
|
|
|
|
a,
|
|
a:visited {
|
|
text-decoration: underline; }
|
|
|
|
a[href]:after {
|
|
content: " (" attr(href) ")"; }
|
|
|
|
abbr[title]:after {
|
|
content: " (" attr(title) ")"; }
|
|
|
|
.ir a:after,
|
|
a[href^="javascript:"]:after,
|
|
a[href^="#"]:after {
|
|
content: ""; }
|
|
|
|
pre,
|
|
blockquote {
|
|
border: 1px solid #999;
|
|
page-break-inside: avoid; }
|
|
|
|
thead {
|
|
display: table-header-group; }
|
|
|
|
tr,
|
|
img {
|
|
page-break-inside: avoid; }
|
|
|
|
img {
|
|
max-width: 100% !important; }
|
|
|
|
@page {
|
|
margin: 0.5cm; }
|
|
|
|
h1 {
|
|
page-break-before: always; }
|
|
|
|
h1.title {
|
|
page-break-before: avoid; }
|
|
|
|
p,
|
|
h2,
|
|
h3 {
|
|
orphans: 3;
|
|
widows: 3; }
|
|
|
|
h2,
|
|
h3 {
|
|
page-break-after: avoid; } }
|
|
.img-rounded {
|
|
-webkit-border-radius: 6px;
|
|
-moz-border-radius: 6px;
|
|
border-radius: 6px; }
|
|
|
|
.img-polaroid {
|
|
padding: 4px;
|
|
background-color: rgba(252, 248, 244, 0.75);
|
|
border: 1px solid #ccc;
|
|
border: 1px solid rgba(0, 0, 0, 0.2);
|
|
-webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
|
-moz-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
|
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1); }
|
|
|
|
p {
|
|
margin: 0 0 12px; }
|
|
|
|
small {
|
|
font-size: 85%; }
|
|
|
|
strong {
|
|
font-weight: 600; }
|
|
|
|
em {
|
|
font-style: italic; }
|
|
|
|
cite {
|
|
font-style: normal; }
|
|
|
|
h1,
|
|
h2,
|
|
h3,
|
|
h4,
|
|
h5,
|
|
h6 {
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
|
font-weight: 600;
|
|
line-height: 20px;
|
|
color: inherit;
|
|
text-rendering: optimizelegibility; }
|
|
|
|
h1 {
|
|
font-size: 2em;
|
|
padding-bottom: .15em;
|
|
border-bottom: 1px solid #aaaaaa;
|
|
margin-top: 1.0em;
|
|
line-height: 1.2em; }
|
|
|
|
h1.title {
|
|
padding-bottom: 1em;
|
|
border-bottom: 0px;
|
|
font-size: 2.75em; }
|
|
|
|
h2 {
|
|
font-size: 1.5em;
|
|
margin-top: 1.5em; }
|
|
|
|
h3 {
|
|
font-size: 1.3em;
|
|
font-style: italic;
|
|
margin-top: 0.75em; }
|
|
|
|
h4 {
|
|
font-size: 1.3em;
|
|
margin-top: 0.5em; }
|
|
|
|
h5 {
|
|
font-size: 1.2em;
|
|
margin-top: 0.25em; }
|
|
|
|
h6 {
|
|
font-size: 1.1em; }
|
|
|
|
ul,
|
|
ol {
|
|
padding: 0;
|
|
margin: 0 0 0px 15px; }
|
|
|
|
ul ul,
|
|
ul ol,
|
|
ol ol,
|
|
ol ul {
|
|
margin-bottom: 0; }
|
|
|
|
li {
|
|
line-height: 20px; }
|
|
|
|
dl {
|
|
margin-bottom: 20px; }
|
|
|
|
dt,
|
|
dd {
|
|
line-height: 20px; }
|
|
|
|
dt {
|
|
font-weight: bold; }
|
|
|
|
dd {
|
|
margin-left: 10px;
|
|
margin-bottom: 26px; }
|
|
|
|
hr {
|
|
margin: 20px 0;
|
|
border: 0;
|
|
border-top: 1px solid #eeeeee;
|
|
border-bottom: 1px solid #ffffff; }
|
|
|
|
abbr[title],
|
|
abbr[data-original-title] {
|
|
cursor: help;
|
|
border-bottom: 1px dotted #999999; }
|
|
|
|
abbr.initialism {
|
|
font-size: 90%;
|
|
text-transform: uppercase; }
|
|
|
|
blockquote {
|
|
padding: 0 0 0 15px;
|
|
margin: 0 0 20px;
|
|
border-left: 5px solid #EFEBE0; }
|
|
|
|
table.docinfo + blockquote, table.docinfo blockquote, h1 + blockquote {
|
|
border-left: 5px solid #c9c9c9;
|
|
}
|
|
|
|
table.docinfo + blockquote p, table.docinfo blockquote p, h1 + blockquote p {
|
|
margin-bottom: 0;
|
|
font-size: 15px;
|
|
font-weight: 200;
|
|
line-height: 1.5;
|
|
font-style: italic; }
|
|
|
|
q:before,
|
|
q:after,
|
|
blockquote:before,
|
|
blockquote:after {
|
|
content: ""; }
|
|
|
|
address {
|
|
display: block;
|
|
margin-bottom: 20px;
|
|
font-style: normal;
|
|
line-height: 20px; }
|
|
|
|
code,
|
|
pre {
|
|
font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace;
|
|
padding: 0 3px 2px;
|
|
font-weight: 500;
|
|
font-size: 12px;
|
|
color: #444444;
|
|
-webkit-border-radius: 3px;
|
|
-moz-border-radius: 3px;
|
|
border-radius: 3px; }
|
|
|
|
.pre {
|
|
font-family: "Source Code Pro", Monaco, Menlo, Consolas, "Courier New", monospace;
|
|
font-weight: 600;
|
|
/*color: #504da6;*/
|
|
}
|
|
|
|
code {
|
|
padding: 2px 4px;
|
|
color: #444444;
|
|
white-space: nowrap;
|
|
background-color: white;
|
|
border: 1px solid #777777; }
|
|
|
|
pre {
|
|
display: inline-block;
|
|
box-sizing: border-box;
|
|
min-width: calc(100% - 19.5px);
|
|
padding: 9.5px;
|
|
margin: 0.25em 10px 0.25em 10px;
|
|
font-size: 14px;
|
|
line-height: 20px;
|
|
white-space: pre !important;
|
|
overflow-y: hidden;
|
|
overflow-x: visible;
|
|
background-color: whitesmoke;
|
|
border: 1px solid #cccccc;
|
|
-webkit-border-radius: 4px;
|
|
-moz-border-radius: 4px;
|
|
border-radius: 4px; }
|
|
|
|
pre.prettyprint {
|
|
margin-bottom: 20px; }
|
|
|
|
pre code {
|
|
padding: 0;
|
|
color: inherit;
|
|
white-space: pre;
|
|
overflow-x: visible;
|
|
background-color: transparent;
|
|
border: 0; }
|
|
|
|
.pre-scrollable {
|
|
max-height: 340px;
|
|
overflow-y: scroll; }
|
|
|
|
table {
|
|
max-width: 100%;
|
|
background-color: transparent;
|
|
border-collapse: collapse;
|
|
border-spacing: 0; }
|
|
|
|
table th, table td {
|
|
padding: 0px 8px 0px;
|
|
}
|
|
|
|
.table {
|
|
width: 100%;
|
|
margin-bottom: 20px; }
|
|
|
|
.table th,
|
|
.table td {
|
|
padding: 8px;
|
|
line-height: 20px;
|
|
text-align: left;
|
|
vertical-align: top;
|
|
border-top: 1px solid #444444; }
|
|
|
|
.table th {
|
|
font-weight: bold; }
|
|
|
|
.table thead th {
|
|
vertical-align: bottom; }
|
|
|
|
.table caption + thead tr:first-child th,
|
|
.table caption + thead tr:first-child td,
|
|
.table colgroup + thead tr:first-child th,
|
|
.table colgroup + thead tr:first-child td,
|
|
.table thead:first-child tr:first-child th,
|
|
.table thead:first-child tr:first-child td {
|
|
border-top: 0; }
|
|
|
|
.table tbody + tbody {
|
|
border-top: 2px solid #444444; }
|
|
|
|
.table .table {
|
|
background-color: rgba(252, 248, 244, 0.75); }
|
|
|
|
.table-condensed th,
|
|
.table-condensed td {
|
|
padding: 4px 5px; }
|
|
|
|
.table-bordered {
|
|
border: 1px solid #444444;
|
|
border-collapse: separate;
|
|
*border-collapse: collapse;
|
|
border-left: 0;
|
|
-webkit-border-radius: 4px;
|
|
-moz-border-radius: 4px;
|
|
border-radius: 4px; }
|
|
|
|
.table-bordered th,
|
|
.table-bordered td {
|
|
border-left: 1px solid #444444; }
|
|
|
|
.table-bordered caption + thead tr:first-child th,
|
|
.table-bordered caption + tbody tr:first-child th,
|
|
.table-bordered caption + tbody tr:first-child td,
|
|
.table-bordered colgroup + thead tr:first-child th,
|
|
.table-bordered colgroup + tbody tr:first-child th,
|
|
.table-bordered colgroup + tbody tr:first-child td,
|
|
.table-bordered thead:first-child tr:first-child th,
|
|
.table-bordered tbody:first-child tr:first-child th,
|
|
.table-bordered tbody:first-child tr:first-child td {
|
|
border-top: 0; }
|
|
|
|
.table-bordered thead:first-child tr:first-child > th:first-child,
|
|
.table-bordered tbody:first-child tr:first-child > td:first-child,
|
|
.table-bordered tbody:first-child tr:first-child > th:first-child {
|
|
-webkit-border-top-left-radius: 4px;
|
|
border-top-left-radius: 4px;
|
|
-moz-border-radius-topleft: 4px; }
|
|
|
|
.table-bordered thead:first-child tr:first-child > th:last-child,
|
|
.table-bordered tbody:first-child tr:first-child > td:last-child,
|
|
.table-bordered tbody:first-child tr:first-child > th:last-child {
|
|
-webkit-border-top-right-radius: 4px;
|
|
border-top-right-radius: 4px;
|
|
-moz-border-radius-topright: 4px; }
|
|
|
|
.table-bordered thead:last-child tr:last-child > th:first-child,
|
|
.table-bordered tbody:last-child tr:last-child > td:first-child,
|
|
.table-bordered tbody:last-child tr:last-child > th:first-child,
|
|
.table-bordered tfoot:last-child tr:last-child > td:first-child,
|
|
.table-bordered tfoot:last-child tr:last-child > th:first-child {
|
|
-webkit-border-bottom-left-radius: 4px;
|
|
border-bottom-left-radius: 4px;
|
|
-moz-border-radius-bottomleft: 4px; }
|
|
|
|
.table-bordered thead:last-child tr:last-child > th:last-child,
|
|
.table-bordered tbody:last-child tr:last-child > td:last-child,
|
|
.table-bordered tbody:last-child tr:last-child > th:last-child,
|
|
.table-bordered tfoot:last-child tr:last-child > td:last-child,
|
|
.table-bordered tfoot:last-child tr:last-child > th:last-child {
|
|
-webkit-border-bottom-right-radius: 4px;
|
|
border-bottom-right-radius: 4px;
|
|
-moz-border-radius-bottomright: 4px; }
|
|
|
|
.table-bordered tfoot + tbody:last-child tr:last-child td:first-child {
|
|
-webkit-border-bottom-left-radius: 0;
|
|
border-bottom-left-radius: 0;
|
|
-moz-border-radius-bottomleft: 0; }
|
|
|
|
.table-bordered tfoot + tbody:last-child tr:last-child td:last-child {
|
|
-webkit-border-bottom-right-radius: 0;
|
|
border-bottom-right-radius: 0;
|
|
-moz-border-radius-bottomright: 0; }
|
|
|
|
.table-bordered caption + thead tr:first-child th:first-child,
|
|
.table-bordered caption + tbody tr:first-child td:first-child,
|
|
.table-bordered colgroup + thead tr:first-child th:first-child,
|
|
.table-bordered colgroup + tbody tr:first-child td:first-child {
|
|
-webkit-border-top-left-radius: 4px;
|
|
border-top-left-radius: 4px;
|
|
-moz-border-radius-topleft: 4px; }
|
|
|
|
.table-bordered caption + thead tr:first-child th:last-child,
|
|
.table-bordered caption + tbody tr:first-child td:last-child,
|
|
.table-bordered colgroup + thead tr:first-child th:last-child,
|
|
.table-bordered colgroup + tbody tr:first-child td:last-child {
|
|
-webkit-border-top-right-radius: 4px;
|
|
border-top-right-radius: 4px;
|
|
-moz-border-radius-topright: 4px; }
|
|
|
|
table.docutils th {
|
|
background-color: #e8e8e8; }
|
|
|
|
table.docutils tr:hover {
|
|
background-color: whitesmoke; }
|
|
|
|
.table-striped tbody > tr:nth-child(odd) > td,
|
|
.table-striped tbody > tr:nth-child(odd) > th {
|
|
background-color: rgba(252, 248, 244, 0.75); }
|
|
|
|
.table-hover tbody tr:hover > td,
|
|
.table-hover tbody tr:hover > th {
|
|
background-color: rgba(241, 222, 204, 0.75); }
|
|
|
|
table td[class*="span"],
|
|
table th[class*="span"],
|
|
.row-fluid table td[class*="span"],
|
|
.row-fluid table th[class*="span"] {
|
|
display: table-cell;
|
|
float: none;
|
|
margin-left: 0; }
|
|
|
|
.hero-unit {
|
|
padding: 60px;
|
|
margin-bottom: 30px;
|
|
font-size: 18px;
|
|
font-weight: 200;
|
|
line-height: 30px;
|
|
color: inherit;
|
|
background-color: rgba(230, 197, 164, 0.75);
|
|
-webkit-border-radius: 6px;
|
|
-moz-border-radius: 6px;
|
|
border-radius: 6px; }
|
|
|
|
.hero-unit h1 {
|
|
margin-bottom: 0;
|
|
font-size: 60px;
|
|
line-height: 1;
|
|
letter-spacing: -1px;
|
|
color: inherit; }
|
|
|
|
.hero-unit li {
|
|
line-height: 30px; }
|
|
|
|
/* rst2html default used to remove borders from tables and images */
|
|
.borderless, table.borderless td, table.borderless th {
|
|
border: 0; }
|
|
|
|
table.borderless td, table.borderless th {
|
|
/* Override padding for "table.docutils td" with "! important".
|
|
The right padding separates the table cells. */
|
|
padding: 0 0.5em 0 0 !important; }
|
|
|
|
.first {
|
|
/* Override more specific margin styles with "! important". */
|
|
margin-top: 0 !important; }
|
|
|
|
.last, .with-subtitle {
|
|
margin-bottom: 0 !important; }
|
|
|
|
.hidden {
|
|
display: none; }
|
|
|
|
a.toc-backref {
|
|
text-decoration: none;
|
|
color: #444444; }
|
|
|
|
blockquote.epigraph {
|
|
margin: 2em 5em; }
|
|
|
|
dl.docutils dd {
|
|
margin-bottom: 0.5em; }
|
|
|
|
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
|
overflow: hidden; }
|
|
|
|
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
|
dl.docutils dt {
|
|
font-weight: bold }
|
|
*/
|
|
div.abstract {
|
|
margin: 2em 5em; }
|
|
|
|
div.abstract p.topic-title {
|
|
font-weight: bold;
|
|
text-align: center; }
|
|
|
|
div.admonition, div.attention, div.caution, div.danger, div.error,
|
|
div.hint, div.important, div.note, div.tip, div.warning {
|
|
margin: 2em;
|
|
border: medium outset;
|
|
padding: 1em; }
|
|
|
|
div.note, div.warning {
|
|
margin: 1.5em 0px;
|
|
border: none; }
|
|
|
|
div.note p.admonition-title,
|
|
div.warning p.admonition-title {
|
|
display: none; }
|
|
|
|
/* Clearfix
|
|
* http://css-tricks.com/snippets/css/clear-fix/
|
|
*/
|
|
div.note:after,
|
|
div.warning:after {
|
|
content: "";
|
|
display: table;
|
|
clear: both; }
|
|
|
|
div.note p:before,
|
|
div.warning p:before {
|
|
display: block;
|
|
float: left;
|
|
font-size: 4em;
|
|
line-height: 1em;
|
|
margin-right: 20px;
|
|
margin-left: 0em;
|
|
margin-top: -10px;
|
|
content: '\0270D';
|
|
/*handwriting*/ }
|
|
|
|
div.warning p:before {
|
|
content: '\026A0';
|
|
/*warning*/ }
|
|
|
|
div.admonition p.admonition-title, div.hint p.admonition-title,
|
|
div.important p.admonition-title, div.note p.admonition-title,
|
|
div.tip p.admonition-title {
|
|
font-weight: bold;
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif; }
|
|
|
|
div.attention p.admonition-title, div.caution p.admonition-title,
|
|
div.danger p.admonition-title, div.error p.admonition-title,
|
|
div.warning p.admonition-title, .code .error {
|
|
color: #b30000;
|
|
font-weight: bold;
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif; }
|
|
|
|
/* Uncomment (and remove this text!) to get reduced vertical space in
|
|
compound paragraphs.
|
|
div.compound .compound-first, div.compound .compound-middle {
|
|
margin-bottom: 0.5em }
|
|
|
|
div.compound .compound-last, div.compound .compound-middle {
|
|
margin-top: 0.5em }
|
|
*/
|
|
div.dedication {
|
|
margin: 2em 5em;
|
|
text-align: center;
|
|
font-style: italic; }
|
|
|
|
div.dedication p.topic-title {
|
|
font-weight: bold;
|
|
font-style: normal; }
|
|
|
|
div.figure {
|
|
margin-left: 2em;
|
|
margin-right: 2em; }
|
|
|
|
div.footer, div.header {
|
|
clear: both;
|
|
font-size: smaller; }
|
|
|
|
div.line-block {
|
|
display: block;
|
|
margin-top: 1em;
|
|
margin-bottom: 1em; }
|
|
|
|
div.line-block div.line-block {
|
|
margin-top: 0;
|
|
margin-bottom: 0;
|
|
margin-left: 1.5em; }
|
|
|
|
div.sidebar {
|
|
margin: 0 0 0.5em 1em;
|
|
border: medium outset;
|
|
padding: 1em;
|
|
background-color: rgba(252, 248, 244, 0.75);
|
|
width: 40%;
|
|
float: right;
|
|
clear: right; }
|
|
|
|
div.sidebar p.rubric {
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
|
font-size: medium; }
|
|
|
|
div.system-messages {
|
|
margin: 5em; }
|
|
|
|
div.system-messages h1 {
|
|
color: #b30000; }
|
|
|
|
div.system-message {
|
|
border: medium outset;
|
|
padding: 1em; }
|
|
|
|
div.system-message p.system-message-title {
|
|
color: #b30000;
|
|
font-weight: bold; }
|
|
|
|
div.topic {
|
|
margin: 2em; }
|
|
|
|
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
|
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
|
margin-top: 0.4em; }
|
|
|
|
h1.title {
|
|
text-align: center; }
|
|
|
|
h2.subtitle {
|
|
text-align: center; }
|
|
|
|
hr.docutils {
|
|
width: 75%; }
|
|
|
|
img.align-left, .figure.align-left, object.align-left {
|
|
clear: left;
|
|
float: left;
|
|
margin-right: 1em; }
|
|
|
|
img.align-right, .figure.align-right, object.align-right {
|
|
clear: right;
|
|
float: right;
|
|
margin-left: 1em; }
|
|
|
|
img.align-center, .figure.align-center, object.align-center {
|
|
display: block;
|
|
margin-left: auto;
|
|
margin-right: auto; }
|
|
|
|
.align-left {
|
|
text-align: left; }
|
|
|
|
.align-center {
|
|
clear: both;
|
|
text-align: center; }
|
|
|
|
.align-right {
|
|
text-align: right; }
|
|
|
|
/* reset inner alignment in figures */
|
|
div.align-right {
|
|
text-align: inherit; }
|
|
|
|
/* div.align-center * { */
|
|
/* text-align: left } */
|
|
|
|
ul.simple > li {
|
|
margin-bottom: 0.5em }
|
|
|
|
ol.simple, ul.simple {
|
|
margin-bottom: 1em; }
|
|
|
|
ol.arabic {
|
|
list-style: decimal; }
|
|
|
|
ol.loweralpha {
|
|
list-style: lower-alpha; }
|
|
|
|
ol.upperalpha {
|
|
list-style: upper-alpha; }
|
|
|
|
ol.lowerroman {
|
|
list-style: lower-roman; }
|
|
|
|
ol.upperroman {
|
|
list-style: upper-roman; }
|
|
|
|
p.attribution {
|
|
text-align: right;
|
|
margin-left: 50%; }
|
|
|
|
p.caption {
|
|
font-style: italic; }
|
|
|
|
p.credits {
|
|
font-style: italic;
|
|
font-size: smaller; }
|
|
|
|
p.label {
|
|
white-space: nowrap; }
|
|
|
|
p.rubric {
|
|
font-weight: bold;
|
|
font-size: larger;
|
|
color: maroon;
|
|
text-align: center; }
|
|
|
|
p.sidebar-title {
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
|
font-weight: bold;
|
|
font-size: larger; }
|
|
|
|
p.sidebar-subtitle {
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
|
font-weight: bold; }
|
|
|
|
p.topic-title {
|
|
font-weight: bold; }
|
|
|
|
pre.address {
|
|
margin-bottom: 0;
|
|
margin-top: 0;
|
|
font: inherit; }
|
|
|
|
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
|
margin-left: 2em;
|
|
margin-right: 2em; }
|
|
|
|
pre.code .ln {
|
|
color: grey; }
|
|
|
|
/* line numbers */
|
|
pre.code, code {
|
|
background-color: #eeeeee; }
|
|
|
|
pre.code .comment, code .comment {
|
|
color: #5c6576; }
|
|
|
|
pre.code .keyword, code .keyword {
|
|
color: #3B0D06;
|
|
font-weight: bold; }
|
|
|
|
pre.code .literal.string, code .literal.string {
|
|
color: #0c5404; }
|
|
|
|
pre.code .name.builtin, code .name.builtin {
|
|
color: #352b84; }
|
|
|
|
pre.code .deleted, code .deleted {
|
|
background-color: #DEB0A1; }
|
|
|
|
pre.code .inserted, code .inserted {
|
|
background-color: #A3D289; }
|
|
|
|
span.classifier {
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
|
font-style: oblique; }
|
|
|
|
span.classifier-delimiter {
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif;
|
|
font-weight: bold; }
|
|
|
|
span.interpreted {
|
|
font-family: "Helvetica Neue", "HelveticaNeue", "Raleway", Helvetica, Arial, sans-serif; }
|
|
|
|
span.option {
|
|
white-space: nowrap; }
|
|
|
|
span.pre {
|
|
white-space: pre; }
|
|
|
|
span.problematic {
|
|
color: #b30000; }
|
|
|
|
span.section-subtitle {
|
|
/* font-size relative to parent (h1..h6 element) */
|
|
font-size: 80%; }
|
|
|
|
table.citation {
|
|
border-left: solid 1px #666666;
|
|
margin-left: 1px; }
|
|
|
|
table.docinfo {
|
|
margin: 0em;
|
|
margin-top: 2em;
|
|
margin-bottom: 2em;
|
|
font-family: "Raleway", "Helvetica Neue", "HelveticaNeue", Helvetica, Arial, sans-serif !important;
|
|
color: #444444; }
|
|
|
|
table.docutils {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0.5em; }
|
|
|
|
table.footnote {
|
|
border-left: solid 1px #2d2d2d;
|
|
margin-left: 1px; }
|
|
|
|
table.docutils td, table.docutils th,
|
|
table.docinfo td, table.docinfo th {
|
|
padding-left: 0.5em;
|
|
padding-right: 0.5em;
|
|
vertical-align: top; }
|
|
|
|
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
|
font-weight: 700;
|
|
text-align: left;
|
|
white-space: nowrap;
|
|
padding-left: 0; }
|
|
|
|
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
|
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
|
font-size: 100%; }
|
|
|
|
ul.auto-toc {
|
|
list-style-type: none; }
|
|
|
|
span.DecNumber {
|
|
color: #252dbe; }
|
|
|
|
span.BinNumber {
|
|
color: #252dbe; }
|
|
|
|
span.HexNumber {
|
|
color: #252dbe; }
|
|
|
|
span.OctNumber {
|
|
color: #252dbe; }
|
|
|
|
span.FloatNumber {
|
|
color: #252dbe; }
|
|
|
|
span.Identifier {
|
|
color: #3b3b3b; }
|
|
|
|
span.Keyword {
|
|
font-weight: 600;
|
|
color: #5e8f60; }
|
|
|
|
span.StringLit {
|
|
color: #a4255b; }
|
|
|
|
span.LongStringLit {
|
|
color: #a4255b; }
|
|
|
|
span.CharLit {
|
|
color: #a4255b; }
|
|
|
|
span.EscapeSequence {
|
|
color: black; }
|
|
|
|
span.Operator {
|
|
color: black; }
|
|
|
|
span.Punctuation {
|
|
color: black; }
|
|
|
|
span.Comment, span.LongComment {
|
|
font-style: italic;
|
|
font-weight: 400;
|
|
color: #484a86; }
|
|
|
|
span.RegularExpression {
|
|
color: darkviolet; }
|
|
|
|
span.TagStart {
|
|
color: darkviolet; }
|
|
|
|
span.TagEnd {
|
|
color: darkviolet; }
|
|
|
|
span.Key {
|
|
color: #252dbe; }
|
|
|
|
span.Value {
|
|
color: #252dbe; }
|
|
|
|
span.RawData {
|
|
color: #a4255b; }
|
|
|
|
span.Assembler {
|
|
color: #252dbe; }
|
|
|
|
span.Preprocessor {
|
|
color: #252dbe; }
|
|
|
|
span.Directive {
|
|
color: #252dbe; }
|
|
|
|
span.Command, span.Rule, span.Hyperlink, span.Label, span.Reference,
|
|
span.Other {
|
|
color: black; }
|
|
|
|
/* Pop type, const, proc, and iterator defs in nim def blocks */
|
|
dt pre > span.Identifier, dt pre > span.Operator {
|
|
color: #155da4;
|
|
font-weight: 700; }
|
|
|
|
dt pre > span.Identifier ~ span.Identifier, dt pre > span.Operator ~ span.Identifier {
|
|
color: inherit;
|
|
font-weight: inherit; }
|
|
|
|
dt pre > span.Operator ~ span.Identifier, dt pre > span.Operator ~ span.Operator {
|
|
color: inherit;
|
|
font-weight: inherit; }
|
|
|
|
/* Nim sprite for the footer (taken from main page favicon) */
|
|
.nim-sprite {
|
|
display: inline-block;
|
|
height: 12px;
|
|
width: 12px;
|
|
background-position: 0 0;
|
|
background-size: 12px 12px;
|
|
-webkit-filter: opacity(50%);
|
|
background-repeat: no-repeat;
|
|
background-image: url("data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA==");
|
|
margin-bottom: -5px; }
|
|
div.pragma {
|
|
display: none;
|
|
}
|
|
span.pragmabegin {
|
|
cursor: pointer;
|
|
}
|
|
span.pragmaend {
|
|
cursor: pointer;
|
|
}
|
|
|
|
div.search_results {
|
|
background-color: antiquewhite;
|
|
margin: 3em;
|
|
padding: 1em;
|
|
border: 1px solid #4d4d4d;
|
|
}
|
|
</style>
|
|
|
|
<script type="text/javascript" src="../dochack.js"></script>
|
|
|
|
<script type="text/javascript">
|
|
function togglepragma(d) {
|
|
if (d.style.display != 'inline')
|
|
d.style.display = 'inline';
|
|
else
|
|
d.style.display = 'none';
|
|
}
|
|
|
|
function main() {
|
|
var elements = document.getElementsByClassName("pragmabegin");
|
|
for (var i = 0; i < elements.length; ++i) {
|
|
var e = elements[i];
|
|
e.onclick = function(event) {
|
|
togglepragma(event.target.nextSibling);
|
|
};
|
|
}
|
|
var elements = document.getElementsByClassName("pragmaend");
|
|
for (var i = 0; i < elements.length; ++i) {
|
|
var e = elements[i];
|
|
e.onclick = function(event) {
|
|
togglepragma(event.target.previousSibling);
|
|
};
|
|
}
|
|
}
|
|
</script>
|
|
|
|
</head>
|
|
<body onload="main()">
|
|
<div class="document" id="documentId">
|
|
<div class="container">
|
|
<h1 class="title">Module godotnim</h1>
|
|
<div class="row">
|
|
<div class="three columns">
|
|
<div>
|
|
Search: <input type="text" id="searchInput"
|
|
onkeyup="search()" />
|
|
</div>
|
|
<div>
|
|
Group by:
|
|
<select onchange="groupBy(this.value)">
|
|
<option value="section">Section</option>
|
|
<option value="type">Type</option>
|
|
</select>
|
|
</div>
|
|
<ul class="simple simple-toc" id="toc-list">
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
|
|
<ul class="simple simple-toc-section">
|
|
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
|
|
<ul class="simple simple-toc-section">
|
|
<li><a class="reference" href="#NimGodotObject"
|
|
title="NimGodotObject* = ref object of RootObj
|
|
godotObject: ptr GodotObject
|
|
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
|
|
RangeError ## Types match, but the value is out of range.
|
|
## Mainly used for numeric (ordinal) types."><wbr />Conversion<wbr />Result<span class="attachedType" style="visibility:hidden"></span></a></li>
|
|
<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="#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>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
|
<ul class="simple simple-toc-section">
|
|
<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="#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"
|
|
title="asObject*[T: NimGodotObject](v: Variant): T"><wbr />as<wbr />Object<span class="attachedType" style="visibility:hidden"></span></a></li>
|
|
<li><a class="reference" href="#asObject,Variant,typedesc[NimGodotObject]"
|
|
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,"
|
|
title="gdnew*[T: NimGodotObject](): T"><wbr />gdnew<span class="attachedType" style="visibility:hidden"></span></a></li>
|
|
<li><a class="reference" href="#newCallError,VariantCallError"
|
|
title="newCallError*(err: VariantCallError): ref CallError"><wbr />new<wbr />Call<wbr />Error<span class="attachedType" style="visibility:hidden"></span></a></li>
|
|
<li><a class="reference" href="#newConversionError,ConversionResult"
|
|
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="#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="#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="#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="#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_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="#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="#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="#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"
|
|
title="fromVariant*[T: Table or TableRef](t: var T; val: Variant): ConversionResult"><wbr />from<wbr />Variant<span class="attachedType" style="visibility:hidden"></span></a></li>
|
|
<li><a class="reference" href="#getNativeLibHandle,"
|
|
title="getNativeLibHandle*(): pointer"><wbr />get<wbr />Native<wbr />Lib<wbr />Handle<span class="attachedType" style="visibility:hidden"></span></a></li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="reference reference-toplevel" href="#17" id="67">Templates</a>
|
|
<ul class="simple simple-toc-section">
|
|
<li><a class="reference" href="#printWarning.t,typed"
|
|
title="printWarning*(warning: typed)"><wbr />print<wbr />Warning<span class="attachedType" style="visibility:hidden"></span></a></li>
|
|
<li><a class="reference" href="#printError.t,typed"
|
|
title="printError*(error: typed)"><wbr />print<wbr />Error<span class="attachedType" style="visibility:hidden"></span></a></li>
|
|
<li><a class="reference" href="#registerClass.t,typedesc,cstring,bool"
|
|
title="registerClass*(T: typedesc; godotClassName: cstring; native: bool)"><wbr />register<wbr />Class<span class="attachedType" style="visibility:hidden"></span></a></li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
<div class="nine columns" id="content">
|
|
<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">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>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">
|
|
<a class="reference external" href="tables.html">tables</a>, <a class="reference external" href="typetraits.html">typetraits</a>, <a class="reference external" href="macros.html">macros</a>, <a class="reference external" href="asyncdispatch.html">asyncdispatch</a>, <a class="reference external" href="godotbase.html">core/godotbase</a>, <a class="reference external" href="vector2.html">core/vector2</a>, <a class="reference external" href="rect2.html">core/rect2</a>, <a class="reference external" href="vector3.html">core/vector3</a>, <a class="reference external" href="transform2d.html">core/transform2d</a>, <a class="reference external" href="planes.html">core/planes</a>, <a class="reference external" href="quats.html">core/quats</a>, <a class="reference external" href="rect3.html">core/rect3</a>, <a class="reference external" href="basis.html">core/basis</a>, <a class="reference external" href="transforms.html">core/transforms</a>, <a class="reference external" href="colors.html">core/colors</a>, <a class="reference external" href="nodepaths.html">core/nodepaths</a>, <a class="reference external" href="rids.html">core/rids</a>, <a class="reference external" href="dictionaries.html">core/dictionaries</a>, <a class="reference external" href="arrays.html">core/arrays</a>, <a class="reference external" href="poolarrays.html">core/poolarrays</a>, <a class="reference external" href="variants.html">core/variants</a>, <a class="reference external" href="godotinternal.html">godotinternal</a>
|
|
</dl></div>
|
|
<div class="section" id="7">
|
|
<h1><a class="toc-backref" href="#7">Types</a></h1>
|
|
<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>
|
|
</pre></dt>
|
|
<dd>
|
|
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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#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>
|
|
<span class="Identifier">OK</span><span class="Other">,</span> <span class="Identifier">TypeError</span><span class="Other">,</span> <span class="Comment">## Type mismatch</span>
|
|
<span class="Identifier">RangeError</span> <span class="Comment">## Types match, but the value is out of range.</span>
|
|
<span class="Comment">## Mainly used for numeric (ordinal) types.</span></pre></dt>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#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>
|
|
<span class="Identifier">err</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">VariantCallError</span> <span class="Comment">## The error as returned by Godot</span>
|
|
</pre></dt>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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>
|
|
|
|
</dl></div>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#L118" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
|
|
</dl></div>
|
|
<div class="section" id="12">
|
|
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
|
<dl class="item">
|
|
<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 concatenated <tt class="docutils literal"><span class="pre">parts</span></tt> to Godot log.
|
|
<a
|
|
href="https://github.com/pragmagic/godot-nim/tree/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#L137" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L237"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L237" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L253"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L253" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L256"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L256" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L262"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L262" 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>
|
|
<dd>
|
|
<p>Converts the <tt class="docutils literal"><span class="pre">obj</span></tt> into the specified type. Returns <tt class="docutils literal"><span class="pre">nil</span></tt> if the conversion cannot be performed (the <tt class="docutils literal"><span class="pre">obj</span></tt> is not of the type <tt class="docutils literal"><span class="pre">T</span></tt>)</p>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L268"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L268" 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> <span class="Other pragmabegin">{.</span><div class="pragma"><span class="Identifier">inline</span></div><span class="Other pragmaend">.}</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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L286"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L286" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L327"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L327" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#L374" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L382"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L382" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L398"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L398" 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 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L411"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L411" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
<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 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L417"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L417" 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 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L423"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L423" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L428"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L428" 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 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L434"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L434" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#L439" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L447"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L447" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L453"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L453" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L465"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L465" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L471"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L471" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L475"
|
|
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>
|
|
|
|
</dd>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L532"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L532" 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="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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L539"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L539" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L548"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L548" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L565"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L565" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L576"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L576" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L579"
|
|
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>
|
|
|
|
</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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L586"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L586" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L594"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L594" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L652"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L652" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L655"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L655" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L658"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L658" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L682"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L682" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L685"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L685" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L688"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L688" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L695"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L695" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L710"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L710" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
<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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L728"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L728" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L731"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L731" 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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L741"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L741" 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.
|
|
<a
|
|
href="https://github.com/pragmagic/godot-nim/tree/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L776"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L776" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
|
|
</dl></div>
|
|
<div class="section" id="17">
|
|
<h1><a class="toc-backref" href="#17">Templates</a></h1>
|
|
<dl class="item">
|
|
<dt id="printWarning"><a name="printWarning.t,typed"></a><pre><span class="Keyword">template</span> <span class="Identifier">printWarning</span><span class="Operator">*</span><span class="Other">(</span><span class="Identifier">warning</span><span class="Other">:</span> <span class="Identifier">typed</span><span class="Other">)</span></pre></dt>
|
|
<dd>
|
|
Prints <tt class="docutils literal"><span class="pre">warning</span></tt> to Godot log, adding filename and line information.
|
|
<a
|
|
href="https://github.com/pragmagic/godot-nim/tree/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#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/6da07cada0f85615e6daf6d1b3873099f64ebac1/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#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/6da07cada0f85615e6daf6d1b3873099f64ebac1/godot/nim/godotnim.nim#L189"
|
|
class="link-seesrc" target="_blank">Source</a>
|
|
<a href="https://github.com/pragmagic/godot-nim/edit/master/godot/nim/godotnim.nim#L189" class="link-seesrc" target="_blank" >Edit</a>
|
|
|
|
</dd>
|
|
|
|
</dl></div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="row">
|
|
<div class="twelve-columns footer">
|
|
<span class="nim-sprite"></span>
|
|
<br/>
|
|
<small>Made with Nim. Generated: 2017-08-11 06:40:05 UTC</small>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|