CodenameEngine/pages/funkin/options/OptionsScreen.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.options.OptionsScreen</title><meta name="description" content="Direct replica from Week 7 lol"/></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> OptionsScreen</h1><h4><small>package <a href="../../funkin/options/index.html">funkin.options</a></small></h4><h4><small>extends <a class="type" title="funkin.system.MusicBeatState" href="../../funkin/system/MusicBeatState.html">MusicBeatState</a></small></h4>    <h4><small><span class="muted">extended by </span><a class="type" title="funkin.menus.credits.CreditsMain" href="../../funkin/menus/credits/CreditsMain.html">CreditsMain</a>, <a class="type" title="funkin.options.categories.BehaviourOptions" href="../../funkin/options/categories/BehaviourOptions.html">BehaviourOptions</a>, <a class="type" title="funkin.options.categories.DebugOptions" href="../../funkin/options/categories/DebugOptions.html">DebugOptions</a>, <a class="type" title="funkin.options.categories.GameplayOptions" href="../../funkin/options/categories/GameplayOptions.html">GameplayOptions</a>, <a class="type" title="funkin.options.categories.MiscOptions" href="../../funkin/options/categories/MiscOptions.html">MiscOptions</a></small></h4></div><div class="body"><div class="doc doc-main"><p>Direct replica from Week 7 lol</p></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="defaultBGColor"></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(0xFFFDE871)</span><span class="label label-static">static</span><span class="label label-inline">inline</span><span class="label">read only</span><a href="#defaultBGColor"><span class="identifier">defaultBGColor</span></a>:<span class="type">FlxColor</span><span> = 0xFFFDE871</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="instance"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#instance"><span class="identifier">instance</span></a>:<a class="type" title="funkin.options.OptionsScreen" href="../../funkin/options/OptionsScreen.html">OptionsScreen</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="optionHeight"></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(120)</span><span class="label label-static">static</span><a href="#optionHeight"><span class="identifier">optionHeight</span></a>:<span class="type">Float</span><span> = 120</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><a href="#new"><span class="identifier">new</span></a>()</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="bg"></a><h3 class="anchor"><code><a href="#bg"><span class="identifier">bg</span></a>:<span class="type">FlxSprite</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="curSelected"></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="#curSelected"><span class="identifier">curSelected</span></a>:<span class="type">Int</span><span> = -1</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="descBG"></a><h3 class="anchor"><code><a href="#descBG"><span class="identifier">descBG</span></a>:<span class="type">FlxSprite</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="descDrop"></a><h3 class="anchor"><code><a href="#descDrop"><span class="identifier">descDrop</span></a>:<span class="type">FlxBackdrop</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="descSpeed"></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(35)</span><a href="#descSpeed"><span class="identifier">descSpeed</span></a>:<span class="type">Float</span><span> = 35</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="descText"></a><h3 class="anchor"><code><a href="#descText"><span class="identifier">descText</span></a>:<a class="type" title="funkin.ui.FunkinText" href="../../funkin/ui/FunkinText.html">FunkinText</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="options"></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="#options"><span class="identifier">options</span></a>:<span class="type">Array</span>&lt;<a class="type" title="funkin.options.type.OptionType" href="../../funkin/options/type/OptionType.html">OptionType</a>&gt;<span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="scrollDest"></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(FlxPoint.get(0, 0))</span><a href="#scrollDest"><span class="identifier">scrollDest</span></a>:<span class="type">FlxPoint</span><span> = FlxPoint.get(0, 0)</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="changeSelection"></a><h3 class="anchor"><code><a href="#changeSelection"><span class="identifier">changeSelection</span></a>(<span style="white-space:nowrap">change:<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="exit"></a><h3 class="anchor"><code><a href="#exit"><span class="identifier">exit</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="updateDesc"></a><h3 class="anchor"><code><a href="#updateDesc"><span class="identifier">updateDesc</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="updateDescText"></a><h3 class="anchor"><code><a href="#updateDescText"><span class="identifier">updateDescText</span></a>(<span style="white-space:nowrap">text:<span class="type">String</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.system.MusicBeatState" href="../../funkin/system/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.system.Controls - A list of actions that a player would invoke via some input device." href="../../funkin/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.system.Controls - A list of actions that a player would invoke via some input device." href="../../funkin/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.system.Controls - A list of actions that a player would invoke via some input device." href="../../funkin/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="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.scripting.Script - Class used for scripting." href="../../funkin/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.system.MusicBeatState" href="../../funkin/system/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>&lt;<span class="type">Dynamic</span>&gt;,</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>&lt;<span class="type">T</span>&gt;(<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/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">&copy; 2023 &nbsp;</p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>