CodenameEngine/pages/funkin/desktop/DesktopMain.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.desktop.DesktopMain</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> DesktopMain</h1><h4><small>package <a href="../../funkin/desktop/index.html">funkin.desktop</a></small></h4><h4><small>extends <a class="type" title="funkin.system.MusicBeatState" href="../../funkin/system/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></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="contextMenu"></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><span class="label label-static">static</span><a href="#contextMenu"><span class="identifier">contextMenu</span></a>:<a class="type" title="funkin.desktop.windows.ContextMenu" href="../../funkin/desktop/windows/ContextMenu.html">ContextMenu</a><span> = null</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-static">static</span><a href="#currentFocus"><span class="identifier">currentFocus</span></a>:<a class="type" title="funkin.desktop.IDesktopFocusableObject" href="../../funkin/desktop/IDesktopFocusableObject.html">IDesktopFocusableObject</a></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.desktop.DesktopMain" href="../../funkin/desktop/DesktopMain.html">DesktopMain</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="mouseInput"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#mouseInput"><span class="identifier">mouseInput</span></a>:<a class="type" title="funkin.desktop.MouseInput" href="../../funkin/desktop/MouseInput.html">MouseInput</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="theme"></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><span class="label label-static">static</span><a href="#theme"><span class="identifier">theme</span></a>:<a class="type" title="funkin.desktop.theme.Theme" href="../../funkin/desktop/theme/Theme.html">Theme</a><span> = null</span></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="hasFocus"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#hasFocus"><span class="identifier">hasFocus</span></a>(<span style="white-space:nowrap">obj:<a class="type" title="funkin.desktop.IDesktopFocusableObject" href="../../funkin/desktop/IDesktopFocusableObject.html">IDesktopFocusableObject</a></span>):<span class="type">Bool</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="loseFocus"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#loseFocus"><span class="identifier">loseFocus</span></a>(<span style="white-space:nowrap">obj:<a class="type" title="funkin.desktop.IDesktopFocusableObject" href="../../funkin/desktop/IDesktopFocusableObject.html">IDesktopFocusableObject</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="setFocus"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#setFocus"><span class="identifier">setFocus</span></a>(<span style="white-space:nowrap">obj:<a class="type" title="funkin.desktop.IDesktopFocusableObject" href="../../funkin/desktop/IDesktopFocusableObject.html">IDesktopFocusableObject</a></span>):<span class="type">Void</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>(<span style="white-space:nowrap">?scriptsAllowed:<span class="type">Bool</span>,</span> <span style="white-space:nowrap">?scriptName:<span class="type">String</span></span>)</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="oldScaleMode"></a><h3 class="anchor"><code><a href="#oldScaleMode"><span class="identifier">oldScaleMode</span></a>:<span class="type">BaseScaleMode</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="screenSize"></a><h3 class="anchor"><code><a href="#screenSize"><span class="identifier">screenSize</span></a>:<span class="type">FlxPoint</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="wallpaper"></a><h3 class="anchor"><code><a href="#wallpaper"><span class="identifier">wallpaper</span></a>:<span class="type">FlxSprite</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="windows"></a><h3 class="anchor"><code><a href="#windows"><span class="identifier">windows</span></a>:<a class="type" title="funkin.desktop.windows.WindowGroup" href="../../funkin/desktop/windows/WindowGroup.html">WindowGroup</a>&lt;<a class="type" title="funkin.desktop.windows.Window" href="../../funkin/desktop/windows/Window.html">Window</a>&gt;</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="focusWindow"></a><h3 class="anchor"><code><a href="#focusWindow"><span class="identifier">focusWindow</span></a>(<span style="white-space:nowrap">window:<a class="type" title="funkin.desktop.windows.Window" href="../../funkin/desktop/windows/Window.html">Window</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="layerCameras"></a><h3 class="anchor"><code><a href="#layerCameras"><span class="identifier">layerCameras</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="openWindow"></a><h3 class="anchor"><code><a href="#openWindow"><span class="identifier">openWindow</span></a>(<span style="white-space:nowrap">content:<a class="type" title="funkin.desktop.windows.WindowContent" href="../../funkin/desktop/windows/WindowContent.html">WindowContent</a></span>):<a class="type" title="funkin.desktop.windows.Window" href="../../funkin/desktop/windows/Window.html">Window</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="updateScreenRes"></a><h3 class="anchor"><code><a href="#updateScreenRes"><span class="identifier">updateScreenRes</span></a>():<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>