celisej567/wiki
1
0
Fork 0
mirror of https://github.com/celisej567/wiki.git synced 2025-12-31 01:49:32 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
Files
7af6a4b150e2baea105f8aec741655d388ca42e8
wiki/dst/QScript/Contributing/API/qscript.html
relt-1 7af6a4b150 top bar idk for what yet
2023-09-26 22:27:35 +02:00

730 lines
32 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<title>SourceBox Wiki</title>
<link rel="shortcut icon" href="/wiki/favicon.ico">
<script>
documentlist = ['/wiki/index.html', '/wiki/QScript/Introduction.html', '/wiki/QScript/Private_Members.html', '/wiki/QScript/Contributing/Contributing.html', '/wiki/QScript/Contributing/API/qscript.html', '/wiki/QScript/Contributing/API/Structs/QCFunc.html', '/wiki/QScript/Contributing/API/Structs/QModuleDefFunc.html', '/wiki/QScript/Contributing/API/Structs/QReturn.html', '/wiki/QScript/Contributing/API/Structs/QScriptArgs.html', '/wiki/QScript/Contributing/API/Structs/QScriptCallback.html', '/wiki/QScript/Contributing/API/Structs/QScriptClass.html', '/wiki/QScript/Contributing/API/Structs/QScriptClassCreator.html', '/wiki/QScript/Contributing/API/Structs/QScriptFunction.html', '/wiki/QScript/Contributing/API/Structs/QScriptObject.html', '/wiki/QScript/Contributing/API/Structs/QType.html', '/wiki/QScript/Contributing/API/Structs/QValue.html', '/wiki/QScript/Contributing/Internals/IBaseScriptingInterface.html', '/wiki/QScript/Contributing/Internals/QArgs.html', '/wiki/QScript/Contributing/Internals/QCallback.html', '/wiki/QScript/Contributing/Internals/QClass.html', '/wiki/QScript/Contributing/Internals/QFunction.html', '/wiki/QScript/Contributing/Internals/QInterface.html', '/wiki/QScript/Contributing/Internals/QModule.html', '/wiki/QScript/Contributing/Internals/QObject.html', '/wiki/QScript/Contributing/Rundown/QScriptRundown1.html', '/wiki/QScript/Contributing/Rundown/QScriptRundown2.html', '/wiki/QScript/Contributing/Rundown/QScriptRundown3.html', '/wiki/QScript/Contributing/Rundown/QScriptRundown4.html', '/wiki/QScript/Lua/Classes.html', '/wiki/QScript/Lua/Exports.html', '/wiki/QScript/Lua/Imports.html', '/wiki/QScript/Lua/Intro.html', '/wiki/QScript/Lua/Objects.html', '/wiki/QScript/Squirrel/Exports_And_Imports.html', '/wiki/QScript/Squirrel/Intro.html', '/wiki/QScript/Tutorial/Chapter1.html', '/wiki/QScript/Tutorial/Chapter2.html'];
namelist = ['Wiki Intro', 'QScript Intro', 'Private Members', 'Contributing', 'QScript API', 'QCFunc', 'QModuleDefFunc', 'QReturn', 'QScriptArgs', 'QScriptCallback', 'QScriptClass', 'QScriptClassCreator', 'QScriptFunction', 'QScriptObject', 'QType', 'QValue', 'IBaseScriptingInterface', 'QArgs', 'QCallback', 'QClass', 'QFunction', 'QInterface', 'QModule', 'QObject', 'QScript Rundown Page 1', 'QScript Rundown Page 2', 'QScript Rundown Page 3', 'QScript Rundown Page 4', 'Lua Classes', 'Lua Exports', 'Lua Imports', 'Lua Intro', 'Lua Objects', 'Squirrel Exports and Imports', 'Squirrel Intro', 'QScript Tutorial Page 1: Mods', 'QScript Tutorial Page 2: Getting to work'];
function toggleTree(element)
{
nested = element.parentNode.childNodes[3];
if(nested.className.indexOf("active",0) != -1)
{
nested.className = "sidebar nested";
element.parentNode.childNodes[0].innerHTML = "+";
}
else
{
nested.className = "sidebar nested active";
element.parentNode.childNodes[0].innerHTML = "-";
}
if(element.className.indexOf("active",0) != -1)
{
element.className = "spanactive"
}
else
{
element.className = "spanactive active"
}
}
function Press(element)
{
if(element.className.indexOf("active",0) != -1)
{
element.className = "spanactive active"
}
else
{
element.className = "spanactive"
}
}
function unPress(element)
{
if(element.className.indexOf("active",0) != -1)
{
element.className = "active"
}
else
{
element.className = ""
}
}
function updateSearch()
{
searchtext = document.getElementById("searchbox").value.toLowerCase();
var res = [];
var searchresults = document.getElementById("searchresults")
searchresults.innerHTML = ""
if(searchtext === "")
{
document.getElementById("filetree").style.display = "block"
return;
}
else
{
document.getElementById("filetree").style.display = "none"
}
for (var i = 0; i < namelist.length; i++)
{
if(namelist[i].toLowerCase().indexOf(searchtext) == -1) continue;
var searchelement = document.createElement("li");
searchelement.className = "sidebar"
var link = document.createElement("a");
searchelement.appendChild(link);
link.setAttribute("href", documentlist[i]);
link.innerHTML = namelist[i];
searchresults.appendChild(searchelement);
}
}
</script>
<link rel="stylesheet" href="/wiki/default.css">
<style>
hr
{
color: #463c2a;
}
code {
background-color: #383022;
border-color: #322b1e;
border-style:solid;
border-width:1px;
}
pre
{
margin-left:16px;
background-color: #383022;
border-color: #322b1e;
border-style:solid;
border-width:1px;
padding: 4px;
display:flex;
}
pre code
{
border: none !important;
}
td code {
background-color: #312A1D;
border-color: #2b2519;
}
.nested
{
display: none;
}
ul.sidebar.active
{
display: block !important;
}
ul.sidebar
{
padding-left: 0px;
}
li.sidebar ::marker
{
color:#00000000;
display:none;
}
li.sidebar
{
list-style-type: none !important;
background-color:#4A3F2C;
border-bottom: #312A1D 1px solid;
border-right: #312A1D 1px solid;
border-left: 1px solid #8d8881;
border-top: 1px solid #8d8881;
padding-left: 2px;
padding-bottom:2px;
padding-top:2px;
}
li ul li
{
margin-right:-1px;
}
li.sidebar span
{
-moz-user-select: none;
user-select: none;
-webkit-user-select: none;
z-index: 1;
cursor: pointer;
display: inline-block;
border: black 1px solid;
border-left-color: white;
border-top-color: white;
margin: 2px;
}
li.sidebar span span
{
-moz-user-select: none;
user-select: none;
-webkit-user-select: none;
z-index: 0;
border: #463c2a 1px solid;
background-color: #63553b;
color: white;
border-left-color: #8d8881;
border-top-color: #8d8881;
margin: 0px;
padding-left: 4px;
padding-right: 4px;
}
li.sidebar .spanactive
{
border-left-color: black;
border-top-color: black;
border-right-color: white;
border-bottom-color: white;
}
li.sidebar span .spanactive
{
border: #463c2a 1px solid;
border-right-color: #8d8881;
border-bottom-color: #8d8881;
}
.liicon
{
display:inline-block;
width:12px;
height:100%;
font-family: monospace;
font-size: 16px;
color: white;
}
nav
{
height: 100%;
}
a
{
color: #f79b08;
}
a:visited
{
color: #f79b08;
}
body
{
background-color: #4b402d;
color:white;
font-family:"Tahoma", sans-serif;
font-size:9pt;
}
.searchbox
{
border:none;
background-color: #3a3122;
color: white;
padding: 0px;
width:190px;
height:22px;
position: relative;
padding-left:4px;
padding-right:4px;
}
input:focus {
outline: none;
}
.searchboxcontainer
{
border: #2b2519 1px solid;
border-top-color: #837f7a;
border-left-color: #837f7a;
background-color: #3a3122;
position:relative;
margin-left:auto;
margin-right:0px;
height:24px;
width:198px;
position: absolute;
right: 9px;
}
.sidebarcontainer
{
float:right;
display:block;
top: -16px;
right: -8px;
margin-left: 8px;
margin-top: 8px;
margin-right: 8px;
width:200px;
border-color: black;
border-width: 1px;
border-style:solid;
position:relative;
overflow:auto;
padding:0px;
}
table
{
border: #312a1d 1px solid;
border-top-color: #837f7a;
border-left-color: #837f7a;
background-color: #423827;
}
th, td
{
border: #2b2519 1px solid;
border-right-color: #837f7a;
border-bottom-color: #837f7a;
background-color: #3a3122;
}
.sidebarroot
{
padding-left:0px !important;
margin:0px;
overflow:hidden;
}
.framed
{
border: #312a1d 1px solid;
border-top-color: #837f7a;
border-left-color: #837f7a;
background-color: #423827;
display: flow-root;
}
.framed .framed
{
border: #2b2519 1px solid;
border-right-color: #837f7a;
border-bottom-color: #837f7a;
background-color: #3a3122;
margin:4px;
padding:2px;
text-align: center;
}
.topbar
{
width:100%;
height:24px;
border: #312a1d 1px solid;
border-top-color: #837f7a;
border-left-color: #837f7a;
background-color: #423827;
margin-left:-2px;
}
.topbarelement
{
border: #2b2519 1px solid;
border-top-color: #837f7a;
border-left-color: #837f7a;
background-color: #3a3122;
}
</style>
<div class="topbar">
<img class="topbarelement" src="/wiki/sourceboxicon.png">
<span class="searchboxcontainer" onkeyup="updateSearch();"><input class="searchbox" type="text" placeholder="search..." autocomplete="off" id="searchbox" oninput="updateSearch();" class="searchbox"></span>
</div>
<div>
<div class="sidebarcontainer">
<nav>
<ul class="sidebar sidebarroot" id="searchresults">
</ul>
<ul class="sidebar sidebarroot" id="filetree">
<li class="sidebar"><a href="/wiki/index.html">Wiki Intro</a></li>
<li class="sidebar"><small class="liicon">-</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">QScript</span></span>
<ul class="sidebar nested active">
<li class="sidebar"><a href="/wiki/QScript/Introduction.html">QScript Intro</a></li>
<li class="sidebar"><a href="/wiki/QScript/Private_Members.html">Private Members</a></li>
<li class="sidebar"><small class="liicon">-</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">Contributing</span></span>
<ul class="sidebar nested active">
<li class="sidebar"><a href="/wiki/QScript/Contributing/Contributing.html">Contributing</a></li>
<li class="sidebar"><small class="liicon">-</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">API</span></span>
<ul class="sidebar nested active">
<li class="sidebar"><b>QScript API</b></li>
<li class="sidebar"><small class="liicon">+</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">Structs</span></span>
<ul class="sidebar nested">
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QCFunc.html">QCFunc</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QModuleDefFunc.html">QModuleDefFunc</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QReturn.html">QReturn</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QScriptArgs.html">QScriptArgs</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QScriptCallback.html">QScriptCallback</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QScriptClass.html">QScriptClass</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QScriptClassCreator.html">QScriptClassCreator</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QScriptFunction.html">QScriptFunction</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QScriptObject.html">QScriptObject</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QType.html">QType</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/API/Structs/QValue.html">QValue</a></li>
</ul>
</li>
</ul>
</li>
<li class="sidebar"><small class="liicon">+</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">Internals</span></span>
<ul class="sidebar nested">
<li class="sidebar"><a href="/wiki/QScript/Contributing/Internals/IBaseScriptingInterface.html">IBaseScriptingInterface</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Internals/QArgs.html">QArgs</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Internals/QCallback.html">QCallback</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Internals/QClass.html">QClass</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Internals/QFunction.html">QFunction</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Internals/QInterface.html">QInterface</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Internals/QModule.html">QModule</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Internals/QObject.html">QObject</a></li>
</ul>
</li>
<li class="sidebar"><small class="liicon">+</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">Rundown</span></span>
<ul class="sidebar nested">
<li class="sidebar"><a href="/wiki/QScript/Contributing/Rundown/QScriptRundown1.html">QScript Rundown Page 1</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Rundown/QScriptRundown2.html">QScript Rundown Page 2</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Rundown/QScriptRundown3.html">QScript Rundown Page 3</a></li>
<li class="sidebar"><a href="/wiki/QScript/Contributing/Rundown/QScriptRundown4.html">QScript Rundown Page 4</a></li>
</ul>
</li>
</ul>
</li>
<li class="sidebar"><small class="liicon">+</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">Lua</span></span>
<ul class="sidebar nested">
<li class="sidebar"><a href="/wiki/QScript/Lua/Classes.html">Lua Classes</a></li>
<li class="sidebar"><a href="/wiki/QScript/Lua/Exports.html">Lua Exports</a></li>
<li class="sidebar"><a href="/wiki/QScript/Lua/Imports.html">Lua Imports</a></li>
<li class="sidebar"><a href="/wiki/QScript/Lua/Intro.html">Lua Intro</a></li>
<li class="sidebar"><a href="/wiki/QScript/Lua/Objects.html">Lua Objects</a></li>
</ul>
</li>
<li class="sidebar"><small class="liicon">+</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">Python</span></span>
<ul class="sidebar nested">
</ul>
</li>
<li class="sidebar"><small class="liicon">+</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">Squirrel</span></span>
<ul class="sidebar nested">
<li class="sidebar"><a href="/wiki/QScript/Squirrel/Exports_And_Imports.html">Squirrel Exports and Imports</a></li>
<li class="sidebar"><a href="/wiki/QScript/Squirrel/Intro.html">Squirrel Intro</a></li>
</ul>
</li>
<li class="sidebar"><small class="liicon">+</small><span onmousedown="toggleTree(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);"><span onmousedown="Press(this);" onmouseleave="unPress(this);" onmouseup="unPress(this);">Tutorial</span></span>
<ul class="sidebar nested">
<li class="sidebar"><a href="/wiki/QScript/Tutorial/Chapter1.html">QScript Tutorial Page 1: Mods</a></li>
<li class="sidebar"><a href="/wiki/QScript/Tutorial/Chapter2.html">QScript Tutorial Page 2: Getting to work</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</div>
<h1>QScript API</h1>
<hr />
<h2>CreateModule</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QScriptModule</span><span class="w"> </span><span class="n">CreateModule</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">QModuleDefFunc</span><span class="o">*</span><span class="w"> </span><span class="n">funcs</span><span class="p">)</span>
</code></pre>
</div>
<p>Takes a name, and a <a href="/wiki/QScript/Contributing/API/Structs/QModuleDefFunc.html">QModuleDefFunc</a> list, returns a QScriptModule</p>
<hr />
<h2>LoadMods</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">LoadMods</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">filename</span><span class="p">)</span>
</code></pre>
</div>
<p>Will load a file inside the root of every mod.</p>
<hr />
<h2>LoadModsInDirectory</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">LoadModsInDirectory</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">folder</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">filename</span><span class="p">)</span>
</code></pre>
</div>
<p>Acts like LoadMods, but loads a file inside a subdirectory. (mods/*/folder/filename.*)</p>
<hr />
<h2>StartClass</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QScriptClassCreator</span><span class="w"> </span><span class="n">StartClass</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">QScriptClass</span><span class="w"> </span><span class="n">parent</span><span class="p">)</span>
</code></pre>
</div>
<p>Returns a <a href="/wiki/QScript/Contributing/API/Structs/QScriptClassCreator.html">QScriptClassCreator</a></p>
<hr />
<h2>AddMethod</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">AddMethod</span><span class="p">(</span><span class="n">QScriptClassCreator</span><span class="w"> </span><span class="n">creator</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">QType</span><span class="o">*</span><span class="w"> </span><span class="n">params</span><span class="p">,</span><span class="w"> </span><span class="n">QCFunc</span><span class="w"> </span><span class="n">func</span><span class="p">,</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">is_private</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">false</span><span class="p">)</span>
</code></pre>
</div>
<p>Adds a method to the class creator. Takes a name, <a href="/wiki/QScript/Contributing/API/Structs/QType.html">QType</a> list which will be the parameters, <a href="/wiki/QScript/Contributing/API/Structs/QCFunc.html">QCFunc</a> which will be the callback, and an optional <a href="/wiki/QScript/Private_Members.html">is_private</a> bool.</p>
<hr />
<h2>AddScriptingMethod</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">AddScriptingMethod</span><span class="p">(</span><span class="n">QScriptClassCreator</span><span class="w"> </span><span class="n">creator</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">QScriptCallback</span><span class="w"> </span><span class="n">callback</span><span class="p">,</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">is_private</span><span class="p">)</span>
</code></pre>
</div>
<p>Adds a scripting language method for the class creator. Takes a name, <a href="/wiki/QScript/Contributing/API/Structs/QScriptCallback.html">QScriptCallback</a> which will be called when the method is called, and an optional is_private bool.</p>
<hr />
<h2>AddVariable</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">AddVariable</span><span class="p">(</span><span class="n">QScriptClassCreator</span><span class="w"> </span><span class="n">creator</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">QType</span><span class="w"> </span><span class="n">type</span><span class="p">,</span><span class="w"> </span><span class="n">QValue</span><span class="w"> </span><span class="n">defaultval</span><span class="p">,</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">is_private</span><span class="p">)</span>
</code></pre>
</div>
<p>Adds a variable with a default value to the class creator. Takes a name, QType, <a href="/wiki/QScript/Contributing/API/Structs/QValue.html">QValue</a>, and an optional is_private bool.</p>
<p>Do <strong>not</strong> use this for adding strings. Use the next method instead.</p>
<hr />
<h2>AddString</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">AddString</span><span class="p">(</span><span class="n">QScriptClassCreator</span><span class="w"> </span><span class="n">creator</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">defaultval</span><span class="p">,</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">is_private</span><span class="p">)</span>
</code></pre>
</div>
<p>Adds a string variable to the class creator. Takes a name, a default value and an optional is_private bool.</p>
<hr />
<h2>FinishClass</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QScriptClass</span><span class="w"> </span><span class="n">FinishClass</span><span class="p">(</span><span class="n">QScriptClassCreator</span><span class="w"> </span><span class="n">creator</span><span class="p">)</span>
</code></pre>
</div>
<p>Finishes the class creator and returns a <a href="/wiki/QScript/Contributing/API/Structs/QScriptClass.html">QScriptClass</a>. Will delete the creator.</p>
<hr />
<h2>CreateObject</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QScriptObject</span><span class="w"> </span><span class="n">CreateObject</span><span class="p">(</span><span class="n">QScriptClass</span><span class="w"> </span><span class="n">cls</span><span class="p">)</span>
</code></pre>
</div>
<p>Returns a new <a href="/wiki/QScript/Contributing/API/Structs/QScriptObject.html">QScriptObject</a>. Takes a class from which to create the object.</p>
<hr />
<h2>InitializeObject</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">InitializeObject</span><span class="p">(</span><span class="n">QScriptObject</span><span class="w"> </span><span class="n">object</span><span class="p">)</span>
</code></pre>
</div>
<p>Initializes a QScriptObject. Call every time after you create one! Takes a QScriptObject.</p>
<hr />
<h2>GetObjectValueIndex</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">int</span><span class="w"> </span><span class="n">GetObjectValueIndex</span><span class="p">(</span><span class="n">QScriptObject</span><span class="w"> </span><span class="n">object</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">name</span><span class="p">)</span>
</code></pre>
</div>
<p>Gets a index of a variable from the object. Takes a QScriptObject and a name of the variable.</p>
<hr />
<h2>SetObjectValue</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">SetObjectValue</span><span class="p">(</span><span class="n">QScriptObject</span><span class="w"> </span><span class="n">object</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">index</span><span class="p">,</span><span class="w"> </span><span class="n">QValue</span><span class="w"> </span><span class="n">val</span><span class="p">)</span>
</code></pre>
</div>
<p>Sets a value inside an object. Takes the object, the index of the value, and a QValue. Do <strong>not</strong> use this function for setting strings.</p>
<hr />
<h2>SetObjectString</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">SetObjectString</span><span class="p">(</span><span class="n">QScriptObject</span><span class="w"> </span><span class="n">object</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">index</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">str</span><span class="p">)</span>
</code></pre>
</div>
<p>Sets a string inside an object. Takes the object, the index of the value and a string.</p>
<hr />
<h2>GetObjectValue</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QValue</span><span class="w"> </span><span class="n">GetObjectValue</span><span class="p">(</span><span class="n">QScriptObject</span><span class="w"> </span><span class="n">object</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">index</span><span class="p">)</span>
</code></pre>
</div>
<p>Gets a value from an object. Returns a QValue and takes the object and the index of the value.</p>
<hr />
<h2>GetObjectValueType</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QType</span><span class="w"> </span><span class="n">GetObjectValueType</span><span class="p">(</span><span class="n">QScriptObject</span><span class="w"> </span><span class="n">object</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">index</span><span class="p">)</span>
</code></pre>
</div>
<p>Gets the type of a value in the object. Takes the object and the index of the value. Returns a QType.</p>
<hr />
<h2>GetObjectMethodIndex</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">int</span><span class="w"> </span><span class="n">GetObjectMethodIndex</span><span class="p">(</span><span class="n">QScriptObject</span><span class="w"> </span><span class="n">object</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">name</span><span class="p">)</span>
</code></pre>
</div>
<p>Gets the index of a method in the object. Takes the object and the name of the method.</p>
<hr />
<h2>GetObjectMethod</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QScriptFunction</span><span class="w"> </span><span class="n">GetObjectMethod</span><span class="p">(</span><span class="n">QScriptObject</span><span class="w"> </span><span class="n">object</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">index</span><span class="p">)</span>
</code></pre>
</div>
<p>Gets the method of an object. Takes the object and the index of the method. Returns a <a href="/wiki/QScript/Contributing/API/Structs/QScriptFunction.html">QScriptFunction</a>.</p>
<hr />
<h2>CallObjectMethod</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QReturn</span><span class="w"> </span><span class="nf">CallObjectMethod</span><span class="p">(</span><span class="n">QScriptObject</span><span class="w"> </span><span class="n">object</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">index</span><span class="p">,</span><span class="w"> </span><span class="n">QScriptArgs</span><span class="w"> </span><span class="n">arguments</span><span class="p">);</span>
</code></pre>
</div>
<p>Calls a method from the object. Takes the object, index of the method and <a href="/wiki/QScript/Contributing/API/Structs/QScriptArgs.html">QScriptArgs</a>.</p>
<hr />
<h2>GetArgValue</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QValue</span><span class="w"> </span><span class="n">GetArgValue</span><span class="p">(</span><span class="n">QScriptArgs</span><span class="w"> </span><span class="n">args</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">index</span><span class="p">)</span>
</code></pre>
</div>
<p>Gets a value from some arguments. Takes a QScriptArgs and the argument index.</p>
<hr />
<h2>GetArgType</h2>
<div class="codehilite">
<pre><span></span><code><span class="n">QType</span><span class="w"> </span><span class="n">GetArgType</span><span class="p">(</span><span class="n">QScriptArgs</span><span class="w"> </span><span class="n">args</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">index</span><span class="p">)</span>
</code></pre>
</div>
<p>Gets the type of the argument from a QScriptArgs. Takes a QScriptArgs and the argument index.</p>
<hr />
<h2>CallFunction</h2>
<div class="codehilite">
<pre><span></span><code><span class="kt">void</span><span class="w"> </span><span class="n">CallFunction</span><span class="p">(</span><span class="n">QScriptFunction</span><span class="w"> </span><span class="n">function</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="o">*</span><span class="w"> </span><span class="n">fmt</span><span class="p">,</span><span class="w"> </span><span class="p">...)</span>
</code></pre>
</div>
<p>Calls a QScriptFunction, takes a string which represents the types of arguments and a vararg which are the arguments themselves. The arguments are normal C++ types.</p>
<p>Here is a table of chars to QType</p>
<table>
<thead>
<tr>
<th>char</th>
<th><a href="/wiki/QScript/Contributing/API/Structs/QType.html">QType</a></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>s</code></td>
<td><code>QType_String</code></td>
</tr>
<tr>
<td><code>i</code></td>
<td><code>QType_Int</code></td>
</tr>
<tr>
<td><code>f</code></td>
<td><code>QType_Float</code></td>
</tr>
<tr>
<td><code>o</code></td>
<td><code>QType_Object</code></td>
</tr>
<tr>
<td><code>b</code></td>
<td><code>QType_Bool</code></td>
</tr>
<tr>
<td><code>p</code></td>
<td><code>QType_Function</code></td>
</tr>
</tbody>
</table>
<hr />
</div>
Reference in New Issue View Git Blame Copy Permalink