10 lines
9.3 KiB
HTML
10 lines
9.3 KiB
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.mods.ModsFolder</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> ModsFolder</h1><h4><small>package <a href="../../funkin/mods/index.html">funkin.mods</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="currentModFolder"></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="#currentModFolder"><span class="identifier">currentModFolder</span></a>:<span class="type">String</span><span> = null</span></code></h3><div class="doc"><p>Current mod folder. Will affect <code><a href="../../funkin/system/Paths.html#Paths">Paths</a></code>.</p></div></div><div class="field "><a name="lastFolderEditTime"></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="#lastFolderEditTime"><span class="identifier">lastFolderEditTime</span></a>:<span class="type">Date</span><span> = null</span></code></h3><div class="doc"><p>Last time the folder was modified.</p></div></div><div class="field "><a name="loadedMods"></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="#loadedMods"><span class="identifier">loadedMods</span></a>:<span class="type">Array</span><<span class="type">String</span>><span> = []</span></code></h3><div class="doc"><p>Array of all loaded mods' folder names.</p></div></div><div class="field "><a name="modsPath"></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("./mods/")</span><span class="label label-static">static</span><a href="#modsPath"><span class="identifier">modsPath</span></a>:<span class="type">String</span><span> = "./mods/"</span></code></h3><div class="doc"><p>Path to the <code>mods</code> folder.</p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="getAssetFiles"></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({ addRoot : false, prefix : "" })</span><span class="label label-static">static</span><a href="#getAssetFiles"><span class="identifier">getAssetFiles</span></a>(<span style="white-space:nowrap">assets:<span class="type">Array</span><<span class="type">Dynamic</span>>,</span> <span style="white-space:nowrap">rootPath:<span class="type">String</span>,</span> <span style="white-space:nowrap">path:<span class="type">String</span>,</span> <span style="white-space:nowrap">libraryName:<span class="type">String</span>,</span> <span style="white-space:nowrap">prefix:<span class="type">String</span> = "",</span> <span style="white-space:nowrap">addRoot:<span class="type">Bool</span> = false</span>):<span class="type">Void</span></code></h3><div class="doc"><p>Gets all assets in folders and put them in the <code>assets</code> array.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>assets</code></th><td><p>Array of assets</p></td></tr><tr><th style="width:25%;"><code>rootPath</code></th><td><p>Root path</p></td></tr><tr><th style="width:25%;"><code>path</code></th><td><p>Path inside of the rootPath (ex: <code>root path/path/path2/</code>)</p></td></tr><tr><th style="width:25%;"><code>libraryName</code></th><td><p>Name of the library (ex: <code>mods/my mod/</code>)</p></td></tr><tr><th style="width:25%;"><code>prefix</code></th><td><p>Prefix for the asset names (ex: <code>assets/mods/my mod/</code>)</p></td></tr><tr><th style="width:25%;"><code>addRoot</code></th><td><p>Whenever the root should be added to the paths. Defaults to false</p></td></tr></table></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>Initialises <code>mods</code> folder by adding callbacks and such.</p></div></div><div class="field "><a name="loadLibraryFromFolder"></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({ force : false })</span><span class="label label-static">static</span><a href="#loadLibraryFromFolder"><span class="identifier">loadLibraryFromFolder</span></a>(<span style="white-space:nowrap">libName:<span class="type">String</span>,</span> <span style="white-space:nowrap">folder:<span class="type">String</span>,</span> <span style="white-space:nowrap">force:<span class="type">Bool</span> = false</span>):<span class="type">AssetLibrary</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="loadMod"></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({ force : false })</span><span class="label label-static">static</span><a href="#loadMod"><span class="identifier">loadMod</span></a>(<span style="white-space:nowrap">mod:<span class="type">String</span>,</span> <span style="white-space:nowrap">force:<span class="type">Bool</span> = false</span>):<span class="type">AssetLibrary</span></code></h3><div class="doc"><p>Loads a mod with the specified name.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>modName</code></th><td><p>Name of the mod</p></td></tr><tr><th style="width:25%;"><code>force</code></th><td><p>Whenever the mod should be reloaded if it has already been loaded</p></td></tr></table></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> |