CodenameEngine/pages/funkin/backend/scripting/ScriptPack.html

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../../jquery-1.9.1.min.js"></script><script src="../../../bootstrap/js/bootstrap.min.js"></script><script src="../../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../../styles.css" rel="stylesheet"/><link href="../../../extra-styles.css" rel="stylesheet"/><link href="../../../haxe-nav.css" rel="stylesheet"/><link href="../../../dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "../../../",platforms: ["doc"]};</script><script src="../../../nav.js"></script><script src="../../../index.js"></script><link rel="icon" href="../../../favicon.ico" type="image/x-icon"/><title>funkin.backend.scripting.ScriptPack</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
	display: inline-block;
	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> ScriptPack</h1><h4><small>package <a href="../../../funkin/backend/scripting/index.html">funkin.backend.scripting</a></small></h4><h4><small>extends <a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</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><span class="label label-meta label-meta-access" title="Forces private access to package, type or field.">@:access(CancellableEvent)</span></div><div class="body"><div class="doc doc-main"><p></p></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">name:<span class="type">String</span></span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="additionalDefaultVariables"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value([])</span><a href="#additionalDefaultVariables"><span class="identifier">additionalDefaultVariables</span></a>:<span class="type">Map</span>&lt;<span class="type">String</span>, <span class="type">Dynamic</span>&gt;<span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="parent"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(null)</span><a href="#parent"><span class="identifier">parent</span></a>:<span class="type">Dynamic</span><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="publicVariables"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value([])</span><a href="#publicVariables"><span class="identifier">publicVariables</span></a>:<span class="type">Map</span>&lt;<span class="type">String</span>, <span class="type">Dynamic</span>&gt;<span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="scripts"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value([])</span><a href="#scripts"><span class="identifier">scripts</span></a>:<span class="type">Array</span>&lt;<a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a>&gt;<span> = []</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="add"></a><h3 class="anchor"><code><a href="#add"><span class="identifier">add</span></a>(<span style="white-space:nowrap">script:<a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="contains"></a><h3 class="anchor"><code><a href="#contains"><span class="identifier">contains</span></a>(<span style="white-space:nowrap">path:<span class="type">String</span></span>):<span class="type">Bool</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-inline">inline</span><a href="#event"><span class="identifier">event</span></a>&lt;<span class="type">T</span>&gt;(<span style="white-space:nowrap">func:<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>Sends an event to every single script, and returns the event.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>func</code></th><td><p>Function to call</p></td></tr><tr><th style="width:25%;"><code>event</code></th><td><p>Event (will be the first parameter of the function)</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>(modified by scripts)</p></div></div></div><div class="field "><a name="getByName"></a><h3 class="anchor"><code><a href="#getByName"><span class="identifier">getByName</span></a>(<span style="white-space:nowrap">name:<span class="type">String</span></span>):<a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getByPath"></a><h3 class="anchor"><code><a href="#getByPath"><span class="identifier">getByPath</span></a>(<span style="white-space:nowrap">name:<span class="type">String</span></span>):<a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="importScript"></a><h3 class="anchor"><code><a href="#importScript"><span class="identifier">importScript</span></a>(<span style="white-space:nowrap">path:<span class="type">String</span></span>):<a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="insert"></a><h3 class="anchor"><code><a href="#insert"><span class="identifier">insert</span></a>(<span style="white-space:nowrap">pos:<span class="type">Int</span>,</span> <span style="white-space:nowrap">script:<a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="remove"></a><h3 class="anchor"><code><a href="#remove"><span class="identifier">remove</span></a>(<span style="white-space:nowrap">script:<a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div>  <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a></h4><div style="display:none"><div class="field "><a name="fileName"></a><h3 class="anchor"><code><a href="#fileName"><span class="identifier">fileName</span></a>:<span class="type">String</span></code></h3><div class="doc"><p>Script name (with extension)</p></div></div><div class="field "><a name="path"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(null)</span><a href="#path"><span class="identifier">path</span></a>:<span class="type">String</span><span> = null</span></code></h3><div class="doc"><p>Path to the script.</p></div></div></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a></h4><div style="display:none"><div class="field "><a name="error"></a><h3 class="anchor"><code><a href="#error"><span class="identifier">error</span></a>(<span style="white-space:nowrap">text:<span class="type">String</span>,</span> <span style="white-space:nowrap">?additionalInfo:<span class="type">Dynamic</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Shows an error from this script.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>text</code></th><td><p>Text of the error (ex: Null Object Reference).</p></td></tr><tr><th style="width:25%;"><code>additionalInfo</code></th><td><p>Additional information you could provide.</p></td></tr></table></div></div><div class="field "><a name="onLoad"></a><h3 class="anchor"><code><a href="#onLoad"><span class="identifier">onLoad</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="setPublicMap"></a><h3 class="anchor"><code><a href="#setPublicMap"><span class="identifier">setPublicMap</span></a>(<span style="white-space:nowrap">map:<span class="type">Map</span>&lt;<span class="type">String</span>, <span class="type">Dynamic</span>&gt;</span>):<span class="type">Void</span></code></h3><div class="doc"><p>HSCRIPT ONLY FOR NOW
Sets the "public" variables map for ScriptPack</p></div></div><div class="field "><a name="trace"></a><h3 class="anchor"><code><a href="#trace"><span class="identifier">trace</span></a>(<span style="white-space:nowrap">v:<span class="type">Dynamic</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Traces something as this script.</p></div></div></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>