CodenameEngine/pages/funkin/system/modules/FunkinCache.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.modules.FunkinCache</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> FunkinCache</h1><h4><small>package <a href="../../../funkin/system/modules/index.html">funkin.system.modules</a></small></h4><h4><small>extends <span class="type">AssetCache</span></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="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.system.modules.FunkinCache" href="../../../funkin/system/modules/FunkinCache.html">FunkinCache</a></code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><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><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>()</code></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="clearSecondLayer"></a><h3 class="anchor"><code><a href="#clearSecondLayer"><span class="identifier">clearSecondLayer</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getBitmapData"></a><h3 class="anchor"><code><a href="#getBitmapData"><span class="identifier">getBitmapData</span></a>(<span style="white-space:nowrap">id:<span class="type">String</span></span>):<span class="type">BitmapData</span></code></h3><div class="doc"><p>Retrieves a cached BitmapData.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>id</code></th><td><p>The ID of the cached BitmapData</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The cached BitmapData instance</p></div></div></div><div class="field "><a name="getFont"></a><h3 class="anchor"><code><a href="#getFont"><span class="identifier">getFont</span></a>(<span style="white-space:nowrap">id:<span class="type">String</span></span>):<span class="type">Font</span></code></h3><div class="doc"><p>Retrieves a cached Font.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>id</code></th><td><p>The ID of the cached Font</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The cached Font instance</p></div></div></div><div class="field "><a name="getSound"></a><h3 class="anchor"><code><a href="#getSound"><span class="identifier">getSound</span></a>(<span style="white-space:nowrap">id:<span class="type">String</span></span>):<span class="type">Sound</span></code></h3><div class="doc"><p>Retrieves a cached Sound.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>id</code></th><td><p>The ID of the cached Sound</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The cached Sound instance</p></div></div></div><div class="field "><a name="hasBitmapData"></a><h3 class="anchor"><code><a href="#hasBitmapData"><span class="identifier">hasBitmapData</span></a>(<span style="white-space:nowrap">id:<span class="type">String</span></span>):<span class="type">Bool</span></code></h3><div class="doc"><p>Checks whether a BitmapData asset is cached.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>id</code></th><td><p>The ID of a BitmapData asset</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Whether the object has been cached</p></div></div></div><div class="field "><a name="hasFont"></a><h3 class="anchor"><code><a href="#hasFont"><span class="identifier">hasFont</span></a>(<span style="white-space:nowrap">id:<span class="type">String</span></span>):<span class="type">Bool</span></code></h3><div class="doc"><p>Checks whether a Font asset is cached.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>id</code></th><td><p>The ID of a Font asset</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Whether the object has been cached</p></div></div></div><div class="field "><a name="hasSound"></a><h3 class="anchor"><code><a href="#hasSound"><span class="identifier">hasSound</span></a>(<span style="white-space:nowrap">id:<span class="type">String</span></span>):<span class="type">Bool</span></code></h3><div class="doc"><p>Checks whether a Sound asset is cached.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>id</code></th><td><p>The ID of a Sound asset</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Whether the object has been cached</p></div></div></div><div class="field "><a name="moveToSecondLayer"></a><h3 class="anchor"><code><a href="#moveToSecondLayer"><span class="identifier">moveToSecondLayer</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="removeBitmapData"></a><h3 class="anchor"><code><a href="#removeBitmapData"><span class="identifier">removeBitmapData</span></a>(<span style="white-space:nowrap">id:<span class="type">String</span></span>):<span class="type">Bool</span></code></h3><div class="doc"><p>Removes a BitmapData from the cache.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>id</code></th><td><p>The ID of a BitmapData asset</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p><code>true</code> if the asset was removed, <code>false</code> if it was not in the cache</p></div></div></div><div class="field "><a name="removeFont"></a><h3 class="anchor"><code><a href="#removeFont"><span class="identifier">removeFont</span></a>(<span style="white-space:nowrap">id:<span class="type">String</span></span>):<span class="type">Bool</span></code></h3><div class="doc"><p>Removes a Font from the cache.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>id</code></th><td><p>The ID of a Font asset</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p><code>true</code> if the asset was removed, <code>false</code> if it was not in the cache</p></div></div></div><div class="field "><a name="removeSound"></a><h3 class="anchor"><code><a href="#removeSound"><span class="identifier">removeSound</span></a>(<span style="white-space:nowrap">id:<span class="type">String</span></span>):<span class="type">Bool</span></code></h3><div class="doc"><p>Removes a Sound from the cache.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>id</code></th><td><p>The ID of a Sound asset</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p><code>true</code> if the asset was removed, <code>false</code> if it was not in the cache</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>