* bye * Updated docs * Adding docs to gitignore Useless to keep and upload too plus it contains sensitive stuff that takes when generating docs (eg: repo's saved path) It's prob smth that the docs program uses temporarily to generate * Re-exported gf chrimah Atlas exported christmas gf by @EnderNile8182 Gf adjusted offsets by me No more black lines Co-Authored-By: Nile <102095746+endernile8182@users.noreply.github.com> * Custom Credits * Better Custom Credits * Custom Credits template * Re-exported gf car Atlas exported car gf by @EnderNile8182 I've edited some strings in the xml No more black lines Co-Authored-By: Nile <102095746+endernile8182@users.noreply.github.com> * Re-exported gf tank Atlas exported tank gf by @EnderNile8182 Gf adjusted offsets by me No more black lines Co-Authored-By: Nile <102095746+endernile8182@users.noreply.github.com> * Yay finished gfs * Better Icons Mainly Fixed offsets and adjust Tankman ones (some transparent pixels) * Added bf x gf week 7 gameover * verbose!!!!!!!!!! ❗ * tank bg "bug" fix it was also giving an error what the hell is tankBg even * No more game freeze for desktop on freeplay * Some freeplay optimisations * Making .temp folder hidden idk i found it ugly * Reupdated docs --------- Co-authored-by: Nile <102095746+endernile8182@users.noreply.github.com>
10 lines
38 KiB
HTML
Vendored
10 lines
38 KiB
HTML
Vendored
<!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.editors.charter.Charter</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> Charter</h1><h4><small>package <a href="../../../funkin/editors/charter/index.html">funkin.editors.charter</a></small></h4><h4><small>extends <a class="type" title="funkin.editors.ui.UIState" href="../../../funkin/editors/ui/UIState.html">UIState</a> › <a class="type" title="funkin.backend.MusicBeatState" href="../../../funkin/backend/MusicBeatState.html">MusicBeatState</a></small></h4> <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.ClassExtendMacro.build())</span></div><div class="body"><div class="doc doc-main"><p></p></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="instance"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label">read only</span><a href="#instance"><span class="identifier">instance</span></a>:<a class="type" title="funkin.editors.charter.Charter" href="../../../funkin/editors/charter/Charter.html">Charter</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="startHere"></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><span class="label label-static">static</span><a href="#startHere"><span class="identifier">startHere</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="startTime"></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><span class="label label-static">static</span><a href="#startTime"><span class="identifier">startTime</span></a>:<span class="type">Float</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div></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({ reload : true })</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">song:<span class="type">String</span>,</span> <span style="white-space:nowrap">diff:<span class="type">String</span>,</span> <span style="white-space:nowrap">reload:<span class="type">Bool</span> = true</span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="addEventSpr"></a><h3 class="anchor"><code><a href="#addEventSpr"><span class="identifier">addEventSpr</span></a>:<a class="type" title="funkin.editors.charter.CharterEventAdd" href="../../../funkin/editors/charter/CharterEventAdd.html">CharterEventAdd</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="beatSeparator"></a><h3 class="anchor"><code><a href="#beatSeparator"><span class="identifier">beatSeparator</span></a>:<span class="type">FlxBackdrop</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="charterBG"></a><h3 class="anchor"><code><a href="#charterBG"><span class="identifier">charterBG</span></a>:<a class="type" title="funkin.backend.FunkinSprite" href="../../../funkin/backend/FunkinSprite.html">FunkinSprite</a></code></h3><div class="doc"><p>CONFIG & UI (might make this customizable later)</p></div></div><div class="field "><a name="charterCamera"></a><h3 class="anchor"><code><a href="#charterCamera"><span class="identifier">charterCamera</span></a>:<span class="type">FlxCamera</span></code></h3><div class="doc"><p>CAMERAS</p></div></div><div class="field "><a name="clipboard"></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="#clipboard"><span class="identifier">clipboard</span></a>:<span class="type">Array</span><<a class="type" title="funkin.editors.charter.CharterCopyboardObject" href="../../../funkin/editors/charter/CharterCopyboardObject.html">CharterCopyboardObject</a>><span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="conductorFollowerSpr"></a><h3 class="anchor"><code><a href="#conductorFollowerSpr"><span class="identifier">conductorFollowerSpr</span></a>:<span class="type">FlxSprite</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="eventsBackdrop"></a><h3 class="anchor"><code><a href="#eventsBackdrop"><span class="identifier">eventsBackdrop</span></a>:<span class="type">FlxBackdrop</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="eventsGroup"></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(new CharterEventGroup())</span><a href="#eventsGroup"><span class="identifier">eventsGroup</span></a>:<a class="type" title="funkin.editors.charter.CharterEventGroup" href="../../../funkin/editors/charter/CharterEventGroup.html">CharterEventGroup</a><span> = new CharterEventGroup()</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="gridBackdrop"></a><h3 class="anchor"><code><a href="#gridBackdrop"><span class="identifier">gridBackdrop</span></a>:<a class="type" title="funkin.editors.charter.CharterBackdrop" href="../../../funkin/editors/charter/CharterBackdrop.html">CharterBackdrop</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="gridBackdropDummy"></a><h3 class="anchor"><code><a href="#gridBackdropDummy"><span class="identifier">gridBackdropDummy</span></a>:<a class="type" title="funkin.editors.charter.CharterBackdropDummy" href="../../../funkin/editors/charter/CharterBackdropDummy.html">CharterBackdropDummy</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="hitsound"></a><h3 class="anchor"><code><a href="#hitsound"><span class="identifier">hitsound</span></a>:<span class="type">FlxSound</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="metronome"></a><h3 class="anchor"><code><a href="#metronome"><span class="identifier">metronome</span></a>:<span class="type">FlxSound</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="notesGroup"></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(new CharterNoteGroup())</span><a href="#notesGroup"><span class="identifier">notesGroup</span></a>:<a class="type" title="funkin.editors.charter.CharterNoteGroup" href="../../../funkin/editors/charter/CharterNoteGroup.html">CharterNoteGroup</a><span> = new CharterNoteGroup()</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="redoList"></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="#redoList"><span class="identifier">redoList</span></a>:<span class="type">Array</span><<a class="type" title="funkin.editors.charter.CharterChange" href="../../../funkin/editors/charter/CharterChange.html">CharterChange</a>><span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="scrollBar"></a><h3 class="anchor"><code><a href="#scrollBar"><span class="identifier">scrollBar</span></a>:<a class="type" title="funkin.editors.ui.UIScrollBar" href="../../../funkin/editors/ui/UIScrollBar.html">UIScrollBar</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="sectionSeparator"></a><h3 class="anchor"><code><a href="#sectionSeparator"><span class="identifier">sectionSeparator</span></a>:<span class="type">FlxBackdrop</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="selection"></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="#selection"><span class="identifier">selection</span></a>:<span class="type">Array</span><<a class="type" title="funkin.editors.charter.CharterNote" href="../../../funkin/editors/charter/CharterNote.html">CharterNote</a>><span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="selectionBox"></a><h3 class="anchor"><code><a href="#selectionBox"><span class="identifier">selectionBox</span></a>:<a class="type" title="funkin.editors.ui.UISliceSprite" href="../../../funkin/editors/ui/UISliceSprite.html">UISliceSprite</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="songPosInfo"></a><h3 class="anchor"><code><a href="#songPosInfo"><span class="identifier">songPosInfo</span></a>:<a class="type" title="funkin.editors.ui.UIText" href="../../../funkin/editors/ui/UIText.html">UIText</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="strumLines"></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(new FlxTypedGroup<CharterStrumline>())</span><a href="#strumLines"><span class="identifier">strumLines</span></a>:<span class="type">FlxTypedGroup</span><<a class="type" title="funkin.editors.charter.CharterStrumline" href="../../../funkin/editors/charter/CharterStrumline.html">CharterStrumline</a>><span> = new FlxTypedGroup<CharterStrumline>()</span></code></h3><div class="doc"><p>ACTUAL CHART DATA</p></div></div><div class="field "><a name="strumlineAddButton"></a><h3 class="anchor"><code><a href="#strumlineAddButton"><span class="identifier">strumlineAddButton</span></a>:<a class="type" title="funkin.editors.charter.CharterStrumlineExtraButton" href="../../../funkin/editors/charter/CharterStrumlineExtraButton.html">CharterStrumlineExtraButton</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="strumlineInfoBG"></a><h3 class="anchor"><code><a href="#strumlineInfoBG"><span class="identifier">strumlineInfoBG</span></a>:<span class="type">FlxSprite</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="topLimit"></a><h3 class="anchor"><code><a href="#topLimit"><span class="identifier">topLimit</span></a>:<span class="type">FlxSprite</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="topMenu"></a><h3 class="anchor"><code><a href="#topMenu"><span class="identifier">topMenu</span></a>:<span class="type">Array</span><<a class="type" title="funkin.editors.ui.UIContextMenuOption" href="../../../funkin/editors/ui/UIContextMenuOption.html">UIContextMenuOption</a>></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="topMenuSpr"></a><h3 class="anchor"><code><a href="#topMenuSpr"><span class="identifier">topMenuSpr</span></a>:<a class="type" title="funkin.editors.ui.UITopMenu" href="../../../funkin/editors/ui/UITopMenu.html">UITopMenu</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="uiCamera"></a><h3 class="anchor"><code><a href="#uiCamera"><span class="identifier">uiCamera</span></a>:<span class="type">FlxCamera</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="uiGroup"></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(new FlxTypedGroup<FlxSprite>())</span><a href="#uiGroup"><span class="identifier">uiGroup</span></a>:<span class="type">FlxTypedGroup</span><<span class="type">FlxSprite</span>><span> = new FlxTypedGroup<FlxSprite>()</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="undoList"></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="#undoList"><span class="identifier">undoList</span></a>:<span class="type">Array</span><<a class="type" title="funkin.editors.charter.CharterChange" href="../../../funkin/editors/charter/CharterChange.html">CharterChange</a>><span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="vocals"></a><h3 class="anchor"><code><a href="#vocals"><span class="identifier">vocals</span></a>:<span class="type">FlxSound</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="addToUndo"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#addToUndo"><span class="identifier">addToUndo</span></a>(<span style="white-space:nowrap">c:<a class="type" title="funkin.editors.charter.CharterChange" href="../../../funkin/editors/charter/CharterChange.html">CharterChange</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="buildChart"></a><h3 class="anchor"><code><a href="#buildChart"><span class="identifier">buildChart</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="createStrumWithUI"></a><h3 class="anchor"><code><a href="#createStrumWithUI"><span class="identifier">createStrumWithUI</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="createStrumline"></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({ addToUndo : true })</span><a href="#createStrumline"><span class="identifier">createStrumline</span></a>(<span style="white-space:nowrap">strumLineID:<span class="type">Int</span>,</span> <span style="white-space:nowrap">strL:<a class="type" title="funkin.backend.chart.ChartStrumLine" href="../../../funkin/backend/chart/ChartStrumLine.html">ChartStrumLine</a>,</span> <span style="white-space:nowrap">addToUndo:<span class="type">Bool</span> = true</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="deleteNote"></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({ addToUndo : true })</span><a href="#deleteNote"><span class="identifier">deleteNote</span></a>(<span style="white-space:nowrap">note:<a class="type" title="funkin.editors.charter.CharterNote" href="../../../funkin/editors/charter/CharterNote.html">CharterNote</a>,</span> <span style="white-space:nowrap">addToUndo:<span class="type">Bool</span> = true</span>):<a class="type" title="funkin.editors.charter.CharterNote" href="../../../funkin/editors/charter/CharterNote.html">CharterNote</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="deleteNotes"></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({ addToUndo : true })</span><a href="#deleteNotes"><span class="identifier">deleteNotes</span></a>(<span style="white-space:nowrap">notes:<span class="type">Array</span><<a class="type" title="funkin.editors.charter.CharterNote" href="../../../funkin/editors/charter/CharterNote.html">CharterNote</a>>,</span> <span style="white-space:nowrap">addToUndo:<span class="type">Bool</span> = true</span>):<span class="type">Array</span><<a class="type" title="funkin.editors.charter.CharterNote" href="../../../funkin/editors/charter/CharterNote.html">CharterNote</a>></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="deleteStrumline"></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({ addToUndo : true })</span><a href="#deleteStrumline"><span class="identifier">deleteStrumline</span></a>(<span style="white-space:nowrap">strumLineID:<span class="type">Int</span>,</span> <span style="white-space:nowrap">addToUndo:<span class="type">Bool</span> = true</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="deleteStrumlineFromData"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#deleteStrumlineFromData"><span class="identifier">deleteStrumlineFromData</span></a>(<span style="white-space:nowrap">strL:<a class="type" title="funkin.backend.chart.ChartStrumLine" href="../../../funkin/backend/chart/ChartStrumLine.html">ChartStrumLine</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="editStrumline"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#editStrumline"><span class="identifier">editStrumline</span></a>(<span style="white-space:nowrap">strL:<a class="type" title="funkin.backend.chart.ChartStrumLine" href="../../../funkin/backend/chart/ChartStrumLine.html">ChartStrumLine</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getHoveredEvent"></a><h3 class="anchor"><code><a href="#getHoveredEvent"><span class="identifier">getHoveredEvent</span></a>(<span style="white-space:nowrap">y:<span class="type">Float</span></span>):<a class="type" title="funkin.editors.charter.CharterEvent" href="../../../funkin/editors/charter/CharterEvent.html">CharterEvent</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getStrumlineID"></a><h3 class="anchor"><code><a href="#getStrumlineID"><span class="identifier">getStrumlineID</span></a>(<span style="white-space:nowrap">strL:<a class="type" title="funkin.backend.chart.ChartStrumLine" href="../../../funkin/backend/chart/ChartStrumLine.html">ChartStrumLine</a></span>):<span class="type">Int</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="hitsoundsEnabled"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#hitsoundsEnabled"><span class="identifier">hitsoundsEnabled</span></a>(<span style="white-space:nowrap">id:<span class="type">Int</span></span>):<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="loadSong"></a><h3 class="anchor"><code><a href="#loadSong"><span class="identifier">loadSong</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="playtestChart"></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({ here : false, opponentMode : false, time : 0 })</span><a href="#playtestChart"><span class="identifier">playtestChart</span></a>(<span style="white-space:nowrap">time:<span class="type">Float</span> = 0,</span> <span style="white-space:nowrap">opponentMode:<span class="type">Bool</span> = false,</span> <span style="white-space:nowrap">here:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="refreshBPMSensitive"></a><h3 class="anchor"><code><a href="#refreshBPMSensitive"><span class="identifier">refreshBPMSensitive</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="removeStrumlineFromSelection"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#removeStrumlineFromSelection"><span class="identifier">removeStrumlineFromSelection</span></a>(<span style="white-space:nowrap">strumLineID:<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="sortNotes"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#sortNotes"><span class="identifier">sortNotes</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="updateNoteLogic"></a><h3 class="anchor"><code><a href="#updateNoteLogic"><span class="identifier">updateNoteLogic</span></a>(<span style="white-space:nowrap">elapsed:<span class="type">Float</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div> <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="funkin.editors.ui.UIState" href="../../../funkin/editors/ui/UIState.html">UIState</a></h4><div style="display:none"><div class="field "><a name="buttonHandler"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(null)</span><a href="#buttonHandler"><span class="identifier">buttonHandler</span></a>:() ‑> <span class="type">Void</span><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="curContextMenu"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(null)</span><a href="#curContextMenu"><span class="identifier">curContextMenu</span></a>:<a class="type" title="funkin.editors.ui.UIContextMenu" href="../../../funkin/editors/ui/UIContextMenu.html">UIContextMenu</a><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="currentCursor"></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(ARROW)</span><a href="#currentCursor"><span class="identifier">currentCursor</span></a>:<span class="type">MouseCursor</span><span> = ARROW</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="currentFocus"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(null)</span><a href="#currentFocus"><span class="identifier">currentFocus</span></a>:<a class="type" title="funkin.editors.ui.IUIFocusable" href="../../../funkin/editors/ui/IUIFocusable.html">IUIFocusable</a><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="hoveredSprite"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(null)</span><a href="#hoveredSprite"><span class="identifier">hoveredSprite</span></a>:<a class="type" title="funkin.editors.ui.UISprite" href="../../../funkin/editors/ui/UISprite.html">UISprite</a><span> = null</span></code></h3><div class="doc"><p></p></div></div></div><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="funkin.backend.MusicBeatState" href="../../../funkin/backend/MusicBeatState.html">MusicBeatState</a></h4><div style="display:none"><div class="field "><a name="cancelConductorUpdate"></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="#cancelConductorUpdate"><span class="identifier">cancelConductorUpdate</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p>Whenever the Conductor auto update should be enabled or not.</p></div></div><div class="field "><a name="controls"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#controls"><span class="identifier">controls</span></a>:<a class="type" title="funkin.backend.system.Controls - A list of actions that a player would invoke via some input device." href="../../../funkin/backend/system/Controls.html">Controls</a></code></h3><div class="doc"><p>Game Controls. (All players / Solo)</p></div></div><div class="field "><a name="controlsP1"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#controlsP1"><span class="identifier">controlsP1</span></a>:<a class="type" title="funkin.backend.system.Controls - A list of actions that a player would invoke via some input device." href="../../../funkin/backend/system/Controls.html">Controls</a></code></h3><div class="doc"><p>Game Controls (Player 1 only)</p></div></div><div class="field "><a name="controlsP2"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#controlsP2"><span class="identifier">controlsP2</span></a>:<a class="type" title="funkin.backend.system.Controls - A list of actions that a player would invoke via some input device." href="../../../funkin/backend/system/Controls.html">Controls</a></code></h3><div class="doc"><p>Game Controls (Player 2 only)</p></div></div><div class="field "><a name="curBeat"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#curBeat"><span class="identifier">curBeat</span></a>:<span class="type">Int</span></code></h3><div class="doc"><p>Current beat</p></div></div><div class="field "><a name="curBeatFloat"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#curBeatFloat"><span class="identifier">curBeatFloat</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>Current beat, as a <code>Float</code> (ex: 1.24, instead of 1)</p></div></div><div class="field "><a name="curMeasure"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#curMeasure"><span class="identifier">curMeasure</span></a>:<span class="type">Int</span></code></h3><div class="doc"><p>Current beat</p></div></div><div class="field "><a name="curMeasureFloat"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#curMeasureFloat"><span class="identifier">curMeasureFloat</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>Current beat, as a <code>Float</code> (ex: 1.24, instead of 1)</p></div></div><div class="field "><a name="curStep"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#curStep"><span class="identifier">curStep</span></a>:<span class="type">Int</span></code></h3><div class="doc"><p>Current step</p></div></div><div class="field "><a name="curStepFloat"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#curStepFloat"><span class="identifier">curStepFloat</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>Current step, as a <code>Float</code> (ex: 4.94, instead of 4)</p></div></div><div class="field "><a name="graphicCache"></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(new GraphicCacheSprite())</span><a href="#graphicCache"><span class="identifier">graphicCache</span></a>:<a class="type" title="funkin.backend.system.GraphicCacheSprite - Dummy FlxSprite that allows you to cache FlxGraphics, and immediatly send them to GPU memory." href="../../../funkin/backend/system/GraphicCacheSprite.html">GraphicCacheSprite</a><span> = new GraphicCacheSprite()</span></code></h3><div class="doc"><p>Dummy sprite used to cache graphics to GPU.</p></div></div><div class="field "><a name="scriptName"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value(null)</span><a href="#scriptName"><span class="identifier">scriptName</span></a>:<span class="type">String</span><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="scriptsAllowed"></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(true)</span><a href="#scriptsAllowed"><span class="identifier">scriptsAllowed</span></a>:<span class="type">Bool</span><span> = true</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="songPos"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#songPos"><span class="identifier">songPos</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>Current song position (in milliseconds).</p></div></div><div class="field "><a name="stateScript"></a><h3 class="anchor"><code><a href="#stateScript"><span class="identifier">stateScript</span></a>:<a class="type" title="funkin.backend.scripting.Script" href="../../../funkin/backend/scripting/Script.html">Script</a></code></h3><div class="doc"><p>Current injected script attached to the state. To add one, create a file at path "data/states/stateName" (ex: data/states/FreeplayState)</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.editors.ui.UIState" href="../../../funkin/editors/ui/UIState.html">UIState</a></h4><div style="display:none"><div class="field "><a name="closeCurrentContextMenu"></a><h3 class="anchor"><code><a href="#closeCurrentContextMenu"><span class="identifier">closeCurrentContextMenu</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="isOverlapping"></a><h3 class="anchor"><code><a href="#isOverlapping"><span class="identifier">isOverlapping</span></a>(<span style="white-space:nowrap">spr:<a class="type" title="funkin.editors.ui.UISprite" href="../../../funkin/editors/ui/UISprite.html">UISprite</a>,</span> <span style="white-space:nowrap">rect:<span class="type">FlxRect</span></span>):<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="openContextMenu"></a><h3 class="anchor"><code><a href="#openContextMenu"><span class="identifier">openContextMenu</span></a>(<span style="white-space:nowrap">options:<span class="type">Array</span><<a class="type" title="funkin.editors.ui.UIContextMenuOption" href="../../../funkin/editors/ui/UIContextMenuOption.html">UIContextMenuOption</a>>,</span> <span style="white-space:nowrap">?callback:<span class="type">Null</span><<a class="type" title="funkin.editors.ui.UIContextMenuCallback" href="../../../funkin/editors/ui/UIContextMenuCallback.html">UIContextMenuCallback</a>>,</span> <span style="white-space:nowrap">?x:<span class="type">Float</span>,</span> <span style="white-space:nowrap">?y:<span class="type">Float</span></span>):<a class="type" title="funkin.editors.ui.UIContextMenu" href="../../../funkin/editors/ui/UIContextMenu.html">UIContextMenu</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="updateButtonHandler"></a><h3 class="anchor"><code><a href="#updateButtonHandler"><span class="identifier">updateButtonHandler</span></a>(<span style="white-space:nowrap">spr:<a class="type" title="funkin.editors.ui.UISprite" href="../../../funkin/editors/ui/UISprite.html">UISprite</a>,</span> <span style="white-space:nowrap">buttonHandler:() ‑> <span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="updateRectButtonHandler"></a><h3 class="anchor"><code><a href="#updateRectButtonHandler"><span class="identifier">updateRectButtonHandler</span></a>(<span style="white-space:nowrap">spr:<a class="type" title="funkin.editors.ui.UISprite" href="../../../funkin/editors/ui/UISprite.html">UISprite</a>,</span> <span style="white-space:nowrap">rect:<span class="type">FlxRect</span>,</span> <span style="white-space:nowrap">buttonHandler:() ‑> <span class="type">Void</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="funkin.backend.MusicBeatState" href="../../../funkin/backend/MusicBeatState.html">MusicBeatState</a></h4><div style="display:none"><div class="field "><a name="call"></a><h3 class="anchor"><code><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 style="white-space:nowrap">?defaultVal:<span class="type">Dynamic</span></span>):<span class="type">Dynamic</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="event"></a><h3 class="anchor"><code><a href="#event"><span class="identifier">event</span></a><<span class="type">T</span>>(<span style="white-space:nowrap">name:<span class="type">String</span>,</span> <span style="white-space:nowrap">event:<span class="type">T</span></span>):<span class="type">T</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="lerp"></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({ fpsSensitive : false })</span><a href="#lerp"><span class="identifier">lerp</span></a>(<span style="white-space:nowrap">v1:<span class="type">Float</span>,</span> <span style="white-space:nowrap">v2:<span class="type">Float</span>,</span> <span style="white-space:nowrap">ratio:<span class="type">Float</span>,</span> <span style="white-space:nowrap">fpsSensitive:<span class="type">Bool</span> = false</span>):<span class="type">Float</span></code></h3><div class="doc"><p>Shortcut to <code>FlxMath.lerp</code> or <code><a href="../../funkin/backend/utils/CoolUtil.html#lerp">CoolUtil.lerp</a></code>, depending on <code>fpsSensitive</code></p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>v1</code></th><td><p>Value 1</p></td></tr><tr><th style="width:25%;"><code>v2</code></th><td><p>Value 2</p></td></tr><tr><th style="width:25%;"><code>ratio</code></th><td><p>Ratio</p></td></tr><tr><th style="width:25%;"><code>fpsSensitive</code></th><td><p>Whenever the ratio should not be adjusted to run at the same speed independent of framerate.</p></td></tr></table></div></div><div class="field "><a name="openSubState"></a><h3 class="anchor"><code><a href="#openSubState"><span class="identifier">openSubState</span></a>(<span style="white-space:nowrap">subState:<span class="type">FlxSubState</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>SCRIPTING STUFF</p></div></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">© 2023 </p></div></div></footer><script src="../../..//highlighter.js"></script><link href="../../../highlighter.css" rel="stylesheet"/></body></html> |