10 lines
45 KiB
HTML
Vendored
10 lines
45 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.game.PlayState</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> PlayState</h1><h4><small>package <a href="../../funkin/game/index.html">funkin.game</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><span class="label label-meta label-meta-access" title="Forces private access to package, type or field.">@:access(flixel.text.FlxText.FlxTextFormatRange)</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="SONG"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#SONG"><span class="identifier">SONG</span></a>:<a class="type" title="funkin.system.SwagSong" href="../../funkin/system/SwagSong.html">SwagSong</a></code></h3><div class="doc"><p>SONG METADATA</p></div></div><div class="field "><a name="campaignScore"></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="#campaignScore"><span class="identifier">campaignScore</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="daPixelZoom"></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(6)</span><span class="label label-static">static</span><a href="#daPixelZoom"><span class="identifier">daPixelZoom</span></a>:<span class="type">Float</span><span> = 6</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="difficulty"></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("normal")</span><span class="label label-static">static</span><a href="#difficulty"><span class="identifier">difficulty</span></a>:<span class="type">String</span><span> = "normal"</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="fromMods"></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="#fromMods"><span class="identifier">fromMods</span></a>:<span class="type">Bool</span><span> = false</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-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="#instance"><span class="identifier">instance</span></a>:<a class="type" title="funkin.game.PlayState" href="../../funkin/game/PlayState.html">PlayState</a><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="isStoryMode"></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="#isStoryMode"><span class="identifier">isStoryMode</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="storyPlaylist"></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="#storyPlaylist"><span class="identifier">storyPlaylist</span></a>:<span class="type">Array</span><<span class="type">String</span>><span> = []</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="storyWeek"></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="#storyWeek"><span class="identifier">storyWeek</span></a>:<a class="type" title="funkin.menus.WeekData" href="../../funkin/menus/WeekData.html">WeekData</a><span> = null</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="accFormat"></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 FlxTextFormat(0xFF888888, false, false, 0))</span><a href="#accFormat"><span class="identifier">accFormat</span></a>:<span class="type">FlxTextFormat</span><span> = new FlxTextFormat(0xFF888888, false, false, 0)</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="accuracy"></a><h3 class="anchor"><code><a href="#accuracy"><span class="identifier">accuracy</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="accuracyPressedNotes"></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="#accuracyPressedNotes"><span class="identifier">accuracyPressedNotes</span></a>:<span class="type">Float</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="accuracyTxt"></a><h3 class="anchor"><code><a href="#accuracyTxt"><span class="identifier">accuracyTxt</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="boyfriend"></a><h3 class="anchor"><code><a href="#boyfriend"><span class="identifier">boyfriend</span></a>:<a class="type" title="funkin.game.Character" href="../../funkin/game/Character.html">Character</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="camFollow"></a><h3 class="anchor"><code><a href="#camFollow"><span class="identifier">camFollow</span></a>:<span class="type">FlxObject</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="camGame"></a><h3 class="anchor"><code><a href="#camGame"><span class="identifier">camGame</span></a>:<span class="type">FlxCamera</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="camHUD"></a><h3 class="anchor"><code><a href="#camHUD"><span class="identifier">camHUD</span></a>:<a class="type" title="funkin.game.HudCamera" href="../../funkin/game/HudCamera.html">HudCamera</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="camZooming"></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="#camZooming"><span class="identifier">camZooming</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="camZoomingInterval"></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><a href="#camZoomingInterval"><span class="identifier">camZoomingInterval</span></a>:<span class="type">Int</span><span> = 4</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="canAccessDebugMenus"></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="#canAccessDebugMenus"><span class="identifier">canAccessDebugMenus</span></a>:<span class="type">Bool</span><span> = true</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="canDie"></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="#canDie"><span class="identifier">canDie</span></a>:<span class="type">Bool</span><span> = true</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="canPause"></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="#canPause"><span class="identifier">canPause</span></a>:<span class="type">Bool</span><span> = true</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="combo"></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="#combo"><span class="identifier">combo</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="comboBreaks"></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="#comboBreaks"><span class="identifier">comboBreaks</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="comboGroup"></a><h3 class="anchor"><code><a href="#comboGroup"><span class="identifier">comboGroup</span></a>:<span class="type">FlxSpriteGroup</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="comboRatings"></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 ComboRating(0, "F", 0xFFFF4444), new ComboRating(0.1, "E", 0xFFFF8844), new ComboRating(0.2, "D", 0xFFFFAA44), new ComboRating(0.4, "C", 0xFFFFFF44), new ComboRating(0.6, "B", 0xFFAAFF44), new ComboRating(0.8, "A", 0xFF88FF44), new ComboRating(0.9, "S", 0xFF44FFFF), new ComboRating(1, "S++", 0xFF44FFFF)])</span><a href="#comboRatings"><span class="identifier">comboRatings</span></a>:<span class="type">Array</span><<a class="type" title="funkin.game.ComboRating" href="../../funkin/game/ComboRating.html">ComboRating</a>><span> = [new ComboRating(0, "F", 0xFFFF4444), new ComboRating(0.1, "E", 0xFFFF8844), new ComboRating(0.2, "D", 0xFFFFAA44), new ComboRating(0.4, "C", 0xFFFFFF44), new ComboRating(0.6, "B", 0xFFAAFF44), new ComboRating(0.8, "A", 0xFF88FF44), new ComboRating(0.9, "S", 0xFF44FFFF), new ComboRating(1, "S++", 0xFF44FFFF)]</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="cpuStrums"></a><h3 class="anchor"><code><a href="#cpuStrums"><span class="identifier">cpuStrums</span></a>:<span class="type">FlxTypedGroup</span><<a class="type" title="funkin.game.Strum" href="../../funkin/game/Strum.html">Strum</a>></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="curLight"></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="#curLight"><span class="identifier">curLight</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="curRating"></a><h3 class="anchor"><code><a href="#curRating"><span class="identifier">curRating</span></a>:<a class="type" title="funkin.game.ComboRating" href="../../funkin/game/ComboRating.html">ComboRating</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="curSection"></a><h3 class="anchor"><code><span class="label">read only</span><a href="#curSection"><span class="identifier">curSection</span></a>:<a class="type" title="funkin.system.SwagSection" href="../../funkin/system/SwagSection.html">SwagSection</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="curSong"></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="#curSong"><span class="identifier">curSong</span></a>:<span class="type">String</span><span> = ""</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="curStage"></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="#curStage"><span class="identifier">curStage</span></a>:<span class="type">String</span><span> = ""</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="cutscene"></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="#cutscene"><span class="identifier">cutscene</span></a>:<span class="type">String</span><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="dad"></a><h3 class="anchor"><code><a href="#dad"><span class="identifier">dad</span></a>:<a class="type" title="funkin.game.Character" href="../../funkin/game/Character.html">Character</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="debugNum"></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="#debugNum"><span class="identifier">debugNum</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="defaultCamZoom"></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.05)</span><a href="#defaultCamZoom"><span class="identifier">defaultCamZoom</span></a>:<span class="type">Float</span><span> = 1.05</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="detailsPausedText"></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="#detailsPausedText"><span class="identifier">detailsPausedText</span></a>:<span class="type">String</span><span> = ""</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="detailsText"></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="#detailsText"><span class="identifier">detailsText</span></a>:<span class="type">String</span><span> = ""</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="difficultyText"></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="#difficultyText"><span class="identifier">difficultyText</span></a>:<span class="type">String</span><span> = ""</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="downscroll"></a><h3 class="anchor"><code><a href="#downscroll"><span class="identifier">downscroll</span></a>:<span class="type">Bool</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="endCutscene"></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="#endCutscene"><span class="identifier">endCutscene</span></a>:<span class="type">String</span><span> = null</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="endingSong"></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="#endingSong"><span class="identifier">endingSong</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="gameOverSong"></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("gameOver")</span><a href="#gameOverSong"><span class="identifier">gameOverSong</span></a>:<span class="type">String</span><span> = "gameOver"</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="generatedMusic"></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="#generatedMusic"><span class="identifier">generatedMusic</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="gf"></a><h3 class="anchor"><code><a href="#gf"><span class="identifier">gf</span></a>:<a class="type" title="funkin.game.Character" href="../../funkin/game/Character.html">Character</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="gfSpeed"></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="#gfSpeed"><span class="identifier">gfSpeed</span></a>:<span class="type">Int</span><span> = 1</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="halloweenLevel"></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="#halloweenLevel"><span class="identifier">halloweenLevel</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="health"></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="#health"><span class="identifier">health</span></a>:<span class="type">Float</span><span> = 1</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="healthBar"></a><h3 class="anchor"><code><a href="#healthBar"><span class="identifier">healthBar</span></a>:<span class="type">FlxBar</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="healthBarBG"></a><h3 class="anchor"><code><a href="#healthBarBG"><span class="identifier">healthBarBG</span></a>:<span class="type">FlxSprite</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="iconP1"></a><h3 class="anchor"><code><a href="#iconP1"><span class="identifier">iconP1</span></a>:<a class="type" title="funkin.game.HealthIcon" href="../../funkin/game/HealthIcon.html">HealthIcon</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="iconP2"></a><h3 class="anchor"><code><a href="#iconP2"><span class="identifier">iconP2</span></a>:<a class="type" title="funkin.game.HealthIcon" href="../../funkin/game/HealthIcon.html">HealthIcon</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="iconRPC"></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="#iconRPC"><span class="identifier">iconRPC</span></a>:<span class="type">String</span><span> = ""</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="inCutscene"></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="#inCutscene"><span class="identifier">inCutscene</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="inst"></a><h3 class="anchor"><code><a href="#inst"><span class="identifier">inst</span></a>:<span class="type">FlxSound</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="introLength"></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(5)</span><a href="#introLength"><span class="identifier">introLength</span></a>:<span class="type">Int</span><span> = 5</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="introSounds"></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(["intro3", "intro2", "intro1", "introGo"])</span><a href="#introSounds"><span class="identifier">introSounds</span></a>:<span class="type">Array</span><<span class="type">String</span>><span> = ["intro3", "intro2", "intro1", "introGo"]</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="introSprites"></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, "game/ready", "game/set", "game/go"])</span><a href="#introSprites"><span class="identifier">introSprites</span></a>:<span class="type">Array</span><<span class="type">String</span>><span> = [null, "game/ready", "game/set", "game/go"]</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="lastReportedPlayheadPosition"></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="#lastReportedPlayheadPosition"><span class="identifier">lastReportedPlayheadPosition</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="lossSFX"></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("gameOverSFX")</span><a href="#lossSFX"><span class="identifier">lossSFX</span></a>:<span class="type">String</span><span> = "gameOverSFX"</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="misses"></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="#misses"><span class="identifier">misses</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="missesTxt"></a><h3 class="anchor"><code><a href="#missesTxt"><span class="identifier">missesTxt</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="muteVocalsOnMiss"></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="#muteVocalsOnMiss"><span class="identifier">muteVocalsOnMiss</span></a>:<span class="type">Bool</span><span> = true</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="noteTypesArray"></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="#noteTypesArray"><span class="identifier">noteTypesArray</span></a>:<span class="type">Array</span><<span class="type">String</span>><span> = [null]</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="notes"></a><h3 class="anchor"><code><a href="#notes"><span class="identifier">notes</span></a>:<a class="type" title="funkin.game.NoteGroup" href="../../funkin/game/NoteGroup.html">NoteGroup</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="paused"></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="#paused"><span class="identifier">paused</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="perfectMode"></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="#perfectMode"><span class="identifier">perfectMode</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="playCutscenes"></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(isStoryMode)</span><a href="#playCutscenes"><span class="identifier">playCutscenes</span></a>:<span class="type">Bool</span><span> = isStoryMode</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="playerStrums"></a><h3 class="anchor"><code><a href="#playerStrums"><span class="identifier">playerStrums</span></a>:<span class="type">FlxTypedGroup</span><<a class="type" title="funkin.game.Strum" href="../../funkin/game/Strum.html">Strum</a>></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="previousFrameTime"></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="#previousFrameTime"><span class="identifier">previousFrameTime</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="ratingNum"></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="#ratingNum"><span class="identifier">ratingNum</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="retrySFX"></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("gameOverEnd")</span><a href="#retrySFX"><span class="identifier">retrySFX</span></a>:<span class="type">String</span><span> = "gameOverEnd"</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="scoreTxt"></a><h3 class="anchor"><code><a href="#scoreTxt"><span class="identifier">scoreTxt</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="scripts"></a><h3 class="anchor"><code><a href="#scripts"><span class="identifier">scripts</span></a>:<a class="type" title="funkin.scripting.ScriptPack" href="../../funkin/scripting/ScriptPack.html">ScriptPack</a></code></h3><div class="doc"><p></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(0)</span><a href="#scrollSpeed"><span class="identifier">scrollSpeed</span></a>:<span class="type">Float</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="songLength"></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="#songLength"><span class="identifier">songLength</span></a>:<span class="type">Float</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="songScore"></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="#songScore"><span class="identifier">songScore</span></a>:<span class="type">Int</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="songTime"></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="#songTime"><span class="identifier">songTime</span></a>:<span class="type">Float</span><span> = 0</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="stage"></a><h3 class="anchor"><code><a href="#stage"><span class="identifier">stage</span></a>:<a class="type" title="funkin.game.Stage" href="../../funkin/game/Stage.html">Stage</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="startTimer"></a><h3 class="anchor"><code><a href="#startTimer"><span class="identifier">startTimer</span></a>:<span class="type">FlxTimer</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="startedCountdown"></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="#startedCountdown"><span class="identifier">startedCountdown</span></a>:<span class="type">Bool</span><span> = false</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="startingSong"></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="#startingSong"><span class="identifier">startingSong</span></a>:<span class="type">Bool</span><span> = false</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>:<span class="type">FlxObject</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="strumLineNotes"></a><h3 class="anchor"><code><a href="#strumLineNotes"><span class="identifier">strumLineNotes</span></a>:<span class="type">FlxTypedGroup</span><<a class="type" title="funkin.game.Strum" href="../../funkin/game/Strum.html">Strum</a>></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="totalAccuracyAmount"></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="#totalAccuracyAmount"><span class="identifier">totalAccuracyAmount</span></a>:<span class="type">Float</span><span> = 0</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="addNoteType"></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({ addAsDefaultIfUnknown : false })</span><a href="#addNoteType"><span class="identifier">addNoteType</span></a>(<span style="white-space:nowrap">name:<span class="type">String</span>,</span> <span style="white-space:nowrap">addAsDefaultIfUnknown:<span class="type">Bool</span> = false</span>):<span class="type">Int</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="countdown"></a><h3 class="anchor"><code><a href="#countdown"><span class="identifier">countdown</span></a>(<span style="white-space:nowrap">swagCounter:<span class="type">Int</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Creates a fake countdown.</p></div></div><div class="field "><a name="deleteNote"></a><h3 class="anchor"><code><a href="#deleteNote"><span class="identifier">deleteNote</span></a>(<span style="white-space:nowrap">note:<a class="type" title="funkin.game.Note" href="../../funkin/game/Note.html">Note</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="generateNotes"></a><h3 class="anchor"><code><a href="#generateNotes"><span class="identifier">generateNotes</span></a>(<span style="white-space:nowrap">songData:<a class="type" title="funkin.system.SwagSong" href="../../funkin/system/SwagSong.html">SwagSong</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getNoteType"></a><h3 class="anchor"><code><a href="#getNoteType"><span class="identifier">getNoteType</span></a>(<span style="white-space:nowrap">id:<span class="type">Int</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="get_curSection"></a><h3 class="anchor"><code><a href="#get_curSection"><span class="identifier">get_curSection</span></a>():<a class="type" title="funkin.system.SwagSection" href="../../funkin/system/SwagSection.html">SwagSection</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="nextSong"></a><h3 class="anchor"><code><a href="#nextSong"><span class="identifier">nextSong</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="pauseGame"></a><h3 class="anchor"><code><a href="#pauseGame"><span class="identifier">pauseGame</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="startCountdown"></a><h3 class="anchor"><code><a href="#startCountdown"><span class="identifier">startCountdown</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="startCutscene"></a><h3 class="anchor"><code><a href="#startCutscene"><span class="identifier">startCutscene</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="startEndCutscene"></a><h3 class="anchor"><code><a href="#startEndCutscene"><span class="identifier">startEndCutscene</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="updateDiscordStatus"></a><h3 class="anchor"><code><a href="#updateDiscordStatus"><span class="identifier">updateDiscordStatus</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="updateRating"></a><h3 class="anchor"><code><a href="#updateRating"><span class="identifier">updateRating</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.</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="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 "scripts/stateName" (ex: "scripts/")</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><<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/system/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 independant of framerate.</p></td></tr></table></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">© 2022 </p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html> |