documentation
This commit is contained in:
+2
-1
File diff suppressed because one or more lines are too long
+10
@@ -0,0 +1,10 @@
|
||||
<!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.scripting.GlobalScript</title><meta name="description" content="Class for THE Global Script, aka script that runs in the background at all times."/></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> 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><<span class="type">Dynamic</span>></span>):<span class="type">Void</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">© 2022 </p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
Vendored
+10
File diff suppressed because one or more lines are too long
+10
File diff suppressed because one or more lines are too long
Vendored
+3
-1
File diff suppressed because one or more lines are too long
+2
-1
File diff suppressed because one or more lines are too long
+15
@@ -0,0 +1,15 @@
|
||||
<!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.scripting.events.CamMoveEvent</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> CamMoveEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></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">bfCamPos:<span class="type">FlxPoint</span>,</span> <span style="white-space:nowrap">dadCamPos:<span class="type">FlxPoint</span>,</span> <span style="white-space:nowrap">ratio:<span class="type">Float</span>,</span> <span style="white-space:nowrap">position:<span class="type">FlxPoint</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="bfCamPos"></a><h3 class="anchor"><code><a href="#bfCamPos"><span class="identifier">bfCamPos</span></a>:<span class="type">FlxPoint</span></code></h3><div class="doc"><p>Boyfriend's camera position.</p></div></div><div class="field "><a name="dadCamPos"></a><h3 class="anchor"><code><a href="#dadCamPos"><span class="identifier">dadCamPos</span></a>:<span class="type">FlxPoint</span></code></h3><div class="doc"><p>Dad's camera position.</p></div></div><div class="field "><a name="focusBF"></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(false)</span><a href="#focusBF"><span class="identifier">focusBF</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p>Whenever the camera focuses BF more than dad.</p></div></div><div class="field "><a name="position"></a><h3 class="anchor"><code><a href="#position"><span class="identifier">position</span></a>:<span class="type">FlxPoint</span></code></h3><div class="doc"><p>Final camera position.</p></div></div><div class="field "><a name="ratio"></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(0)</span><a href="#ratio"><span class="identifier">ratio</span></a>:<span class="type">Float</span><span> = 0</span></code></h3><div class="doc"><p>Ratio for lerping between Dad and BF.
|
||||
0 = Camera focuses dad
|
||||
0.5 = Duet Camera
|
||||
1 = Camera focuses BF</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
+2
-2
@@ -7,7 +7,7 @@
|
||||
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> CancellableEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4> <h4><small><span class="muted">extended by </span><a class="type" title="funkin.scripting.events.CountdownEvent" href="../../../funkin/scripting/events/CountdownEvent.html">CountdownEvent</a>, <a class="type" title="funkin.scripting.events.DanceEvent" href="../../../funkin/scripting/events/DanceEvent.html">DanceEvent</a>, <a class="type" title="funkin.scripting.events.DirectionAnimEvent" href="../../../funkin/scripting/events/DirectionAnimEvent.html">DirectionAnimEvent</a>, <a class="type" title="funkin.scripting.events.InputSystemEvent" href="../../../funkin/scripting/events/InputSystemEvent.html">InputSystemEvent</a>, <a class="type" title="funkin.scripting.events.NoteCreationEvent" href="../../../funkin/scripting/events/NoteCreationEvent.html">NoteCreationEvent</a>, <a class="type" title="funkin.scripting.events.NoteHitEvent" href="../../../funkin/scripting/events/NoteHitEvent.html">NoteHitEvent</a>, <a class="type" title="funkin.scripting.events.NoteUpdateEvent" href="../../../funkin/scripting/events/NoteUpdateEvent.html">NoteUpdateEvent</a>, <a class="type" title="funkin.scripting.events.PlayAnimEvent" href="../../../funkin/scripting/events/PlayAnimEvent.html">PlayAnimEvent</a>, <a class="type" title="funkin.scripting.events.PointEvent" href="../../../funkin/scripting/events/PointEvent.html">PointEvent</a>, <a class="type" title="funkin.scripting.events.SimpleNoteEvent" href="../../../funkin/scripting/events/SimpleNoteEvent.html">SimpleNoteEvent</a>, <a class="type" title="funkin.scripting.events.StrumCreationEvent" href="../../../funkin/scripting/events/StrumCreationEvent.html">StrumCreationEvent</a>, <a class="type" title="funkin.scripting.events.SubstateEvent" href="../../../funkin/scripting/events/SubstateEvent.html">SubstateEvent</a></small></h4><span class="label label-meta label-meta-allow" title="Allows private access from package, type or field.">@:allow(ScriptPack)</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>()</code></h3><div class="doc"><p>Creates a new cancellable event.
|
||||
This allows scripts to call <code>cancel()</code> to cancel the event.</p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="preventDefault"></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({ c : true })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = true</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
</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> CancellableEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4> <h4><small><span class="muted">extended by </span><a class="type" title="funkin.scripting.events.CamMoveEvent" href="../../../funkin/scripting/events/CamMoveEvent.html">CamMoveEvent</a>, <a class="type" title="funkin.scripting.events.CountdownEvent" href="../../../funkin/scripting/events/CountdownEvent.html">CountdownEvent</a>, <a class="type" title="funkin.scripting.events.DanceEvent" href="../../../funkin/scripting/events/DanceEvent.html">DanceEvent</a>, <a class="type" title="funkin.scripting.events.DirectionAnimEvent" href="../../../funkin/scripting/events/DirectionAnimEvent.html">DirectionAnimEvent</a>, <a class="type" title="funkin.scripting.events.InputSystemEvent" href="../../../funkin/scripting/events/InputSystemEvent.html">InputSystemEvent</a>, <a class="type" title="funkin.scripting.events.MenuChangeEvent" href="../../../funkin/scripting/events/MenuChangeEvent.html">MenuChangeEvent</a>, <a class="type" title="funkin.scripting.events.NameEvent" href="../../../funkin/scripting/events/NameEvent.html">NameEvent</a>, <a class="type" title="funkin.scripting.events.NoteCreationEvent" href="../../../funkin/scripting/events/NoteCreationEvent.html">NoteCreationEvent</a>, <a class="type" title="funkin.scripting.events.NoteHitEvent" href="../../../funkin/scripting/events/NoteHitEvent.html">NoteHitEvent</a>, <a class="type" title="funkin.scripting.events.NoteUpdateEvent" href="../../../funkin/scripting/events/NoteUpdateEvent.html">NoteUpdateEvent</a>, <a class="type" title="funkin.scripting.events.PauseCreationEvent - CANCEL this event to prevent default behaviour!" href="../../../funkin/scripting/events/PauseCreationEvent.html">PauseCreationEvent</a>, <a class="type" title="funkin.scripting.events.PlayAnimEvent" href="../../../funkin/scripting/events/PlayAnimEvent.html">PlayAnimEvent</a>, <a class="type" title="funkin.scripting.events.PointEvent" href="../../../funkin/scripting/events/PointEvent.html">PointEvent</a>, <a class="type" title="funkin.scripting.events.RatingUpdateEvent" href="../../../funkin/scripting/events/RatingUpdateEvent.html">RatingUpdateEvent</a>, <a class="type" title="funkin.scripting.events.ResizeEvent" href="../../../funkin/scripting/events/ResizeEvent.html">ResizeEvent</a>, <a class="type" title="funkin.scripting.events.SimpleNoteEvent" href="../../../funkin/scripting/events/SimpleNoteEvent.html">SimpleNoteEvent</a>, <a class="type" title="funkin.scripting.events.StateEvent" href="../../../funkin/scripting/events/StateEvent.html">StateEvent</a>, <a class="type" title="funkin.scripting.events.StrumCreationEvent" href="../../../funkin/scripting/events/StrumCreationEvent.html">StrumCreationEvent</a>, <a class="type" title="funkin.scripting.events.WeekSelectEvent" href="../../../funkin/scripting/events/WeekSelectEvent.html">WeekSelectEvent</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-allow" title="Allows private access from package, type or field.">@:allow(ScriptPack)</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>()</code></h3><div class="doc"><p>Creates a new cancellable event.
|
||||
This allows scripts to call <code>cancel()</code> to cancel the event.</p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
@@ -7,6 +7,6 @@
|
||||
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> DanceEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></p></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></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({ danced : false })</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">danced:<span class="type">Bool</span> = false</span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="danced"></a><h3 class="anchor"><code><a href="#danced"><span class="identifier">danced</span></a>:<span class="type">Bool</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : true })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = true</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
</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> DanceEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></p></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></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({ danced : false })</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">danced:<span class="type">Bool</span> = false</span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="danced"></a><h3 class="anchor"><code><a href="#danced"><span class="identifier">danced</span></a>:<span class="type">Bool</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
@@ -10,6 +10,6 @@
|
||||
</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> InputSystemEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></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">pressed:<span class="type">Array</span><<span class="type">Bool</span>>,</span> <span style="white-space:nowrap">justPressed:<span class="type">Array</span><<span class="type">Bool</span>>,</span> <span style="white-space:nowrap">justReleased:<span class="type">Array</span><<span class="type">Bool</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="justPressed"></a><h3 class="anchor"><code><a href="#justPressed"><span class="identifier">justPressed</span></a>:<span class="type">Array</span><<span class="type">Bool</span>></code></h3><div class="doc"><p>Array containing whenever a specific control was pressed (not hold) this frame or not.
|
||||
For example, <code>justPressed[0]</code> will return whenever the left strum was just pressed.</p></div></div><div class="field "><a name="justReleased"></a><h3 class="anchor"><code><a href="#justReleased"><span class="identifier">justReleased</span></a>:<span class="type">Array</span><<span class="type">Bool</span>></code></h3><div class="doc"><p>Array containing whenever a specific control was released this frame or not.
|
||||
For example, <code>justReleased[0]</code> will return whenever the left strum was just released.</p></div></div><div class="field "><a name="pressed"></a><h3 class="anchor"><code><a href="#pressed"><span class="identifier">pressed</span></a>:<span class="type">Array</span><<span class="type">Bool</span>></code></h3><div class="doc"><p>Array containing whenever a specific control is pressed or not.
|
||||
For example, <code>pressed[0]</code> will return whenever the left strum was pressed.</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : true })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = true</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
For example, <code>pressed[0]</code> will return whenever the left strum was pressed.</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
File diff suppressed because one or more lines are too long
+12
@@ -0,0 +1,12 @@
|
||||
<!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.scripting.events.NameEvent</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> NameEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></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="name"></a><h3 class="anchor"><code><a href="#name"><span class="identifier">name</span></a>:<span class="type">String</span></code></h3><div class="doc"><p>Name</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
@@ -0,0 +1,12 @@
|
||||
<!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.scripting.events.PauseCreationEvent</title><meta name="description" content="CANCEL this event to prevent default behaviour!"/></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> PauseCreationEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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>CANCEL this event to prevent default behaviour!</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">music:<span class="type">String</span>,</span> <span style="white-space:nowrap">options:<span class="type">Array</span><<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="music"></a><h3 class="anchor"><code><a href="#music"><span class="identifier">music</span></a>:<span class="type">String</span></code></h3><div class="doc"><p>Music that is going to be played</p></div></div><div class="field "><a name="options"></a><h3 class="anchor"><code><a href="#options"><span class="identifier">options</span></a>:<span class="type">Array</span><<span class="type">String</span>></code></h3><div class="doc"><p>All option names</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
+1
-1
@@ -7,6 +7,6 @@
|
||||
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> PointEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></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">x:<span class="type">Float</span>,</span> <span style="white-space:nowrap">y:<span class="type">Float</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="x"></a><h3 class="anchor"><code><a href="#x"><span class="identifier">x</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>X position</p></div></div><div class="field "><a name="y"></a><h3 class="anchor"><code><a href="#y"><span class="identifier">y</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>Y position</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : true })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = true</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
</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> PointEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></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">x:<span class="type">Float</span>,</span> <span style="white-space:nowrap">y:<span class="type">Float</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="x"></a><h3 class="anchor"><code><a href="#x"><span class="identifier">x</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>X position</p></div></div><div class="field "><a name="y"></a><h3 class="anchor"><code><a href="#y"><span class="identifier">y</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>Y position</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
@@ -0,0 +1,12 @@
|
||||
<!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.scripting.events.RatingUpdateEvent</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> RatingUpdateEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></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">rating:<a class="type" title="funkin.game.ComboRating" href="../../../funkin/game/ComboRating.html">ComboRating</a>,</span> <span style="white-space:nowrap">oldRating:<a class="type" title="funkin.game.ComboRating" href="../../../funkin/game/ComboRating.html">ComboRating</a></span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="oldRating"></a><h3 class="anchor"><code><a href="#oldRating"><span class="identifier">oldRating</span></a>:<a class="type" title="funkin.game.ComboRating" href="../../../funkin/game/ComboRating.html">ComboRating</a></code></h3><div class="doc"><p>Old combo (may be null)</p></div></div><div class="field "><a name="rating"></a><h3 class="anchor"><code><a href="#rating"><span class="identifier">rating</span></a>:<a class="type" title="funkin.game.ComboRating" href="../../../funkin/game/ComboRating.html">ComboRating</a></code></h3><div class="doc"><p>New combo</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
+12
File diff suppressed because one or more lines are too long
+1
-1
@@ -7,6 +7,6 @@
|
||||
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> SimpleNoteEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></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">note:<a class="type" title="funkin.game.Note" href="../../../funkin/game/Note.html">Note</a></span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="note"></a><h3 class="anchor"><code><a href="#note"><span class="identifier">note</span></a>:<a class="type" title="funkin.game.Note" href="../../../funkin/game/Note.html">Note</a></code></h3><div class="doc"><p>Note that is affected.</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : true })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = true</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
</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> SimpleNoteEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></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">note:<a class="type" title="funkin.game.Note" href="../../../funkin/game/Note.html">Note</a></span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="note"></a><h3 class="anchor"><code><a href="#note"><span class="identifier">note</span></a>:<a class="type" title="funkin.game.Note" href="../../../funkin/game/Note.html">Note</a></code></h3><div class="doc"><p>Note that is affected.</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
+12
@@ -0,0 +1,12 @@
|
||||
<!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.scripting.events.StateEvent</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> StateEvent</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4><small>extends <a class="type" title="funkin.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</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></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">substate:<span class="type">FlxState</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="substate"></a><h3 class="anchor"><code><a href="#substate"><span class="identifier">substate</span></a>:<span class="type">FlxState</span></code></h3><div class="doc"><p>Substate that is about to be opened/closed</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="data"></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="#data"><span class="identifier">data</span></a>:<span class="type">Dynamic</span><span> = { }</span></code></h3><div class="doc"><p>Additional data if used in scripts</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.scripting.events.CancellableEvent" href="../../../funkin/scripting/events/CancellableEvent.html">CancellableEvent</a></h4><div style="display:none"><div class="field "><a name="preventDefault"></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({ c : false })</span><a href="#preventDefault"><span class="identifier">preventDefault</span></a>(<span style="white-space:nowrap">c:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Prevents default action from occuring.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>c</code></th><td><p>Whenever the scripts following this one should be called or not. (Defaults to <code>true</code>)</p></td></tr></table></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Returns a string representation of the event, in this format:
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a>]</code>
|
||||
<code>[<a href="../../../funkin/scripting/events/CancellableEvent.html#CancellableEvent">CancellableEvent</a> (Cancelled)]</code></p><p class="javadoc">Returns:</p><div class="indent inline-content"><p>String</p></div></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">© 2022 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
+1
-1
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+1
-1
File diff suppressed because one or more lines are too long
Vendored
+1
-1
@@ -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"><h1>funkin.scripting </h1> <table class="table table-condensed"><tbody><tr><th style="width:200px;"><i class="fa fa-folder-o"></i><a href="../../funkin/index.html" title="funkin">..</a></th><td></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../../funkin/scripting/events/index.html" title="funkin.scripting.events">events</a></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/DummyScript.html" title="funkin.scripting.DummyScript">DummyScript</a></td><td><p>Simple class for empty scripts or scripts whose language isn't imported yet.</p></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/HScript.html" title="funkin.scripting.HScript">HScript</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/Script.html" title="funkin.scripting.Script">Script</a></td><td><p>Class used for scripting.</p></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/ScriptPack.html" title="funkin.scripting.ScriptPack">ScriptPack</a></td><td><p></p></td></tr></tbody></table></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">© 2022 </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"><h1>funkin.scripting </h1> <table class="table table-condensed"><tbody><tr><th style="width:200px;"><i class="fa fa-folder-o"></i><a href="../../funkin/index.html" title="funkin">..</a></th><td></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../../funkin/scripting/events/index.html" title="funkin.scripting.events">events</a></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/DummyScript.html" title="funkin.scripting.DummyScript">DummyScript</a></td><td><p>Simple class for empty scripts or scripts whose language isn't imported yet.</p></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/GlobalScript.html" title="funkin.scripting.GlobalScript">GlobalScript</a></td><td><p>Class for THE Global Script, aka script that runs in the background at all times.</p></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/HScript.html" title="funkin.scripting.HScript">HScript</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/ModState.html" title="funkin.scripting.ModState">ModState</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/ModSubState.html" title="funkin.scripting.ModSubState">ModSubState</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/Script.html" title="funkin.scripting.Script">Script</a></td><td><p>Class used for scripting.</p></td></tr><tr class="class"><td style="width:200px;"><a href="../../funkin/scripting/ScriptPack.html" title="funkin.scripting.ScriptPack">ScriptPack</a></td><td><p></p></td></tr></tbody></table></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">© 2022 </p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>
|
||||
Reference in New Issue
Block a user