CodenameEngine/pages/funkin/system/Paths.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.system.Paths</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> Paths</h1><h4><small>package <a href="../../funkin/system/index.html">funkin.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></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="SOUND_EXT"></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(&quot;ogg&quot;)</span><span class="label label-static">static</span><span class="label label-inline">inline</span><span class="label">read only</span><a href="#SOUND_EXT"><span class="identifier">SOUND_EXT</span></a>:<span class="type">String</span><span> = &quot;ogg&quot;</span></code></h3><div class="doc"><p>Preferred sound extension for the game's audio files.
Currently is set to <code>mp3</code> for web targets, and <code>ogg</code> for other targets.</p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="chart"></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="#chart"><span class="identifier">chart</span></a>(<span style="white-space:nowrap">song:<span class="type">String</span>,</span> <span style="white-space:nowrap">difficulty:<span class="type">String</span> = &quot;normal&quot;</span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="file"></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({ type : TEXT })</span><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#file"><span class="identifier">file</span></a>(<span style="white-space:nowrap">file:<span class="type">String</span>,</span> <span style="white-space:nowrap">type:<span class="type">AssetType</span> = TEXT,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="font"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#font"><span class="identifier">font</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getFolderContent"></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({ scanSource : false, addPath : false, includeSource : true })</span><span class="label label-static">static</span><a href="#getFolderContent"><span class="identifier">getFolderContent</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">includeSource:<span class="type">Bool</span> = true,</span> <span style="white-space:nowrap">addPath:<span class="type">Bool</span> = false,</span> <span style="white-space:nowrap">scanSource:<span class="type">Bool</span> = false</span>):<span class="type">Array</span>&lt;<span class="type">String</span>&gt;</code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getLibraryPath"></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({ library : &quot;preload&quot; })</span><span class="label label-static">static</span><a href="#getLibraryPath"><span class="identifier">getLibraryPath</span></a>(<span style="white-space:nowrap">file:<span class="type">String</span>,</span> <span style="white-space:nowrap">library:<span class="type">String</span> = &quot;preload&quot;</span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getPackerAtlas"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#getPackerAtlas"><span class="identifier">getPackerAtlas</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">FlxAtlasFrames</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getPath"></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({ skipModsVerification : false })</span><span class="label label-static">static</span><a href="#getPath"><span class="identifier">getPath</span></a>(<span style="white-space:nowrap">file:<span class="type">String</span>,</span> <span style="white-space:nowrap">type:<span class="type">AssetType</span>,</span> <span style="white-space:nowrap">library:<span class="type">Null</span>&lt;<span class="type">String</span>&gt;,</span> <span style="white-space:nowrap">skipModsVerification:<span class="type">Bool</span> = false</span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getSparrowAtlas"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#getSparrowAtlas"><span class="identifier">getSparrowAtlas</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">FlxAtlasFrames</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="image"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#image"><span class="identifier">image</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="inst"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#inst"><span class="identifier">inst</span></a>(<span style="white-space:nowrap">song:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="json"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#json"><span class="identifier">json</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="music"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#music"><span class="identifier">music</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="script"></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({ isAssetsPath : false })</span><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#script"><span class="identifier">script</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span>,</span> <span style="white-space:nowrap">isAssetsPath:<span class="type">Bool</span> = false</span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="sound"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#sound"><span class="identifier">sound</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="soundRandom"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#soundRandom"><span class="identifier">soundRandom</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">min:<span class="type">Int</span>,</span> <span style="white-space:nowrap">max:<span class="type">Int</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="txt"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#txt"><span class="identifier">txt</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="voices"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#voices"><span class="identifier">voices</span></a>(<span style="white-space:nowrap">song:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="xml"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#xml"><span class="identifier">xml</span></a>(<span style="white-space:nowrap">key:<span class="type">String</span>,</span> <span style="white-space:nowrap">?library:<span class="type">String</span></span>):<span class="type">String</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; 2022 &nbsp;</p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>