gabry/CodenameEngine
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
YoshiCrafter29
2022-10-10 15:50:25 +02:00
parent 3732db7349
commit 126a5bf479
11 changed files with 1052 additions and 904 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/doc.xml
+1018 -895
View File
File diff suppressed because it is too large Load Diff
pages/funkin/game/Character.html
+1 -1
View File
File diff suppressed because one or more lines are too long
pages/funkin/scripting/events/CancellableEvent.html
+1 -1
View File
@@ -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.InputSystemEvent" href="../../../funkin/scripting/events/InputSystemEvent.html">InputSystemEvent</a>, <a class="type" title="funkin.scripting.events.NoteHitEvent" href="../../../funkin/scripting/events/NoteHitEvent.html">NoteHitEvent</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.
</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.InputSystemEvent" href="../../../funkin/scripting/events/InputSystemEvent.html">InputSystemEvent</a>, <a class="type" title="funkin.scripting.events.NoteHitEvent" href="../../../funkin/scripting/events/NoteHitEvent.html">NoteHitEvent</a>, <a class="type" title="funkin.scripting.events.PlayAnimEvent" href="../../../funkin/scripting/events/PlayAnimEvent.html">PlayAnimEvent</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:
<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">&copy; 2022 &nbsp;</p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
pages/funkin/scripting/events/NoteHitEvent.html
+1 -1
View File
File diff suppressed because one or more lines are too long
pages/funkin/scripting/events/PlayAnimContext.html
+10
View File
@@ -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.events.PlayAnimContext</title><meta name="description" content="Contains all contexts possible for &lt;code&gt;&lt;a href=&quot;../../../funkin/scripting/events/PlayAnimEvent.html#PlayAnimEvent&quot;&gt;PlayAnimEvent&lt;/a&gt;&lt;/code&gt;."/></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>enum abstract</small> PlayAnimContext(<span class="type">String</span>)</h1><h4><small>package <a href="../../../funkin/scripting/events/index.html">funkin.scripting.events</a></small></h4><h4></h4><h4><small>import <a href="../../../funkin/scripting/events/PlayAnimEvent.html">funkin.scripting.events.PlayAnimEvent</a></small></h4><span class="label label-meta label-meta-enum" title="Defines finite value sets to abstract definitions.">@:enum</span></div><div class="body"><div class="doc doc-main"><p>Contains all contexts possible for <code><a href="../../../funkin/scripting/events/PlayAnimEvent.html#PlayAnimEvent">PlayAnimEvent</a></code>.</p></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="MISS"></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(cast &quot;MISS&quot;)</span><span class="label label-meta label-meta-impl" title="Used internally to mark abstract implementation fields.">@:impl</span><span class="label label-meta label-meta-enum" title="Defines finite value sets to abstract definitions.">@:enum</span><span class="label label-inline">inline</span><span class="label">read only</span><a href="#MISS"><span class="identifier">MISS</span></a>:<a class="type" title="funkin.scripting.events.PlayAnimContext - Contains all contexts possible for PlayAnimEvent." href="../../../funkin/scripting/events/PlayAnimContext.html">PlayAnimContext</a><span> = &quot;MISS&quot;</span></code></h3><div class="doc"><p>Whenever a note is missed and a miss animation will be played.</p></div></div><div class="field "><a name="NONE"></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(cast null)</span><span class="label label-meta label-meta-impl" title="Used internally to mark abstract implementation fields.">@:impl</span><span class="label label-meta label-meta-enum" title="Defines finite value sets to abstract definitions.">@:enum</span><span class="label label-inline">inline</span><span class="label">read only</span><a href="#NONE"><span class="identifier">NONE</span></a>:<a class="type" title="funkin.scripting.events.PlayAnimContext - Contains all contexts possible for PlayAnimEvent." href="../../../funkin/scripting/events/PlayAnimContext.html">PlayAnimContext</a><span> = null</span></code></h3><div class="doc"><p>No context was given for the animation</p></div></div><div class="field "><a name="SING"></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(cast &quot;SING&quot;)</span><span class="label label-meta label-meta-impl" title="Used internally to mark abstract implementation fields.">@:impl</span><span class="label label-meta label-meta-enum" title="Defines finite value sets to abstract definitions.">@:enum</span><span class="label label-inline">inline</span><span class="label">read only</span><a href="#SING"><span class="identifier">SING</span></a>:<a class="type" title="funkin.scripting.events.PlayAnimContext - Contains all contexts possible for PlayAnimEvent." href="../../../funkin/scripting/events/PlayAnimContext.html">PlayAnimContext</a><span> = &quot;SING&quot;</span></code></h3><div class="doc"><p>Whenever a note is hit and a sing animation will be played.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2022 &nbsp;</p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
pages/funkin/scripting/events/PlayAnimEvent.html
+12
View File
File diff suppressed because one or more lines are too long
pages/funkin/scripting/events/index.html
+1 -1
View File
@@ -7,4 +7,4 @@
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><h1>funkin.scripting.events </h1> <table class="table table-condensed"><tbody><tr><th style="width:200px;"><i class="fa fa-folder-o"></i><a href="../../../funkin/scripting/index.html" title="funkin.scripting">..</a></th><td></td></tr><tr class="class"><td style="width:200px;"><a href="../../../funkin/scripting/events/CancellableEvent.html" title="funkin.scripting.events.CancellableEvent">CancellableEvent</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="../../../funkin/scripting/events/InputSystemEvent.html" title="funkin.scripting.events.InputSystemEvent">InputSystemEvent</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="../../../funkin/scripting/events/NoteHitEvent.html" title="funkin.scripting.events.NoteHitEvent">NoteHitEvent</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">&copy; 2022 &nbsp;</p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><h1>funkin.scripting.events </h1> <table class="table table-condensed"><tbody><tr><th style="width:200px;"><i class="fa fa-folder-o"></i><a href="../../../funkin/scripting/index.html" title="funkin.scripting">..</a></th><td></td></tr><tr class="class"><td style="width:200px;"><a href="../../../funkin/scripting/events/CancellableEvent.html" title="funkin.scripting.events.CancellableEvent">CancellableEvent</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="../../../funkin/scripting/events/InputSystemEvent.html" title="funkin.scripting.events.InputSystemEvent">InputSystemEvent</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="../../../funkin/scripting/events/NoteHitEvent.html" title="funkin.scripting.events.NoteHitEvent">NoteHitEvent</a></td><td><p></p></td></tr><tr class="abstract"><td style="width:200px;"><a href="../../../funkin/scripting/events/PlayAnimContext.html" title="funkin.scripting.events.PlayAnimContext">PlayAnimContext</a></td><td><p>Contains all contexts possible for <code><a href="../../../funkin/scripting/events/PlayAnimEvent.html#PlayAnimEvent">PlayAnimEvent</a></code>.</p></td></tr><tr class="class"><td style="width:200px;"><a href="../../../funkin/scripting/events/PlayAnimEvent.html" title="funkin.scripting.events.PlayAnimEvent">PlayAnimEvent</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">&copy; 2022 &nbsp;</p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html>
pages/nav.js
+1 -1
View File
File diff suppressed because one or more lines are too long
source/funkin/game/Character.hx
+3 -3
View File
@@ -17,8 +17,8 @@ import haxe.xml.Access;
import haxe.Exception;
import funkin.system.Conductor;
import funkin.events.PlayAnimEvent;
import funkin.events.PlayAnimEvent.PlayAnimContext;
import funkin.scripting.events.PlayAnimEvent;
import funkin.scripting.events.PlayAnimEvent.PlayAnimContext;
using StringTools;
class Character extends FlxSprite implements IBeatReceiver implements IOffsetCompatible
@@ -356,7 +356,7 @@ class Character extends FlxSprite implements IBeatReceiver implements IOffsetCom
if (event.cancelled || event.animName == null) return;
animation.play(event.animName, event.force, event.reversed, event.startingFrame);
animation.play(event.animName, event.force, event.reverse, event.startingFrame);
var daOffset = animOffsets.get(event.animName);
if (daOffset != null)
source/funkin/scripting/events/PlayAnimEvent.hx
+1 -1
View File
@@ -39,7 +39,7 @@ class PlayAnimEvent extends CancellableEvent {
Contains all contexts possible for `PlayAnimEvent`.
**/
@:enum
abstract PlayAnimContext(String) = {
abstract PlayAnimContext(String) {
/**
No context was given for the animation
**/
source/scripting/PlayStateScript.hx
+3
View File
@@ -5,7 +5,10 @@ import funkin.scripting.events.*;
/**
* Contains all callbacks you can add in modcharts and stage scripts.
*
*
*
* NOTE: In case you're scripting a stage, all sprites of that stage are directly accessible via their name.
*
* Ex: If you added a `superCoolBG` element in your stage XML, you'll be able to access it via scripts by using `superCoolBG`.
*/
interface PlayStateScript {