mirror of
https://github.com/celisej567/wiki.git
synced 2026-09-09 20:10:37 +03:00
255 lines
9.2 KiB
HTML
255 lines
9.2 KiB
HTML
<!DOCTYPE html>
|
|
<title>SourceBox Wiki</title>
|
|
<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/QScriptCallback.html', '/wiki/QScript/Contributing/API/Structs/QScriptClass.html', '/wiki/QScript/Contributing/API/Structs/QScriptClassCreator.html', '/wiki/QScript/Contributing/API/Structs/QType.html', '/wiki/QScript/Contributing/API/Structs/QValue.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', 'QScriptCallback', 'QScriptClass', 'QScriptClassCreator', 'QType', 'QValue', '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 = "nested";
|
|
element.parentNode.childNodes[0].innerHTML = "+";
|
|
}
|
|
else
|
|
{
|
|
nested.className = "nested active";
|
|
element.parentNode.childNodes[0].innerHTML = "-";
|
|
}
|
|
if(element.className.indexOf("active",0) != -1)
|
|
{
|
|
element.className = ""
|
|
}
|
|
else
|
|
{
|
|
element.className = "active"
|
|
}
|
|
}
|
|
|
|
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");
|
|
var link = document.createElement("a");
|
|
searchelement.appendChild(link);
|
|
link.setAttribute("href", documentlist[i]);
|
|
link.innerHTML = namelist[i];
|
|
searchresults.appendChild(searchelement);
|
|
}
|
|
|
|
|
|
|
|
}
|
|
</script>
|
|
<style>
|
|
pre {
|
|
margin-left:16px;
|
|
background-color: #EEE;
|
|
border-color: #CCC;
|
|
border-style:solid;
|
|
border-width:1px;
|
|
}
|
|
.nested {
|
|
display: none;
|
|
border-left: 1px solid #000;
|
|
}
|
|
|
|
ul.active {
|
|
display: block !important;
|
|
}
|
|
|
|
ul {
|
|
padding-left: 8px;
|
|
}
|
|
|
|
li ::marker {
|
|
color:#00000000;
|
|
display:none;
|
|
}
|
|
|
|
li {
|
|
list-style-type: none !important;
|
|
}
|
|
|
|
li b {
|
|
cursor: pointer;
|
|
display: inline-block;
|
|
}
|
|
|
|
.liicon {
|
|
display:inline-block;
|
|
width:12px;
|
|
height:100%;
|
|
font-family: monospace;
|
|
font-size: 16px;
|
|
}
|
|
|
|
</style>
|
|
<div style="position:fixed; display:block; top: 0px; left: 0px; height:100%; width:200px;border-color: black; border-width: 1px; border-style:solid;">
|
|
<input type="text" placeholder="search..." autocomplete="off" id="searchbox" oninput="updateSearch();" style="width:192px;">
|
|
<nav>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
<ul id="filetree">
|
|
<li><a href="/wiki/index.html">Wiki Intro</a></li>
|
|
<li><small class="liicon">-</small><b onclick="toggleTree(this);">QScript</b>
|
|
<ul class="nested active">
|
|
<li><a href="/wiki/QScript/Introduction.html">QScript Intro</a></li>
|
|
<li><a href="/wiki/QScript/Private_Members.html">Private Members</a></li>
|
|
<li><small class="liicon">-</small><b onclick="toggleTree(this);">Contributing</b>
|
|
<ul class="nested active">
|
|
<li><a href="/wiki/QScript/Contributing/Contributing.html">Contributing</a></li>
|
|
<li><small class="liicon">-</small><b onclick="toggleTree(this);">API</b>
|
|
<ul class="nested active">
|
|
<li><a href="/wiki/QScript/Contributing/API/qscript.html">QScript API</a></li>
|
|
<li><small class="liicon">+</small><b onclick="toggleTree(this);">Structs</b>
|
|
<ul class="nested">
|
|
<li><a href="/wiki/QScript/Contributing/API/Structs/QCFunc.html">QCFunc</a></li>
|
|
<li><a href="/wiki/QScript/Contributing/API/Structs/QModuleDefFunc.html">QModuleDefFunc</a></li>
|
|
<li><a href="/wiki/QScript/Contributing/API/Structs/QScriptCallback.html">QScriptCallback</a></li>
|
|
<li><a href="/wiki/QScript/Contributing/API/Structs/QScriptClass.html">QScriptClass</a></li>
|
|
<li><a href="/wiki/QScript/Contributing/API/Structs/QScriptClassCreator.html">QScriptClassCreator</a></li>
|
|
<li><a href="/wiki/QScript/Contributing/API/Structs/QType.html">QType</a></li>
|
|
<li><a href="/wiki/QScript/Contributing/API/Structs/QValue.html">QValue</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><small class="liicon">+</small><b onclick="toggleTree(this);">Lua</b>
|
|
<ul class="nested">
|
|
<li><a href="/wiki/QScript/Lua/Classes.html">Lua Classes</a></li>
|
|
<li><a href="/wiki/QScript/Lua/Exports.html">Lua Exports</a></li>
|
|
<li><a href="/wiki/QScript/Lua/Imports.html">Lua Imports</a></li>
|
|
<li><a href="/wiki/QScript/Lua/Intro.html">Lua Intro</a></li>
|
|
<li><a href="/wiki/QScript/Lua/Objects.html">Lua Objects</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><small class="liicon">+</small><b onclick="toggleTree(this);">Python</b>
|
|
<ul class="nested">
|
|
</ul>
|
|
</li>
|
|
<li><small class="liicon">+</small><b onclick="toggleTree(this);">Squirrel</b>
|
|
<ul class="nested">
|
|
<li><a href="/wiki/QScript/Squirrel/Exports_And_Imports.html">Squirrel Exports and Imports</a></li>
|
|
<li><a href="/wiki/QScript/Squirrel/Intro.html">Squirrel Intro</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><small class="liicon">+</small><b onclick="toggleTree(this);">Tutorial</b>
|
|
<ul class="nested">
|
|
<li><a href="/wiki/QScript/Tutorial/Chapter1.html">QScript Tutorial Page 1: Mods</a></li>
|
|
<li><a href="/wiki/QScript/Tutorial/Chapter2.html">QScript Tutorial Page 2: Getting to work</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<div style="margin-left:200px;">
|
|
<p id="errorp"></p>
|
|
<h1>QScript API</h1>
|
|
|
|
<hr />
|
|
|
|
<h2>CreateModule</h2>
|
|
|
|
<pre><code>QScriptModule CreateModule(const char* name, QModuleDefFunc* funcs)
|
|
</code></pre>
|
|
|
|
<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>
|
|
|
|
<pre><code>void LoadMods(const char* filename)
|
|
</code></pre>
|
|
|
|
<p>Will load a file inside the root of every mod.</p>
|
|
|
|
<hr />
|
|
|
|
<h2>LoadModsInDirectory</h2>
|
|
|
|
<pre><code>void LoadModsInDirectory(const char* folder, const char* filename)
|
|
</code></pre>
|
|
|
|
<p>Acts like LoadMods, but loads a file inside a subdirectory. (mods/*/folder/filename.*)</p>
|
|
|
|
<hr />
|
|
|
|
<h2>StartClass</h2>
|
|
|
|
<pre><code>QScriptClassCreator StartClass(const char* name, QScriptClass parent)
|
|
</code></pre>
|
|
|
|
<p>Returns a <a href="/wiki/QScript/Contributing/API/Structs/QScriptClassCreator.html">QScriptClassCreator</a></p>
|
|
|
|
<hr />
|
|
|
|
<h2>AddMethod</h2>
|
|
|
|
<pre><code>void AddMethod(QScriptClassCreator creator, const char* name, QType* params, QCFunc func, bool is_private = false)
|
|
</code></pre>
|
|
|
|
<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>
|
|
|
|
<pre><code>void AddScriptingMethod(QScriptClassCreator creator, const char* name, QScriptCallback callback, bool is_private)
|
|
</code></pre>
|
|
|
|
<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>
|
|
|
|
<pre><code>void AddVariable(QScriptClassCreator creator, const char* name, QType type, QValue defaultval, bool is_private)
|
|
</code></pre>
|
|
|
|
<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>
|
|
|
|
<pre><code>void AddString(QScriptClassCreator creator, const char* name, const char* defaultval, bool is_private)
|
|
</code></pre>
|
|
|
|
<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>
|
|
|
|
<pre><code>QScriptClass FinishClass(QScriptClassCreator creator)
|
|
</code></pre>
|
|
|
|
<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 />
|
|
|
|
</div> |