documentation

This commit is contained in:
Yoshman29
2023-04-01 18:29:11 +02:00
parent 570b9e5f88
commit 76cb5a256b
245 changed files with 46061 additions and 8780 deletions
+1 -1
View File
@@ -7,4 +7,4 @@
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> GlobalScript</h1><h4><small>package <a href="../../funkin/scripting/index.html">funkin.scripting</a></small></h4> <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span></div><div class="body"><div class="doc doc-main"><p>Class for THE Global Script, aka script that runs in the background at all times.</p></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="script"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#script"><span class="identifier">script</span></a>:<a class="type" title="funkin.scripting.Script - Class used for scripting." href="../../funkin/scripting/Script.html">Script</a></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="beatHit"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#beatHit"><span class="identifier">beatHit</span></a>(<span style="white-space:nowrap">curBeat:<span class="type">Int</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="call"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#call"><span class="identifier">call</span></a>(<span style="white-space:nowrap">name:<span class="type">String</span>,</span> <span style="white-space:nowrap">?args:<span class="type">Array</span>&lt;<span class="type">Dynamic</span>&gt;</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="event"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#event"><span class="identifier">event</span></a>&lt;<span class="type">T</span>&gt;(<span style="white-space:nowrap">name:<span class="type">String</span>,</span> <span style="white-space:nowrap">event:<span class="type">T</span></span>):<span class="type">T</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="init"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#init"><span class="identifier">init</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="onModSwitch"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#onModSwitch"><span class="identifier">onModSwitch</span></a>(<span style="white-space:nowrap">newMod:<span class="type">String</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="stepHit"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#stepHit"><span class="identifier">stepHit</span></a>(<span style="white-space:nowrap">curStep:<span class="type">Int</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2023 &nbsp;</p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> GlobalScript</h1><h4><small>package <a href="../../funkin/scripting/index.html">funkin.scripting</a></small></h4> <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.ClassExtendMacro.build())</span></div><div class="body"><div class="doc doc-main"><p>Class for THE Global Script, aka script that runs in the background at all times.</p></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="script"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#script"><span class="identifier">script</span></a>:<a class="type" title="funkin.scripting.Script - Class used for scripting." href="../../funkin/scripting/Script.html">Script</a></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="beatHit"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#beatHit"><span class="identifier">beatHit</span></a>(<span style="white-space:nowrap">curBeat:<span class="type">Int</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="call"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#call"><span class="identifier">call</span></a>(<span style="white-space:nowrap">name:<span class="type">String</span>,</span> <span style="white-space:nowrap">?args:<span class="type">Array</span>&lt;<span class="type">Dynamic</span>&gt;</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="event"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#event"><span class="identifier">event</span></a>&lt;<span class="type">T</span>&gt;(<span style="white-space:nowrap">name:<span class="type">String</span>,</span> <span style="white-space:nowrap">event:<span class="type">T</span></span>):<span class="type">T</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="init"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#init"><span class="identifier">init</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="onModSwitch"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#onModSwitch"><span class="identifier">onModSwitch</span></a>(<span style="white-space:nowrap">newMod:<span class="type">String</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="stepHit"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#stepHit"><span class="identifier">stepHit</span></a>(<span style="white-space:nowrap">curStep:<span class="type">Int</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2023 &nbsp;</p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>