CodenameEngine/pages/funkin/backend/system/Conductor.html

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../../jquery-1.9.1.min.js"></script><script src="../../../bootstrap/js/bootstrap.min.js"></script><script src="../../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../../styles.css" rel="stylesheet"/><link href="../../../extra-styles.css" rel="stylesheet"/><link href="../../../haxe-nav.css" rel="stylesheet"/><link href="../../../dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "../../../",platforms: ["doc"]};</script><script src="../../../nav.js"></script><script src="../../../index.js"></script><link rel="icon" href="../../../favicon.ico" type="image/x-icon"/><title>funkin.backend.system.Conductor</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> Conductor</h1><h4><small>package <a href="../../../funkin/backend/system/index.html">funkin.backend.system</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="beatsPerMesure"></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(4)</span><span class="label label-static">static</span><a href="#beatsPerMesure"><span class="identifier">beatsPerMesure</span></a>:<span class="type">Float</span><span> = 4</span></code></h3><div class="doc"><p>Number of beats per mesure (top number in time signature). Defaults to 4.</p></div></div><div class="field "><a name="bpm"></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(100)</span><span class="label label-static">static</span><a href="#bpm"><span class="identifier">bpm</span></a>:<span class="type">Float</span><span> = 100</span></code></h3><div class="doc"><p>Current BPM</p></div></div><div class="field "><a name="bpmChangeMap"></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><span class="label label-static">static</span><a href="#bpmChangeMap"><span class="identifier">bpmChangeMap</span></a>:<span class="type">Array</span>&lt;<a class="type" title="funkin.backend.system.BPMChangeEvent - ..." href="../../../funkin/backend/system/BPMChangeEvent.html">BPMChangeEvent</a>&gt;<span> = []</span></code></h3><div class="doc"><p>Array of all BPM changes that have been mapped.</p></div></div><div class="field "><a name="crochet"></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(((60 / bpm) * 1000))</span><span class="label label-static">static</span><a href="#crochet"><span class="identifier">crochet</span></a>:<span class="type">Float</span><span> = ((60 / bpm) * 1000)</span></code></h3><div class="doc"><p>Current Crochet (time per beat), in milliseconds.</p></div></div><div class="field "><a name="curBeat"></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="#curBeat"><span class="identifier">curBeat</span></a>:<span class="type">Int</span><span> = 0</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 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="#curBeatFloat"><span class="identifier">curBeatFloat</span></a>:<span class="type">Float</span><span> = 0</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 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="#curMeasure"><span class="identifier">curMeasure</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p>Current measure</p></div></div><div class="field "><a name="curMeasureFloat"></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="#curMeasureFloat"><span class="identifier">curMeasureFloat</span></a>:<span class="type">Float</span><span> = 0</span></code></h3><div class="doc"><p>Current measure, 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 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="#curStep"><span class="identifier">curStep</span></a>:<span class="type">Int</span><span> = 0</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 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="#curStepFloat"><span class="identifier">curStepFloat</span></a>:<span class="type">Float</span><span> = 0</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="onBPMChange"></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 FlxTypedSignal())</span><span class="label label-static">static</span><a href="#onBPMChange"><span class="identifier">onBPMChange</span></a>:<span class="type">FlxTypedSignal</span>&lt;<span class="type">Float</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>&gt;<span> = new FlxTypedSignal()</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="onBeatHit"></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 FlxTypedSignal())</span><span class="label label-static">static</span><a href="#onBeatHit"><span class="identifier">onBeatHit</span></a>:<span class="type">FlxTypedSignal</span>&lt;<span class="type">Int</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>&gt;<span> = new FlxTypedSignal()</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="onMeasureHit"></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 FlxTypedSignal())</span><span class="label label-static">static</span><a href="#onMeasureHit"><span class="identifier">onMeasureHit</span></a>:<span class="type">FlxTypedSignal</span>&lt;<span class="type">Int</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>&gt;<span> = new FlxTypedSignal()</span></code></h3><div class="doc"><p>FlxSignals</p></div></div><div class="field "><a name="onStepHit"></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 FlxTypedSignal())</span><span class="label label-static">static</span><a href="#onStepHit"><span class="identifier">onStepHit</span></a>:<span class="type">FlxTypedSignal</span>&lt;<span class="type">Int</span>&nbsp;&#8209;&gt;&nbsp;<span class="type">Void</span>&gt;<span> = new FlxTypedSignal()</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="songPosition"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#songPosition"><span class="identifier">songPosition</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>Current position of the song, in milliseconds.</p></div></div><div class="field "><a name="stepCrochet"></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(crochet / 4)</span><span class="label label-static">static</span><a href="#stepCrochet"><span class="identifier">stepCrochet</span></a>:<span class="type">Float</span><span> = crochet / 4</span></code></h3><div class="doc"><p>Current StepCrochet (time per step), in milliseconds.</p></div></div><div class="field "><a name="stepsPerBeat"></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(4)</span><span class="label label-static">static</span><a href="#stepsPerBeat"><span class="identifier">stepsPerBeat</span></a>:<span class="type">Float</span><span> = 4</span></code></h3><div class="doc"><p>Number of steps per beat (bottom number in time signature). Defaults to 4.</p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="changeBPM"></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({ stepsPerBeat : 4, beatsPerMesure : 4 })</span><span class="label label-static">static</span><a href="#changeBPM"><span class="identifier">changeBPM</span></a>(<span style="white-space:nowrap">newBpm:<span class="type">Float</span>,</span> <span style="white-space:nowrap">beatsPerMesure:<span class="type">Float</span> = 4,</span> <span style="white-space:nowrap">stepsPerBeat:<span class="type">Float</span> = 4</span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getStepForTime"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#getStepForTime"><span class="identifier">getStepForTime</span></a>(<span style="white-space:nowrap">time:<span class="type">Float</span></span>):<span class="type">Float</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getTimeForStep"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#getTimeForStep"><span class="identifier">getTimeForStep</span></a>(<span style="white-space:nowrap">step:<span class="type">Float</span></span>):<span class="type">Float</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="mapBPMChanges"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#mapBPMChanges"><span class="identifier">mapBPMChanges</span></a>(<span style="white-space:nowrap">song:<a class="type" title="funkin.backend.chart.ChartData" href="../../../funkin/backend/chart/ChartData.html">ChartData</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Maps BPM changes from a song.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>song</code></th><td><p>Song to map BPM changes from.</p></td></tr></table></div></div><div class="field "><a name="reset"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#reset"><span class="identifier">reset</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="setupSong"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#setupSong"><span class="identifier">setupSong</span></a>(<span style="white-space:nowrap">SONG:<a class="type" title="funkin.backend.chart.ChartData" href="../../../funkin/backend/chart/ChartData.html">ChartData</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>