Files
CodenameEngine/pages/funkin/chart/Chart.html
T
2023-04-01 18:29:11 +02:00

10 lines
8.4 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.chart.Chart</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> Chart</h1><h4><small>package <a href="../../funkin/chart/index.html">funkin.chart</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="defaultColor"></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(0xFF9271FD)</span><span class="label label-static">static</span><span class="label label-inline">inline</span><span class="label">read only</span><a href="#defaultColor"><span class="identifier">defaultColor</span></a>:<span class="type">FlxColor</span><span> = 0xFF9271FD</span></code></h3><div class="doc"><p>Default background colors for songs without bg color</p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="addNoteType"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#addNoteType"><span class="identifier">addNoteType</span></a>(<span style="white-space:nowrap">chart:<a class="type" title="funkin.chart.ChartData" href="../../funkin/chart/ChartData.html">ChartData</a>,</span> <span style="white-space:nowrap">noteTypeName:<span class="type">String</span></span>):<span class="type">Int</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="filterChartForSaving"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#filterChartForSaving"><span class="identifier">filterChartForSaving</span></a>(<span style="white-space:nowrap">chart:<a class="type" title="funkin.chart.ChartData" href="../../funkin/chart/ChartData.html">ChartData</a>,</span> <span style="white-space:nowrap">?saveMetaInChart:<span class="type">Bool</span></span>):<a class="type" title="funkin.chart.ChartData" href="../../funkin/chart/ChartData.html">ChartData</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="loadChartMeta"></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({ fromMods : true, difficulty : &quot;normal&quot; })</span><span class="label label-static">static</span><a href="#loadChartMeta"><span class="identifier">loadChartMeta</span></a>(<span style="white-space:nowrap">songName:<span class="type">String</span>,</span> <span style="white-space:nowrap">difficulty:<span class="type">String</span> = &quot;normal&quot;,</span> <span style="white-space:nowrap">fromMods:<span class="type">Bool</span> = true</span>):<a class="type" title="funkin.chart.ChartMetaData" href="../../funkin/chart/ChartMetaData.html">ChartMetaData</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="parse"></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({ difficulty : &quot;normal&quot; })</span><span class="label label-static">static</span><a href="#parse"><span class="identifier">parse</span></a>(<span style="white-space:nowrap">songName:<span class="type">String</span>,</span> <span style="white-space:nowrap">difficulty:<span class="type">String</span> = &quot;normal&quot;</span>):<a class="type" title="funkin.chart.ChartData" href="../../funkin/chart/ChartData.html">ChartData</a></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="save"></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({ difficulty : &quot;normal&quot; })</span><span class="label label-static">static</span><a href="#save"><span class="identifier">save</span></a>(<span style="white-space:nowrap">songFolderPath:<span class="type">String</span>,</span> <span style="white-space:nowrap">chart:<a class="type" title="funkin.chart.ChartData" href="../../funkin/chart/ChartData.html">ChartData</a>,</span> <span style="white-space:nowrap">difficulty:<span class="type">String</span> = &quot;normal&quot;,</span> <span style="white-space:nowrap">?saveSettings:<a class="type" title="funkin.chart.ChartSaveSettings" href="../../funkin/chart/ChartSaveSettings.html">ChartSaveSettings</a></span>):<a class="type" title="funkin.chart.ChartData" href="../../funkin/chart/ChartData.html">ChartData</a></code></h3><div class="doc"><p>Saves the chart to the specific song folder path.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>songFolderPath</code></th><td><p>Path to the song folder (ex: <code>mods/your mod/songs/song/</code>)</p></td></tr><tr><th style="width:25%;"><code>chart</code></th><td><p>Chart to save</p></td></tr><tr><th style="width:25%;"><code>difficulty</code></th><td><p>Name of the difficulty</p></td></tr><tr><th style="width:25%;"><code>saveSettings</code></th><td></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Filtered chart used for saving.</p></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>