CodenameEngine/pages/funkin/game/Note.html

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../extra-styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><link href="../../dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "../../",platforms: ["doc"]};</script><script src="../../nav.js"></script><script src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"/><title>funkin.game.Note</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> Note</h1><h4><small>package <a href="../../funkin/game/index.html">funkin.game</a></small></h4><h4><small>extends <span class="type">FlxSprite</span></small></h4>    <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.ClassExtendMacro.build())</span><span class="label label-meta label-meta-allow" title="Allows private access from package, type or field.">@:allow(funkin.game.PlayState)</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="swagWidth"></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(160 * 0.7)</span><span class="label label-static">static</span><a href="#swagWidth"><span class="identifier">swagWidth</span></a>:<span class="type">Float</span><span> = 160 * 0.7</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({ sustainOffset : 0, sustainLength : 0, sustain : false })</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">strumLine:<a class="type" title="funkin.game.StrumLine" href="../../funkin/game/StrumLine.html">StrumLine</a>,</span> <span style="white-space:nowrap">noteData:<a class="type" title="funkin.backend.chart.ChartNote" href="../../funkin/backend/chart/ChartNote.html">ChartNote</a>,</span> <span style="white-space:nowrap">sustain:<span class="type">Bool</span> = false,</span> <span style="white-space:nowrap">sustainLength:<span class="type">Float</span> = 0,</span> <span style="white-space:nowrap">sustainOffset:<span class="type">Float</span> = 0</span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="angleOffsets"></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="#angleOffsets"><span class="identifier">angleOffsets</span></a>:<span class="type">Bool</span><span> = true</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="animSuffix"></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="#animSuffix"><span class="identifier">animSuffix</span></a>:<span class="type">String</span><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="avoid"></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="#avoid"><span class="identifier">avoid</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p>Whenever that note should be avoided by Botplay.</p></div></div><div class="field "><a name="canBeHit"></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="#canBeHit"><span class="identifier">canBeHit</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="earlyPressWindow"></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.5)</span><a href="#earlyPressWindow"><span class="identifier">earlyPressWindow</span></a>:<span class="type">Float</span><span> = 0.5</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="extra"></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="#extra"><span class="identifier">extra</span></a>:<span class="type">Map</span>&lt;<span class="type">String</span>, <span class="type">Dynamic</span>&gt;<span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="flipSustain"></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="#flipSustain"><span class="identifier">flipSustain</span></a>:<span class="type">Bool</span><span> = true</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="isSustainNote"></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="#isSustainNote"><span class="identifier">isSustainNote</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="lastScrollSpeed"></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="#lastScrollSpeed"><span class="identifier">lastScrollSpeed</span></a>:<span class="type">Null</span>&lt;<span class="type">Float</span>&gt;<span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="latePressWindow"></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(1)</span><a href="#latePressWindow"><span class="identifier">latePressWindow</span></a>:<span class="type">Float</span><span> = 1</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="mustPress"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#mustPress"><span class="identifier">mustPress</span></a>:<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="nextNote"></a><h3 class="anchor"><code><a href="#nextNote"><span class="identifier">nextNote</span></a>:<a class="type" title="funkin.game.Note" href="../../funkin/game/Note.html">Note</a></code></h3><div class="doc"><p>The note that comes after this one (sustain and not)</p></div></div><div class="field "><a name="nextSustain"></a><h3 class="anchor"><code><a href="#nextSustain"><span class="identifier">nextSustain</span></a>:<a class="type" title="funkin.game.Note" href="../../funkin/game/Note.html">Note</a></code></h3><div class="doc"><p>The next sustain after this one</p></div></div><div class="field "><a name="noteAngle"></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="#noteAngle"><span class="identifier">noteAngle</span></a>:<span class="type">Null</span>&lt;<span class="type">Float</span>&gt;<span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="noteData"></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="#noteData"><span class="identifier">noteData</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="noteType"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#noteType"><span class="identifier">noteType</span></a>:<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="noteTypeID"></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="#noteTypeID"><span class="identifier">noteTypeID</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="prevNote"></a><h3 class="anchor"><code><a href="#prevNote"><span class="identifier">prevNote</span></a>:<a class="type" title="funkin.game.Note" href="../../funkin/game/Note.html">Note</a></code></h3><div class="doc"><p>The note that comes before this one (sustain and not)</p></div></div><div class="field "><a name="scrollSpeed"></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="#scrollSpeed"><span class="identifier">scrollSpeed</span></a>:<span class="type">Null</span>&lt;<span class="type">Float</span>&gt;<span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="splash"></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(&quot;default&quot;)</span><a href="#splash"><span class="identifier">splash</span></a>:<span class="type">String</span><span> = &quot;default&quot;</span></code></h3><div class="doc"><p>Name of the splash.</p></div></div><div class="field "><a name="strumID"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#strumID"><span class="identifier">strumID</span></a>:<span class="type">Int</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="strumLine"></a><h3 class="anchor"><code><a href="#strumLine"><span class="identifier">strumLine</span></a>:<a class="type" title="funkin.game.StrumLine" href="../../funkin/game/StrumLine.html">StrumLine</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="strumRelativePos"></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="#strumRelativePos"><span class="identifier">strumRelativePos</span></a>:<span class="type">Bool</span><span> = true</span></code></h3><div class="doc"><p>Whenever the position of the note should be relative to the strum position or not.
For example, if this is true, a note at the position 0; 0 will be on the strum, instead of at the top left of the screen.</p></div></div><div class="field "><a name="strumTime"></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="#strumTime"><span class="identifier">strumTime</span></a>:<span class="type">Float</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="sustainLength"></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="#sustainLength"><span class="identifier">sustainLength</span></a>:<span class="type">Float</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="tooLate"></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="#tooLate"><span class="identifier">tooLate</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="useAntialiasingFix"></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="#useAntialiasingFix"><span class="identifier">useAntialiasingFix</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="wasGoodHit"></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="#wasGoodHit"><span class="identifier">wasGoodHit</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="setClipRect"></a><h3 class="anchor"><code><a href="#setClipRect"><span class="identifier">setClipRect</span></a>(<span style="white-space:nowrap">rect:<span class="type">FlxRect</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="updateSustain"></a><h3 class="anchor"><code><a href="#updateSustain"><span class="identifier">updateSustain</span></a>(<span style="white-space:nowrap">strum:<a class="type" title="funkin.game.Strum" href="../../funkin/game/Strum.html">Strum</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div></div>  </div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">&copy; 2023 &nbsp;</p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>