</div></section></div></details></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Constructors</h2><sectionclass="tsd-panel tsd-member"><aid="constructor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>constructor</span><ahref="#constructor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="constructor.new_default"class="tsd-anchor"></a><spanclass="tsd-kind-constructor-signature">new default</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">scene</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="plugins_cache_busted_loader_plugin.default.html"class="tsd-signature-type tsd-kind-class">default</a><ahref="#constructor.new_default"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">scene</span>: <spanclass="tsd-signature-type">Scene</span></span></li></ul></div><h4class="tsd-returns-title">Returns <ahref="plugins_cache_busted_loader_plugin.default.html"class="tsd-signature-type tsd-kind-class">default</a></h4><asideclass="tsd-sources"><p>Overrides Phaser.Loader.LoaderPlugin.constructor</p><ul><li>Defined in <ahref="https://github.com/pagefaultgames/pokerogue/blob/9e3b5c636cc833b44ca0253a1a4fbc2d54ed0035/src/plugins/cache-busted-loader-plugin.ts#L4">src/plugins/cache-busted-loader-plugin.ts:4</a></li></ul></aside></li></ul></section></section><sectionclass="tsd-panel-group tsd-member-group"><h2>Properties</h2><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="baseURL"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>baseURL</span><ahref="#baseURL"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">baseURL</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>If you want to append a URL before the path of any asset you can set this here.</p>
<p>Useful if allowing the asset base url to be configured outside of the game code.</p>
<p>If you set this property directly then it <em>must</em> end with a "/". Alternatively, call <code>setBaseURL()</code> and it'll do it for you.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.baseURL</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66466</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="cacheManager"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>cache<wbr/>Manager</span><ahref="#cacheManager"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">cache<wbr/>Manager</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">CacheManager</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the global Cache Manager.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.cacheManager</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66419</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="crossOrigin"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>cross<wbr/>Origin</span><ahref="#crossOrigin"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">cross<wbr/>Origin</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>The crossOrigin value applied to loaded images. Very often this needs to be set to 'anonymous'.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.crossOrigin</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66485</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="imageLoadType"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>image<wbr/>Load<wbr/>Type</span><ahref="#imageLoadType"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">image<wbr/>Load<wbr/>Type</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>Optional load type for image files. <code>XHR</code> is the default. Set to <code>HTMLImageElement</code> to load images using the Image tag instead.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.imageLoadType</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66490</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="inflight"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>inflight</span><ahref="#inflight"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">inflight</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Set</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">File</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Files are stored in this Set while they're in the process of being loaded.</p>
<p>Upon a successful load they are moved to the <code>queue</code> Set.</p>
<p>By the end of the load process this Set will be empty.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.inflight</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66530</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="list"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>list</span><ahref="#list"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">list</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Set</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">File</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Files are placed in this Set when they're added to the Loader via <code>addFile</code>.</p>
<p>They are moved to the <code>inflight</code> Set when they start loading, and assuming a successful
load, to the <code>queue</code> Set for further processing.</p>
<p>By the end of the load process this Set will be empty.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.list</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66521</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="localSchemes"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>local<wbr/>Schemes</span><ahref="#localSchemes"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">local<wbr/>Schemes</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></div><divclass="tsd-comment tsd-typography"><p>An array of all schemes that the Loader considers as being 'local'.</p>
<p>This is populated by the <code>Phaser.Core.Config#loaderLocalScheme</code> game configuration setting and defaults to
<code>[ 'file://', 'capacitor://' ]</code>. Additional local schemes can be added to this array as needed.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.localSchemes</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66498</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="maxParallelDownloads"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>max<wbr/>Parallel<wbr/>Downloads</span><ahref="#maxParallelDownloads"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">max<wbr/>Parallel<wbr/>Downloads</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The number of concurrent / parallel resources to try and fetch at once.</p>
<p>Old browsers limit 6 requests per domain; modern ones, especially those with HTTP/2 don't limit it at all.</p>
<p>The default is 32 but you can change this in your Game Config, or by changing this property before the Loader starts.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.maxParallelDownloads</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66475</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="path"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>path</span><ahref="#path"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">path</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>The value of <code>path</code>, if set, is placed before any <em>relative</em> file path given. For example:</p>
<p>Would load the <code>ball</code> file from <code>images/sprites/ball.png</code> and the tree from
<code>images/sprites/level1/oaktree.png</code> but the file <code>boom</code> would load from the URL
given as it's an absolute URL.</p>
<p>Please note that the path is added before the filename but <em>after</em> the baseURL (if set.)</p>
<p>If you set this property directly then it <em>must</em> end with a "/". Alternatively, call <code>setPath()</code> and it'll do it for you.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.path</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66457</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="prefix"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>prefix</span><ahref="#prefix"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">prefix</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">string</span></div><divclass="tsd-comment tsd-typography"><p>An optional prefix that is automatically prepended to the start of every file key.
If prefix was <code>MENU.</code> and you load an image with the key 'Background' the resulting key would be <code>MENU.Background</code>.
You can set this directly, or call <code>Loader.setPrefix()</code>. It will then affect every file added to the Loader
from that point on. It does <em>not</em> change any file already in the load queue.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.prefix</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66437</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="progress"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>progress</span><ahref="#progress"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">progress</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The progress of the current load queue, as a float value between 0 and 1.
This is updated automatically as files complete loading.
Note that it is possible for this value to go down again if you add content to the current load queue during a load.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.progress</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66511</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="queue"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>queue</span><ahref="#queue"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">queue</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Set</span><spanclass="tsd-signature-symbol"><</span><spanclass="tsd-signature-type">File</span><spanclass="tsd-signature-symbol">></span></div><divclass="tsd-comment tsd-typography"><p>Files are stored in this Set while they're being processed.</p>
<p>If the process is successful they are moved to their final destination, which could be
a Cache or the Texture Manager.</p>
<p>At the end of the load process this Set will be empty.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.queue</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66540</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scene"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scene</span><ahref="#scene"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scene</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Scene</span></div><divclass="tsd-comment tsd-typography"><p>The Scene which owns this Loader instance.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.scene</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66409</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><aid="sceneManager"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagProtected">Protected</code><span>scene<wbr/>Manager</span><ahref="#sceneManager"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">scene<wbr/>Manager</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">SceneManager</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the global Scene Manager.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.sceneManager</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66429</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="state"class="tsd-anchor"></a><h3class="tsd-anchor-link"><codeclass="tsd-tag ts-flagReadonly">Readonly</code><span>state</span><ahref="#state"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">state</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The current state of the Loader.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.state</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66557</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="systems"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>systems</span><ahref="#systems"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">systems</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">Systems</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the Scene Systems.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.systems</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66414</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="textureManager"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>texture<wbr/>Manager</span><ahref="#textureManager"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">texture<wbr/>Manager</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">TextureManager</span></div><divclass="tsd-comment tsd-typography"><p>A reference to the global Texture Manager.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.textureManager</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66424</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="totalComplete"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>total<wbr/>Complete</span><ahref="#totalComplete"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">total<wbr/>Complete</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The total number of files that successfully loaded during the most recent load.
This value is reset when you call <code>Loader.start</code>.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.totalComplete</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66552</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="totalFailed"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>total<wbr/>Failed</span><ahref="#totalFailed"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">total<wbr/>Failed</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The total number of files that failed to load during the most recent load.
This value is reset when you call <code>Loader.start</code>.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.totalFailed</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66546</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="totalToLoad"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>total<wbr/>To<wbr/>Load</span><ahref="#totalToLoad"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">total<wbr/>To<wbr/>Load</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">number</span></div><divclass="tsd-comment tsd-typography"><p>The total number of files to load. It may not always be accurate because you may add to the Loader during the process
of loading, especially if you load a Pack File. Therefore this value can change, but in most cases remains static.</p>
</div><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.totalToLoad</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66504</li></ul></aside></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="xhr"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>xhr</span><ahref="#xhr"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><divclass="tsd-signature"><spanclass="tsd-kind-property">xhr</span><spanclass="tsd-signature-symbol">:</span><spanclass="tsd-signature-type">XHRSettingsObject</span></div><divclass="tsd-comment tsd-typography"><p>xhr specific global settings (can be overridden on a per-file basis)</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">context</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The context to invoke the listener with. Default this.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.addListener</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9951</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="addPack"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>add<wbr/>Pack</span><ahref="#addPack"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="addPack.addPack-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">add<wbr/>Pack</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">pack</span>, <spanclass="tsd-kind-parameter">packKey</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#addPack.addPack-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Takes a well formed, fully parsed pack file object and adds its entries into the load queue. Usually you do not call
this method directly, but instead use <code>Loader.pack</code> and supply a path to a JSON file that holds the
pack data. However, if you've got the data prepared you can pass it to this method.</p>
<p>You can also provide an optional key. If you do then it will only add the entries from that part of the pack into
to the load queue. If not specified it will add all entries it finds. For more details about the pack file format
see the <code>LoaderPlugin.pack</code> method.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">pack</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The Pack File data to be parsed and each entry of it to added to the load queue.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">packKey</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>An optional key to use from the pack file data.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.addPack</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66648</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="animation"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>animation</span><ahref="#animation"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="animation.animation-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">animation</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">dataKey</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#animation.animation-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an Animation JSON Data file, or array of Animation JSON files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.JSONFileConfig</code> for more details.</p>
<p>Once the file has finished loading it will automatically be passed to the global Animation Managers <code>fromJSON</code> method.
This will parse all of the JSON data and create animation data from it. This process happens at the very end
of the Loader, once every other file in the load queue has finished. The reason for this is to allow you to load
both animation data and the images it relies upon in the same load call.</p>
<p>Once the animation data has been parsed you will be able to play animations using that data.
Please see the Animation Manager <code>fromJSON</code> method for more details about the format and playback.</p>
<p>You can also access the raw animation data from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">animation</span><spanclass="hl-1">(</span><spanclass="hl-7">'baddieAnims'</span><spanclass="hl-1">, </span><spanclass="hl-7">'files/BaddieAnims.json'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">data</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">cache</span><spanclass="hl-1">.</span><spanclass="hl-2">json</span><spanclass="hl-1">.</span><spanclass="hl-6">get</span><spanclass="hl-1">(</span><spanclass="hl-7">'baddieAnims'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Waves</code> the final key will be <code>LEVEL1.Waves</code> and
this is what you would use to retrieve the text from the JSON Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "data"
and no URL is given then the Loader will set the URL to be "data.json". It will always add <code>.json</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>You can also optionally provide a <code>dataKey</code> to use. This allows you to extract only a part of the JSON and store it in the Cache,
rather than the whole file. For example, if your JSON data had a structure like this:</p>
<p>And if you only wanted to create animations from the <code>boss</code> data, then you could pass <code>level1.baddies.boss</code>as the <code>dataKey</code>.</p>
<p>Note: The ability to load this type of file will only be available if the JSON File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">JSONFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">JSONFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.json</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.json".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">dataKey</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>When the Animation JSON file loads only this property will be stored in the Cache and used to create animation data.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.animation</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:63931</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="aseprite"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>aseprite</span><ahref="#aseprite"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="aseprite.aseprite-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">aseprite</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">textureURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">atlasURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">textureXhrSettings</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">atlasXhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#aseprite.aseprite-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Aseprite is a powerful animated sprite editor and pixel art tool.</p>
<p>You can find more details at <ahref="https://www.aseprite.org/">https://www.aseprite.org/</a></p>
<p>Adds a JSON based Aseprite Animation, or array of animations, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>This will only create the 3 animations defined. Note that the tag names are case-sensitive.</p>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.png". It will always add <code>.png</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Aseprite File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AsepriteFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AsepriteFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureURL</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the texture image file from. If undefined or <code>null</code> it will be set to <code><key>.png</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.png".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasURL</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">object</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the texture atlas json data file from. If undefined or <code>null</code> it will be set to <code><key>.json</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.json". Or, a well formed JSON object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.aseprite</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64052</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="atlas"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>atlas</span><ahref="#atlas"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="atlas.atlas-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">atlas</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">textureURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">atlasURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">textureXhrSettings</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">atlasXhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#atlas.atlas-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a JSON based Texture Atlas, or array of atlases, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.AtlasJSONFileConfig</code> for more details.</p>
<p>Instead of passing a URL for the atlas JSON data you can also pass in a well formed JSON object instead.</p>
<p>Once the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">atlas</span><spanclass="hl-1">(</span><spanclass="hl-7">'mainmenu'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/MainMenu.png'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/MainMenu.json'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">add</span><spanclass="hl-1">.</span><spanclass="hl-6">image</span><spanclass="hl-1">(</span><spanclass="hl-2">x</span><spanclass="hl-1">, </span><spanclass="hl-2">y</span><spanclass="hl-1">, </span><spanclass="hl-7">'mainmenu'</span><spanclass="hl-1">, </span><spanclass="hl-7">'background'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>To get a list of all available frames within an atlas please consult your Texture Atlas software.</p>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.png". It will always add <code>.png</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Phaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,
then you can specify it by providing an array as the <code>url</code> where the second element is the normal map:</p>
<p>The normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.
Normal maps are a WebGL only feature.</p>
<p>Note: The ability to load this type of file will only be available if the Atlas JSON File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AtlasJSONFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AtlasJSONFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureURL</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the texture image file from. If undefined or <code>null</code> it will be set to <code><key>.png</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.png".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasURL</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">object</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the texture atlas json data file from. If undefined or <code>null</code> it will be set to <code><key>.json</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.json". Or, a well formed JSON object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.atlas</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64161</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="atlasXML"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>atlasXML</span><ahref="#atlasXML"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="atlasXML.atlasXML-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">atlasXML</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">textureURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">atlasURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">textureXhrSettings</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">atlasXhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#atlasXML.atlasXML-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an XML based Texture Atlas, or array of atlases, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.AtlasXMLFileConfig</code> for more details.</p>
<p>Once the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">atlasXML</span><spanclass="hl-1">(</span><spanclass="hl-7">'mainmenu'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/MainMenu.png'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/MainMenu.xml'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">add</span><spanclass="hl-1">.</span><spanclass="hl-6">image</span><spanclass="hl-1">(</span><spanclass="hl-2">x</span><spanclass="hl-1">, </span><spanclass="hl-2">y</span><spanclass="hl-1">, </span><spanclass="hl-7">'mainmenu'</span><spanclass="hl-1">, </span><spanclass="hl-7">'background'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>To get a list of all available frames within an atlas please consult your Texture Atlas software.</p>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.png". It will always add <code>.png</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Phaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,
then you can specify it by providing an array as the <code>url</code> where the second element is the normal map:</p>
<p>The normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.
Normal maps are a WebGL only feature.</p>
<p>Note: The ability to load this type of file will only be available if the Atlas XML File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AtlasXMLFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AtlasXMLFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureURL</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the texture image file from. If undefined or <code>null</code> it will be set to <code><key>.png</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.png".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasURL</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the texture atlas xml data file from. If undefined or <code>null</code> it will be set to <code><key>.xml</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.xml".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the atlas xml file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.atlasXML</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64257</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="audio"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>audio</span><ahref="#audio"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="audio.audio-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">audio</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">urls</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">config</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#audio.audio-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an Audio or HTML5Audio file, or array of audio files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.AudioFileConfig</code> for more details.</p>
<p>The URLs can be relative or absolute. If the URLs are relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to them.</p>
<p>Due to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.
ogg, mp3 and m4a are the most common. If you provide an array of URLs then the Loader will determine which <em>one</em> file to load based on
browser support.</p>
<p>If audio has been disabled in your game, either via the game config, or lack of support from the device, then no audio will be loaded.</p>
<p>Note: The ability to load this type of file will only be available if the Audio File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AudioFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AudioFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">urls</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AudioFileURLConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AudioFileURLConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the audio files from.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">config</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>An object containing an <code>instances</code> property for HTML5Audio. Defaults to 1.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.audio</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64310</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="audioSprite"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>audio<wbr/>Sprite</span><ahref="#audioSprite"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="audioSprite.audioSprite-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">audio<wbr/>Sprite</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">jsonURL</span>, <spanclass="tsd-kind-parameter">audioURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">audioConfig</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">audioXhrSettings</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">jsonXhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#audioSprite.audioSprite-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a JSON based Audio Sprite, or array of audio sprites, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.AudioSpriteFileConfig</code> for more details.</p>
<p>Instead of passing a URL for the audio JSON data you can also pass in a well formed JSON object instead.</p>
<p>Once the audio has finished loading you can use it create an Audio Sprite by referencing its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">audioSprite</span><spanclass="hl-1">(</span><spanclass="hl-7">'kyobi'</span><spanclass="hl-1">, </span><spanclass="hl-7">'kyobi.json'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">music</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">sound</span><spanclass="hl-1">.</span><spanclass="hl-6">addAudioSprite</span><spanclass="hl-1">(</span><spanclass="hl-7">'kyobi'</span><spanclass="hl-1">);</span><br/><spanclass="hl-2">music</span><spanclass="hl-1">.</span><spanclass="hl-6">play</span><spanclass="hl-1">(</span><spanclass="hl-7">'title'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>Due to different browsers supporting different audio file types you should usually provide your audio files in a variety of formats.
ogg, mp3 and m4a are the most common. If you provide an array of URLs then the Loader will determine which <em>one</em> file to load based on
browser support.</p>
<p>If audio has been disabled in your game, either via the game config, or lack of support from the device, then no audio will be loaded.</p>
<p>Note: The ability to load this type of file will only be available if the Audio Sprite File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AudioSpriteFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">AudioSpriteFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or an array of objects.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">jsonURL</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the json file from. Or a well formed JSON object to use instead.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">audioURL</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the audio file from. If empty it will be obtained by parsing the JSON file.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">audioXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the audio file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">jsonXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the json file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.audioSprite</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64405</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="binary"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>binary</span><ahref="#binary"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="binary.binary-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">binary</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">dataType</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#binary.binary-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Binary file, or array of Binary files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.BinaryFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">binary</span><spanclass="hl-1">(</span><spanclass="hl-7">'doom'</span><spanclass="hl-1">, </span><spanclass="hl-7">'files/Doom.wad'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">data</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">cache</span><spanclass="hl-1">.</span><spanclass="hl-2">binary</span><spanclass="hl-1">.</span><spanclass="hl-6">get</span><spanclass="hl-1">(</span><spanclass="hl-7">'doom'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Data</code> the final key will be <code>LEVEL1.Data</code> and
this is what you would use to retrieve the text from the Binary Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "doom"
and no URL is given then the Loader will set the URL to be "doom.bin". It will always add <code>.bin</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Binary File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">BinaryFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">BinaryFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.bin</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.bin".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">dataType</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>Optional type to cast the binary file to once loaded. For example, <code>Uint8Array</code>.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.binary</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64469</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="bitmapFont"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>bitmap<wbr/>Font</span><ahref="#bitmapFont"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="bitmapFont.bitmapFont-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">bitmap<wbr/>Font</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">textureURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">fontDataURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">textureXhrSettings</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">fontDataXhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#bitmapFont.bitmapFont-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an XML based Bitmap Font, or array of fonts, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.BitmapFontFileConfig</code> for more details.</p>
<p>Once the atlas has finished loading you can use key of it when creating a Bitmap Text Game Object:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">bitmapFont</span><spanclass="hl-1">(</span><spanclass="hl-7">'goldenFont'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/GoldFont.png'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/GoldFont.xml'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">add</span><spanclass="hl-1">.</span><spanclass="hl-6">bitmapText</span><spanclass="hl-1">(</span><spanclass="hl-2">x</span><spanclass="hl-1">, </span><spanclass="hl-2">y</span><spanclass="hl-1">, </span><spanclass="hl-7">'goldenFont'</span><spanclass="hl-1">, </span><spanclass="hl-7">'Hello World'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use when creating a Bitmap Text object.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.png". It will always add <code>.png</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Phaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,
then you can specify it by providing an array as the <code>url</code> where the second element is the normal map:</p>
<p>The normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.
Normal maps are a WebGL only feature.</p>
<p>Note: The ability to load this type of file will only be available if the Bitmap Font File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">BitmapFontFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">BitmapFontFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureURL</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the font image file from. If undefined or <code>null</code> it will be set to <code><key>.png</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.png".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">fontDataURL</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the font xml data file from. If undefined or <code>null</code> it will be set to <code><key>.xml</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.xml".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the font image file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">fontDataXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the font data xml file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.bitmapFont</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64563</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="css"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>css</span><ahref="#css"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="css.css-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">css</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#css.css-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a CSS file, or array of CSS files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.CSSFileConfig</code> for more details.</p>
<p>Once the file has finished loading it will automatically be converted into a style DOM element
via <code>document.createElement('style')</code>. It will have its <code>defer</code> property set to false and then the
resulting element will be appended to <code>document.head</code>. The CSS styles are then applied to the current document.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.css". It will always add <code>.css</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the CSS File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">CSSFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">CSSFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.css</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.css".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.css</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64748</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="destroy"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>destroy</span><ahref="#destroy"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="destroy.destroy-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">destroy</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#destroy.destroy-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes all listeners.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.destroy</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9911</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="emit"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>emit</span><ahref="#emit"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="emit.emit-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">emit</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span>, <spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#emit.emit-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Calls each of the listeners registered for a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagRest">Rest</code><spanclass="tsd-signature-symbol">...</span><spanclass="tsd-kind-parameter">args</span>: <spanclass="tsd-signature-type">any</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>Additional arguments that will be passed to the event handler.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.emit</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9935</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="eventNames"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>event<wbr/>Names</span><ahref="#eventNames"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="eventNames.eventNames-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">event<wbr/>Names</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">symbol</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">[]</span><ahref="#eventNames.eventNames-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Return an array listing the events for which the emitter has registered listeners.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">symbol</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">[]</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.eventNames</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9916</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="fileProcessComplete"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>file<wbr/>Process<wbr/>Complete</span><ahref="#fileProcessComplete"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="fileProcessComplete.fileProcessComplete-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">file<wbr/>Process<wbr/>Complete</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">file</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#fileProcessComplete.fileProcessComplete-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>An internal method that is called automatically by the File when it has finished processing.</p>
<p>If the process was successful, and the File isn't part of a MultiFile, its <code>addToCache</code> method is called.</p>
<p>It this then removed from the queue. If there are no more files to load <code>loadComplete</code> is called.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">file</span>: <spanclass="tsd-signature-type">File</span></span><divclass="tsd-comment tsd-typography"><p>The file that has finished processing.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.fileProcessComplete</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66703</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="flagForRemoval"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>flag<wbr/>For<wbr/>Removal</span><ahref="#flagForRemoval"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="flagForRemoval.flagForRemoval-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">flag<wbr/>For<wbr/>Removal</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">file</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#flagForRemoval.flagForRemoval-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a File into the pending-deletion queue.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">file</span>: <spanclass="tsd-signature-type">File</span></span><divclass="tsd-comment tsd-typography"><p>The File to be queued for deletion when the Loader completes.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.flagForRemoval</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66717</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="glsl"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>glsl</span><ahref="#glsl"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="glsl.glsl-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">glsl</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">shaderType</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#glsl.glsl-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a GLSL file, or array of GLSL files, to the current load queue.
In Phaser 3 GLSL files are just plain Text files at the current moment in time.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.GLSLFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">glsl</span><spanclass="hl-1">(</span><spanclass="hl-7">'plasma'</span><spanclass="hl-1">, </span><spanclass="hl-7">'shaders/Plasma.glsl'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">data</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">cache</span><spanclass="hl-1">.</span><spanclass="hl-2">shader</span><spanclass="hl-1">.</span><spanclass="hl-6">get</span><spanclass="hl-1">(</span><spanclass="hl-7">'plasma'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>FX.</code> and the key was <code>Plasma</code> the final key will be <code>FX.Plasma</code> and
this is what you would use to retrieve the text from the Shader Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "plasma"
and no URL is given then the Loader will set the URL to be "plasma.glsl". It will always add <code>.glsl</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the GLSL File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">GLSLFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">GLSLFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.glsl</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.glsl".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">shaderType</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The type of shader. Either <code>fragment</code> for a fragment shader, or <code>vertex</code> for a vertex shader. This is ignored if you load a shader bundle. Default 'fragment'.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.glsl</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64813</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="html"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>html</span><ahref="#html"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="html.html-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">html</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#html.html-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an HTML file, or array of HTML files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.HTMLFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">html</span><spanclass="hl-1">(</span><spanclass="hl-7">'login'</span><spanclass="hl-1">, </span><spanclass="hl-7">'files/LoginForm.html'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">data</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">cache</span><spanclass="hl-1">.</span><spanclass="hl-2">html</span><spanclass="hl-1">.</span><spanclass="hl-6">get</span><spanclass="hl-1">(</span><spanclass="hl-7">'login'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Story</code> the final key will be <code>LEVEL1.Story</code> and
this is what you would use to retrieve the html from the HTML Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "story"
and no URL is given then the Loader will set the URL to be "story.html". It will always add <code>.html</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the HTML File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">HTMLFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">HTMLFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.html</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.html".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.html</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64875</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="htmlTexture"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>html<wbr/>Texture</span><ahref="#htmlTexture"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="htmlTexture.htmlTexture-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">html<wbr/>Texture</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">width</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">height</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#htmlTexture.htmlTexture-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an HTML File, or array of HTML Files, to the current load queue. When the files are loaded they
will be rendered to textures and stored in the Texture Manager.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.HTMLTextureFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can use it as a texture for a Game Object by referencing its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">htmlTexture</span><spanclass="hl-1">(</span><spanclass="hl-7">'instructions'</span><spanclass="hl-1">, </span><spanclass="hl-7">'content/intro.html'</span><spanclass="hl-1">, </span><spanclass="hl-0">256</span><spanclass="hl-1">, </span><spanclass="hl-0">512</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">add</span><spanclass="hl-1">.</span><spanclass="hl-6">image</span><spanclass="hl-1">(</span><spanclass="hl-2">x</span><spanclass="hl-1">, </span><spanclass="hl-2">y</span><spanclass="hl-1">, </span><spanclass="hl-7">'instructions'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.html". It will always add <code>.html</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>The width and height are the size of the texture to which the HTML will be rendered. It's not possible to determine these
automatically, so you will need to provide them, either as arguments or in the file config object.
When the HTML file has loaded a new SVG element is created with a size and viewbox set to the width and height given.
The SVG file has a body tag added to it, with the HTML file contents included. It then calls <code>window.Blob</code> on the SVG,
and if successful is added to the Texture Manager, otherwise it fails processing. The overall quality of the rendered
HTML depends on your browser, and some of them may not even support the svg / blob process used. Be aware that there are
limitations on what HTML can be inside an SVG. You can find out more details in this
<p>Note: The ability to load this type of file will only be available if the HTMLTextureFile File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">HTMLTextureFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">HTMLTextureFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.html</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.html".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">width</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The width of the texture the HTML will be rendered to. Default 512.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">height</span>: <spanclass="tsd-signature-type">number</span></span><divclass="tsd-comment tsd-typography"><p>The height of the texture the HTML will be rendered to. Default 512.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.htmlTexture</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64951</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="image"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>image</span><ahref="#image"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="image.image-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">image</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#image.image-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an Image, or array of Images, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.ImageFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can use it as a texture for a Game Object by referencing its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">image</span><spanclass="hl-1">(</span><spanclass="hl-7">'logo'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/AtariLogo.png'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">add</span><spanclass="hl-1">.</span><spanclass="hl-6">image</span><spanclass="hl-1">(</span><spanclass="hl-2">x</span><spanclass="hl-1">, </span><spanclass="hl-2">y</span><spanclass="hl-1">, </span><spanclass="hl-7">'logo'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.png". It will always add <code>.png</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Phaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,
then you can specify it by providing an array as the <code>url</code> where the second element is the normal map:</p>
<p>The normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.
Normal maps are a WebGL only feature.</p>
<p>In Phaser 3.60 a new property was added that allows you to control how images are loaded. By default, images are loaded via XHR as Blobs.
However, you can set <code>loader.imageLoadType: "HTMLImageElement"</code> in the Game Configuration and instead, the Loader will load all images
via the Image tag instead.</p>
<p>Note: The ability to load this type of file will only be available if the Image File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">ImageFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">ImageFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.png</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.png".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.image</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65041</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="isLoading"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>is<wbr/>Loading</span><ahref="#isLoading"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="isLoading.isLoading-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">is<wbr/>Loading</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#isLoading.isLoading-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Is the Loader actively loading, or processing loaded files?</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.isLoading</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66653</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="isReady"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>is<wbr/>Ready</span><ahref="#isReady"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="isReady.isReady-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">is<wbr/>Ready</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#isReady.isReady-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Is the Loader ready to start a new load?</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.isReady</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66658</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="json"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>json</span><ahref="#json"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="json.json-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">json</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">dataKey</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#json.json-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a JSON file, or array of JSON files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.JSONFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">json</span><spanclass="hl-1">(</span><spanclass="hl-7">'wavedata'</span><spanclass="hl-1">, </span><spanclass="hl-7">'files/AlienWaveData.json'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">data</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">cache</span><spanclass="hl-1">.</span><spanclass="hl-2">json</span><spanclass="hl-1">.</span><spanclass="hl-6">get</span><spanclass="hl-1">(</span><spanclass="hl-7">'wavedata'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Waves</code> the final key will be <code>LEVEL1.Waves</code> and
this is what you would use to retrieve the text from the JSON Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "data"
and no URL is given then the Loader will set the URL to be "data.json". It will always add <code>.json</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>You can also optionally provide a <code>dataKey</code> to use. This allows you to extract only a part of the JSON and store it in the Cache,
rather than the whole file. For example, if your JSON data had a structure like this:</p>
<p>And you only wanted to store the <code>boss</code> data in the Cache, then you could pass <code>level1.baddies.boss</code>as the <code>dataKey</code>.</p>
<p>Note: The ability to load this type of file will only be available if the JSON File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">JSONFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">JSONFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">object</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.json</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.json". Or, can be a fully formed JSON Object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">dataKey</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>When the JSON file loads only this property will be stored in the Cache.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.json</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65122</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="keyExists"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>key<wbr/>Exists</span><ahref="#keyExists"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="keyExists.keyExists-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">key<wbr/>Exists</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">file</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">boolean</span><ahref="#keyExists.keyExists-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Checks the key and type of the given file to see if it will conflict with anything already
in a Cache, the Texture Manager, or the list or inflight queues.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">file</span>: <spanclass="tsd-signature-type">File</span></span><divclass="tsd-comment tsd-typography"><p>The file to check the key of.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">boolean</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.keyExists</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66635</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="listenerCount"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>listener<wbr/>Count</span><ahref="#listenerCount"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="listenerCount.listenerCount-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">listener<wbr/>Count</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">number</span><ahref="#listenerCount.listenerCount-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Return the number of listeners listening to a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">number</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.listenerCount</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9928</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="listeners"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>listeners</span><ahref="#listeners"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="listeners.listeners-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">listeners</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">Function</span><spanclass="tsd-signature-symbol">[]</span><ahref="#listeners.listeners-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Return the listeners registered for a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">Function</span><spanclass="tsd-signature-symbol">[]</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.listeners</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9922</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="loadComplete"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>load<wbr/>Complete</span><ahref="#loadComplete"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="loadComplete.loadComplete-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">load<wbr/>Complete</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#loadComplete.loadComplete-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Called at the end when the load queue is exhausted and all files have either loaded or errored.
By this point every loaded file will now be in its associated cache and ready for use.</p>
<p>Also clears down the Sets, puts progress to 1 and clears the deletion queue.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.loadComplete</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66711</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="multiatlas"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>multiatlas</span><ahref="#multiatlas"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="multiatlas.multiatlas-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">multiatlas</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">atlasURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">path</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">baseURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">atlasXhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#multiatlas.multiatlas-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Multi Texture Atlas, or array of multi atlases, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.MultiAtlasFileConfig</code> for more details.</p>
<p>Instead of passing a URL for the atlas JSON data you can also pass in a well formed JSON object instead.</p>
<p>Once the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">multiatlas</span><spanclass="hl-1">(</span><spanclass="hl-7">'level1'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/Level1.json'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">add</span><spanclass="hl-1">.</span><spanclass="hl-6">image</span><spanclass="hl-1">(</span><spanclass="hl-2">x</span><spanclass="hl-1">, </span><spanclass="hl-2">y</span><spanclass="hl-1">, </span><spanclass="hl-7">'level1'</span><spanclass="hl-1">, </span><spanclass="hl-7">'background'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>To get a list of all available frames within an atlas please consult your Texture Atlas software.</p>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.png". It will always add <code>.png</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Multi Atlas File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">MultiAtlasFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">MultiAtlasFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasURL</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the texture atlas json data file from. If undefined or <code>null</code> it will be set to <code><key>.json</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.json".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">path</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>Optional path to use when loading the textures defined in the atlas data.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">baseURL</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>Optional Base URL to use when loading the textures defined in the atlas data.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the atlas json file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.multiatlas</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65200</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="nextFile"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>next<wbr/>File</span><ahref="#nextFile"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="nextFile.nextFile-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">next<wbr/>File</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">file</span>, <spanclass="tsd-kind-parameter">success</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#nextFile.nextFile-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>An internal method called automatically by the XHRLoader belong to a File.</p>
<p>This method will remove the given file from the inflight Set and update the load progress.
If the file was successful its <code>onProcess</code> method is called, otherwise it is added to the delete queue.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">file</span>: <spanclass="tsd-signature-type">File</span></span><divclass="tsd-comment tsd-typography"><p>The File that just finished loading, or errored during load.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><spanclass="tsd-kind-parameter">success</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p><code>true</code> if the file loaded successfully, otherwise <code>false</code>.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.nextFile</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66693</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="obj"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>obj</span><ahref="#obj"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="obj.obj-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">obj</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">objURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">matURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">flipUV</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#obj.obj-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Wavefront OBJ file, or array of OBJ files, to the current load queue.</p>
<p>Note: You should ensure your 3D package has triangulated the OBJ file prior to export.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.OBJFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">obj</span><spanclass="hl-1">(</span><spanclass="hl-7">'ufo'</span><spanclass="hl-1">, </span><spanclass="hl-7">'files/spaceship.obj'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">data</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">cache</span><spanclass="hl-1">.</span><spanclass="hl-2">obj</span><spanclass="hl-1">.</span><spanclass="hl-6">get</span><spanclass="hl-1">(</span><spanclass="hl-7">'ufo'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Story</code> the final key will be <code>LEVEL1.Story</code> and
this is what you would use to retrieve the obj from the OBJ Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "story"
and no URL is given then the Loader will set the URL to be "story.obj". It will always add <code>.obj</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the OBJ File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">OBJFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">OBJFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">objURL</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the obj file from. If undefined or <code>null</code> it will be set to <code><key>.obj</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.obj".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">matURL</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>Optional absolute or relative URL to load the obj material file from.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">flipUV</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Flip the UV coordinates stored in the model data?</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.obj</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65349</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="off"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>off</span><ahref="#off"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="off.off-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">off</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span>, <spanclass="tsd-kind-parameter">fn</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">context</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">once</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#off.off-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Remove the listeners of a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">fn</span>: <spanclass="tsd-signature-type">Function</span></span><divclass="tsd-comment tsd-typography"><p>Only remove the listeners that match this function.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">context</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>Only remove the listeners that have this context.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.off</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9977</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="on"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>on</span><ahref="#on"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="on.on-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">on</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span>, <spanclass="tsd-kind-parameter">fn</span>, <spanclass="tsd-kind-parameter">context</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#on.on-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Add a listener for a given event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">context</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The context to invoke the listener with. Default this.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.once</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9959</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="pack"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>pack</span><ahref="#pack"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="pack.pack-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">pack</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">dataKey</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#pack.pack-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a JSON File Pack, or array of packs, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.PackFileConfig</code> for more details.</p>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Waves</code> the final key will be <code>LEVEL1.Waves</code> and
this is what you would use to retrieve the text from the JSON Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "data"
and no URL is given then the Loader will set the URL to be "data.json". It will always add <code>.json</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>You can also optionally provide a <code>dataKey</code> to use. This allows you to extract only a part of the JSON and store it in the Cache,
rather than the whole file. For example, if your JSON data had a structure like this:</p>
<p>And you only wanted to store the <code>boss</code> data in the Cache, then you could pass <code>level1.baddies.boss</code>as the <code>dataKey</code>.</p>
<p>Note: The ability to load this type of file will only be available if the Pack File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">PackFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">PackFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.json</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.json".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">dataKey</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>When the JSON file loads only this property will be stored in the Cache.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.pack</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65463</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="plugin"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>plugin</span><ahref="#plugin"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="plugin.plugin-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">plugin</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">start</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">mapping</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#plugin.plugin-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Plugin Script file, or array of plugin files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.PluginFileConfig</code> for more details.</p>
<p>Once the file has finished loading it will automatically be converted into a script element
via <code>document.createElement('script')</code>. It will have its language set to JavaScript, <code>defer</code> set to
false and then the resulting element will be appended to <code>document.head</code>. Any code then in the
script will be executed. It will then be passed to the Phaser PluginCache.register method.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.js". It will always add <code>.js</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Plugin File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">PluginFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">PluginFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">Function</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.js</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.js". Or, a plugin function.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">start</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Automatically start the plugin after loading?</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">mapping</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>If this plugin is to be injected into the Scene, this is the property key used.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.plugin</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65517</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="removeAllListeners"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><ahref="#removeAllListeners"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="removeAllListeners.removeAllListeners-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">remove<wbr/>All<wbr/>Listeners</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">event</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#removeAllListeners.removeAllListeners-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Remove all listeners, or those of the specified event.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">fn</span>: <spanclass="tsd-signature-type">Function</span></span><divclass="tsd-comment tsd-typography"><p>Only remove the listeners that match this function.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">context</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>Only remove the listeners that have this context.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.removeListener</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9968</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="reset"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>reset</span><ahref="#reset"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="reset.reset-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">reset</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#reset.reset-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Resets the Loader.</p>
<p>This will clear all lists and reset the base URL, path and prefix.</p>
<p>Warning: If the Loader is currently downloading files, or has files in its queue, they will be aborted.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.reset</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66746</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="save"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>save</span><ahref="#save"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="save.save-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">save</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">data</span>, <spanclass="tsd-kind-parameter">filename</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">filetype</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#save.save-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Causes the browser to save the given data as a file to its default Downloads folder.</p>
<p>Creates a DOM level anchor link, assigns it as being a <code>download</code> anchor, sets the href
to be an ObjectURL based on the given data, and then invokes a click event.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">data</span>: <spanclass="tsd-signature-type">any</span></span><divclass="tsd-comment tsd-typography"><p>The data to be saved. Will be passed through URL.createObjectURL.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">filename</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The filename to save the file as. Default file.json.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">filetype</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The file type to use when saving the file. Defaults to JSON. Default application/json.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.save</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66737</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="saveJSON"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>saveJSON</span><ahref="#saveJSON"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="saveJSON.saveJSON-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">saveJSON</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">data</span>, <spanclass="tsd-kind-parameter">filename</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#saveJSON.saveJSON-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Converts the given JSON data into a file that the browser then prompts you to download so you can save it locally.</p>
<p>The data must be well formed JSON and ready-parsed, not a JavaScript object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">filename</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The name to save the JSON file as. Default file.json.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.saveJSON</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66726</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="sceneFile"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scene<wbr/>File</span><ahref="#sceneFile"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="sceneFile.sceneFile-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">scene<wbr/>File</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#sceneFile.sceneFile-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an external Scene file, or array of Scene files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.SceneFileConfig</code> for more details.</p>
<p>Once the file has finished loading it will be added to the Scene Manager.</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">sceneFile</span><spanclass="hl-1">(</span><spanclass="hl-7">'Level1'</span><spanclass="hl-1">, </span><spanclass="hl-7">'src/Level1.js'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">scene</span><spanclass="hl-1">.</span><spanclass="hl-6">start</span><spanclass="hl-1">(</span><spanclass="hl-7">'Level1'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>WORLD1.</code> and the key was <code>Story</code> the final key will be <code>WORLD1.Story</code> and
this is what you would use to retrieve the text from the Scene Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "story"
and no URL is given then the Loader will set the URL to be "story.js". It will always add <code>.js</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Scene File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">SceneFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">SceneFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.js</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.js".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.sceneFile</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65607</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scenePlugin"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scene<wbr/>Plugin</span><ahref="#scenePlugin"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="scenePlugin.scenePlugin-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">scene<wbr/>Plugin</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">systemKey</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">sceneKey</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#scenePlugin.scenePlugin-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Scene Plugin Script file, or array of plugin files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.ScenePluginFileConfig</code> for more details.</p>
<p>Once the file has finished loading it will automatically be converted into a script element
via <code>document.createElement('script')</code>. It will have its language set to JavaScript, <code>defer</code> set to
false and then the resulting element will be appended to <code>document.head</code>. Any code then in the
script will be executed. It will then be passed to the Phaser PluginCache.register method.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.js". It will always add <code>.js</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Script File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">ScenePluginFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">ScenePluginFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">Function</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.js</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.js". Or, set to a plugin function.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">systemKey</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>If this plugin is to be added to Scene.Systems, this is the property key for it.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">sceneKey</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>If this plugin is to be added to the Scene, this is the property key for it.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.scenePlugin</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65661</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="script"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>script</span><ahref="#script"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="script.script-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">script</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">type</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#script.script-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Script file, or array of Script files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>The file is <strong>not</strong> loaded right away. It is added to a queue ready to be loaded either when the loader starts,
or if it's already running, when the next free load slot becomes available. This happens automatically if you
are calling this from within the Scene's <code>preload</code> method, or a related callback. Because the file is queued
it means you cannot use the file immediately after calling this method, but must wait for the file to complete.
The typical flow for a Phaser Scene is that you load assets in the Scene's <code>preload</code> method and then when the
Scene's <code>create</code> method is called you are guaranteed that all of those assets are ready for use and have been
loaded.</p>
<p>The key must be a unique String and not already in-use by another file in the Loader.</p>
<p>Instead of passing arguments you can pass a configuration object, such as:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">script</span><spanclass="hl-1">({</span><br/><spanclass="hl-1"></span><spanclass="hl-2">key:</span><spanclass="hl-1"></span><spanclass="hl-7">'aliens'</span><spanclass="hl-1">,</span><br/><spanclass="hl-1"></span><spanclass="hl-2">url:</span><spanclass="hl-1"></span><spanclass="hl-7">'lib/aliens.js'</span><spanclass="hl-1">,</span><br/><spanclass="hl-1"></span><spanclass="hl-2">type:</span><spanclass="hl-1"></span><spanclass="hl-7">'script'</span><spanclass="hl-1"></span><spanclass="hl-8">// or 'module'</span><br/><spanclass="hl-1">});</span>
</code><button>Copy</button></pre>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.ScriptFileConfig</code> for more details.</p>
<p>Once the file has finished loading it will automatically be converted into a script element
via <code>document.createElement('script')</code>. It will have its language set to JavaScript, <code>defer</code> set to
false and then the resulting element will be appended to <code>document.head</code>. Any code then in the
script will be executed.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.js". It will always add <code>.js</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Script File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">ScriptFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">ScriptFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.js</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.js".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">type</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The script type. Should be either 'script' for classic JavaScript, or 'module' if the file contains an exported module. Default 'script'.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.script</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65724</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="scripts"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>scripts</span><ahref="#scripts"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="scripts.scripts-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">scripts</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">extension</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#scripts.scripts-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an array of Script files to the current load queue.</p>
<p>The difference between this and the <code>ScriptFile</code> file type is that you give an array of scripts to this method,
and the scripts are then processed <em>exactly</em> in that order. This allows you to load a bunch of scripts that
may have dependencies on each other without worrying about the async nature of traditional script loading.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.MultiScriptFileConfig</code> for more details.</p>
<p>Once all the files have finished loading they will automatically be converted into a script element
via <code>document.createElement('script')</code>. They will have their language set to JavaScript, <code>defer</code> set to
false and then the resulting element will be appended to <code>document.head</code>. Any code then in the
script will be executed. This is done in the exact order the files are specified in the url array.</p>
<p>The URLs can be relative or absolute. If the URLs are relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to them.</p>
<p>Note: The ability to load this type of file will only be available if the MultiScript File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">MultiScriptFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">MultiScriptFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>An array of absolute or relative URLs to load the script files from. They are processed in the order given in the array.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">extension</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The default file extension to use if no url is provided. Default 'js'.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>Extra XHR Settings specifically for these files.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.scripts</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65270</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setBaseURL"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>BaseURL</span><ahref="#setBaseURL"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setBaseURL.setBaseURL-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>BaseURL</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setBaseURL.setBaseURL-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>If you want to append a URL before the path of any asset you can set this here.</p>
<p>Useful if allowing the asset base url to be configured outside of the game code.</p>
<p>Once a base URL is set it will affect every file loaded by the Loader from that point on. It does <em>not</em> change any
file <em>already</em> being loaded. To reset it, call this method with no arguments.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The URL to use. Leave empty to reset.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.setBaseURL</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66568</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setCORS"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>setCORS</span><ahref="#setCORS"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setCORS.setCORS-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">setCORS</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">crossOrigin</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setCORS.setCORS-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Sets the Cross Origin Resource Sharing value used when loading files.</p>
<p>Files can override this value on a per-file basis by specifying an alternative <code>crossOrigin</code> value in their file config.</p>
<p>Once CORs is set it will then affect every file loaded by the Loader from that point on, as long as they don't have
their own CORs setting. To reset it, call this method with no arguments.</p>
<p>For more details about CORs see <ahref="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS">https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS</a></p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">crossOrigin</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The value to use for the <code>crossOrigin</code> property in the load request.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.setCORS</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66614</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setPath"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Path</span><ahref="#setPath"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setPath.setPath-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Path</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">path</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setPath.setPath-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>The value of <code>path</code>, if set, is placed before any <em>relative</em> file path given. For example:</p>
<p>Would load the <code>ball</code> file from <code>images/sprites/ball.png</code> and the tree from
<code>images/sprites/level1/oaktree.png</code> but the file <code>boom</code> would load from the URL
given as it's an absolute URL.</p>
<p>Please note that the path is added before the filename but <em>after</em> the baseURL (if set.)</p>
<p>Once a path is set it will then affect every file added to the Loader from that point on. It does <em>not</em> change any
file <em>already</em> in the load queue. To reset it, call this method with no arguments.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">path</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The path to use. Leave empty to reset.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.setPath</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66590</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="setPrefix"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>set<wbr/>Prefix</span><ahref="#setPrefix"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="setPrefix.setPrefix-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">set<wbr/>Prefix</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">prefix</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#setPrefix.setPrefix-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>An optional prefix that is automatically prepended to the start of every file key.</p>
<p>If prefix was <code>MENU.</code> and you load an image with the key 'Background' the resulting key would be <code>MENU.Background</code>.</p>
<p>Once a prefix is set it will then affect every file added to the Loader from that point on. It does <em>not</em> change any
file <em>already</em> in the load queue. To reset it, call this method with no arguments.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">prefix</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The prefix to use. Leave empty to reset.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.setPrefix</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66601</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="shutdown"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>shutdown</span><ahref="#shutdown"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="shutdown.shutdown-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">shutdown</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#shutdown.shutdown-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Removes all listeners.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.shutdown</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:9906</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="spritesheet"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>spritesheet</span><ahref="#spritesheet"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="spritesheet.spritesheet-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">spritesheet</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">frameConfig</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#spritesheet.spritesheet-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Sprite Sheet Image, or array of Sprite Sheet Images, to the current load queue.</p>
<p>The term 'Sprite Sheet' in Phaser means a fixed-size sheet. Where every frame in the sheet is the exact same size,
and you reference those frames using numbers, not frame names. This is not the same thing as a Texture Atlas, where
the frames are packed in a way where they take up the least amount of space, and are referenced by their names,
not numbers. Some articles and software use the term 'Sprite Sheet' to mean Texture Atlas, so please be aware of
what sort of file you're actually trying to load.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.SpriteSheetFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can use it as a texture for a Game Object by referencing its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">spritesheet</span><spanclass="hl-1">(</span><spanclass="hl-7">'bot'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/robot.png'</span><spanclass="hl-1">, { </span><spanclass="hl-2">frameWidth:</span><spanclass="hl-1"></span><spanclass="hl-0">32</span><spanclass="hl-1">, </span><spanclass="hl-2">frameHeight:</span><spanclass="hl-1"></span><spanclass="hl-0">38</span><spanclass="hl-1"> });</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">add</span><spanclass="hl-1">.</span><spanclass="hl-6">image</span><spanclass="hl-1">(</span><spanclass="hl-2">x</span><spanclass="hl-1">, </span><spanclass="hl-2">y</span><spanclass="hl-1">, </span><spanclass="hl-7">'bot'</span><spanclass="hl-1">, </span><spanclass="hl-0">0</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>PLAYER.</code> and the key was <code>Running</code> the final key will be <code>PLAYER.Running</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.png". It will always add <code>.png</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Phaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,
then you can specify it by providing an array as the <code>url</code> where the second element is the normal map:</p>
<p>The normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.
Normal maps are a WebGL only feature.</p>
<p>Note: The ability to load this type of file will only be available if the Sprite Sheet File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">SpriteSheetFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">SpriteSheetFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.png</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.png".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">frameConfig</span>: <spanclass="tsd-signature-type">ImageFrameConfig</span></span><divclass="tsd-comment tsd-typography"><p>The frame configuration object. At a minimum it should have a <code>frameWidth</code> property.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.spritesheet</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65827</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="start"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>start</span><ahref="#start"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="start.start-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">start</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#start.start-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Starts the Loader running. This will reset the progress and totals and then emit a <code>start</code> event.
If there is nothing in the queue the Loader will immediately complete, otherwise it will start
loading the first batch of files.</p>
<p>The Loader is started automatically if the queue is populated within your Scenes <code>preload</code> method.</p>
<p>However, outside of this, you need to call this method to start it.</p>
<p>If the Loader is already running this method will simply return.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.start</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66671</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="svg"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>svg</span><ahref="#svg"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="svg.svg-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">svg</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">svgConfig</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#svg.svg-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an SVG File, or array of SVG Files, to the current load queue. When the files are loaded they
will be rendered to bitmap textures and stored in the Texture Manager.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.SVGFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can use it as a texture for a Game Object by referencing its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">svg</span><spanclass="hl-1">(</span><spanclass="hl-7">'morty'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/Morty.svg'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">add</span><spanclass="hl-1">.</span><spanclass="hl-6">image</span><spanclass="hl-1">(</span><spanclass="hl-2">x</span><spanclass="hl-1">, </span><spanclass="hl-2">y</span><spanclass="hl-1">, </span><spanclass="hl-7">'morty'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.html". It will always add <code>.html</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>You can optionally pass an SVG Resize Configuration object when you load an SVG file. By default the SVG will be rendered to a texture
at the same size defined in the SVG file attributes. However, this isn't always desirable. You may wish to resize the SVG (either down
or up) to improve texture clarity, or reduce texture memory consumption. You can either specify an exact width and height to resize
<p>If scale, width and height values are all given, the scale has priority and the width and height values are ignored.</p>
<p>Note: The ability to load this type of file will only be available if the SVG File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">SVGFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">SVGFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.svg</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.svg".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.svg</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:65939</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="text"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>text</span><ahref="#text"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="text.text-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">text</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#text.text-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Text file, or array of Text files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.TextFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">text</span><spanclass="hl-1">(</span><spanclass="hl-7">'story'</span><spanclass="hl-1">, </span><spanclass="hl-7">'files/IntroStory.txt'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">data</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">cache</span><spanclass="hl-1">.</span><spanclass="hl-2">text</span><spanclass="hl-1">.</span><spanclass="hl-6">get</span><spanclass="hl-1">(</span><spanclass="hl-7">'story'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Story</code> the final key will be <code>LEVEL1.Story</code> and
this is what you would use to retrieve the text from the Text Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "story"
and no URL is given then the Loader will set the URL to be "story.txt". It will always add <code>.txt</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Text File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">TextFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">TextFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.txt</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.txt".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.text</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66001</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="texture"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>texture</span><ahref="#texture"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="texture.texture-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">texture</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#texture.texture-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Compressed Texture file to the current load queue. This feature is WebGL only.</p>
<p>This method takes a key and a configuration object, which lists the different formats
and files associated with them.</p>
<p>The texture format object should be ordered in GPU priority order, with IMG as the last entry.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.CompressedTextureFileConfig</code> for more details.</p>
<p>The number of formats you provide to this function is up to you, but you should ensure you
cover the primary platforms where appropriate.</p>
<p>The 'IMG' entry is a fallback to a JPG or PNG, should the browser be unable to load any of the other
formats presented to this function. You should really always include this, although it is optional.</p>
<p>Phaser supports loading both the PVR and KTX container formats. Within those, it can parse
the following texture compression formats:</p>
<p>ETC
ETC1
ATC
ASTC
BPTC
RGTC
PVRTC
S3TC
S3TCSRGB</p>
<p>For more information about the benefits of compressed textures please see the
following articles:</p>
<p>Texture Compression in 2020 (<ahref="https://aras-p.info/blog/2020/12/08/Texture-Compression-in-2020/">https://aras-p.info/blog/2020/12/08/Texture-Compression-in-2020/</a>)
PVRTexTool (<ahref="https://developer.imaginationtech.com/pvrtextool/">https://developer.imaginationtech.com/pvrtextool/</a>) - available for Windows, macOS and Linux.
Mali Texture Compression Tool (<ahref="https://developer.arm.com/tools-and-software/graphics-and-gaming/mali-texture-compression-tool">https://developer.arm.com/tools-and-software/graphics-and-gaming/mali-texture-compression-tool</a>)
<p>ASTCs must have a Channel Type of Unsigned Normalized Bytes (UNorm).</p>
<p>The file is <strong>not</strong> loaded right away. It is added to a queue ready to be loaded either when the loader starts,
or if it's already running, when the next free load slot becomes available. This happens automatically if you
are calling this from within the Scene's <code>preload</code> method, or a related callback. Because the file is queued
it means you cannot use the file immediately after calling this method, but must wait for the file to complete.
The typical flow for a Phaser Scene is that you load assets in the Scene's <code>preload</code> method and then when the
Scene's <code>create</code> method is called you are guaranteed that all of those assets are ready for use and have been
loaded.</p>
<p>The key must be a unique String. It is used to add the file to the global Texture Manager upon a successful load.
The key should be unique both in terms of files being loaded and files already present in the Texture Manager.
Loading a file using a key that is already taken will result in a warning. If you wish to replace an existing file
then remove it from the Texture Manager first, before loading a new one.</p>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Data</code> the final key will be <code>LEVEL1.Data</code> and
this is what you would use to retrieve the text from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>Unlike other file loaders in Phaser, the URLs must include the file extension.</p>
<p>Note: The ability to load this type of file will only be available if the Compressed Texture File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">CompressedTextureFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">CompressedTextureFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">CompressedTextureFileConfig</span></span><divclass="tsd-comment tsd-typography"><p>The compressed texture configuration object. Not required if passing a config object as the <code>key</code> parameter.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.texture</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:64697</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="tilemapCSV"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>tilemapCSV</span><ahref="#tilemapCSV"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="tilemapCSV.tilemapCSV-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">tilemapCSV</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#tilemapCSV.tilemapCSV-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a CSV Tilemap file, or array of CSV files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">tilemapCSV</span><spanclass="hl-1">(</span><spanclass="hl-7">'level1'</span><spanclass="hl-1">, </span><spanclass="hl-7">'maps/Level1.csv'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">map</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">make</span><spanclass="hl-1">.</span><spanclass="hl-6">tilemap</span><spanclass="hl-1">({ </span><spanclass="hl-2">key:</span><spanclass="hl-1"></span><spanclass="hl-7">'level1'</span><spanclass="hl-1"> });</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Story</code> the final key will be <code>LEVEL1.Story</code> and
this is what you would use to retrieve the text from the Tilemap Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "level"
and no URL is given then the Loader will set the URL to be "level.csv". It will always add <code>.csv</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Tilemap CSV File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">TilemapCSVFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">TilemapCSVFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.csv</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.csv".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.tilemapCSV</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66065</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="tilemapImpact"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>tilemap<wbr/>Impact</span><ahref="#tilemapImpact"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="tilemapImpact.tilemapImpact-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">tilemap<wbr/>Impact</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#tilemapImpact.tilemapImpact-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an Impact.js Tilemap file, or array of map files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.TilemapImpactFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">tilemapImpact</span><spanclass="hl-1">(</span><spanclass="hl-7">'level1'</span><spanclass="hl-1">, </span><spanclass="hl-7">'maps/Level1.json'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">map</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">make</span><spanclass="hl-1">.</span><spanclass="hl-6">tilemap</span><spanclass="hl-1">({ </span><spanclass="hl-2">key:</span><spanclass="hl-1"></span><spanclass="hl-7">'level1'</span><spanclass="hl-1"> });</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Story</code> the final key will be <code>LEVEL1.Story</code> and
this is what you would use to retrieve the text from the Tilemap Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "level"
and no URL is given then the Loader will set the URL to be "level.json". It will always add <code>.json</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Tilemap Impact File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">TilemapImpactFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">TilemapImpactFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.json</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.json".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.tilemapImpact</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66129</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="tilemapTiledJSON"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>tilemap<wbr/>TiledJSON</span><ahref="#tilemapTiledJSON"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="tilemapTiledJSON.tilemapTiledJSON-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">tilemap<wbr/>TiledJSON</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#tilemapTiledJSON.tilemapTiledJSON-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Tiled JSON Tilemap file, or array of map files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.TilemapJSONFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">tilemapTiledJSON</span><spanclass="hl-1">(</span><spanclass="hl-7">'level1'</span><spanclass="hl-1">, </span><spanclass="hl-7">'maps/Level1.json'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">map</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">make</span><spanclass="hl-1">.</span><spanclass="hl-6">tilemap</span><spanclass="hl-1">({ </span><spanclass="hl-2">key:</span><spanclass="hl-1"></span><spanclass="hl-7">'level1'</span><spanclass="hl-1"> });</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Story</code> the final key will be <code>LEVEL1.Story</code> and
this is what you would use to retrieve the text from the Tilemap Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "level"
and no URL is given then the Loader will set the URL to be "level.json". It will always add <code>.json</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the Tilemap JSON File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">TilemapJSONFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">TilemapJSONFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">object</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.json</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.json". Or, a well formed JSON object.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.tilemapTiledJSON</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66193</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="unityAtlas"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>unity<wbr/>Atlas</span><ahref="#unityAtlas"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="unityAtlas.unityAtlas-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">unity<wbr/>Atlas</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">textureURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">atlasURL</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">textureXhrSettings</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">atlasXhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#unityAtlas.unityAtlas-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Unity YAML based Texture Atlas, or array of atlases, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.UnityAtlasFileConfig</code> for more details.</p>
<p>Once the atlas has finished loading you can use frames from it as textures for a Game Object by referencing its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">unityAtlas</span><spanclass="hl-1">(</span><spanclass="hl-7">'mainmenu'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/MainMenu.png'</span><spanclass="hl-1">, </span><spanclass="hl-7">'images/MainMenu.json'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">add</span><spanclass="hl-1">.</span><spanclass="hl-6">image</span><spanclass="hl-1">(</span><spanclass="hl-2">x</span><spanclass="hl-1">, </span><spanclass="hl-2">y</span><spanclass="hl-1">, </span><spanclass="hl-7">'mainmenu'</span><spanclass="hl-1">, </span><spanclass="hl-7">'background'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>To get a list of all available frames within an atlas please consult your Texture Atlas software.</p>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>MENU.</code> and the key was <code>Background</code> the final key will be <code>MENU.Background</code> and
this is what you would use to retrieve the image from the Texture Manager.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "alien"
and no URL is given then the Loader will set the URL to be "alien.png". It will always add <code>.png</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Phaser also supports the automatic loading of associated normal maps. If you have a normal map to go with this image,
then you can specify it by providing an array as the <code>url</code> where the second element is the normal map:</p>
<p>The normal map file is subject to the same conditions as the image file with regard to the path, baseURL, CORs and XHR Settings.
Normal maps are a WebGL only feature.</p>
<p>Note: The ability to load this type of file will only be available if the Unity Atlas File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">UnityAtlasFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">UnityAtlasFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureURL</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the texture image file from. If undefined or <code>null</code> it will be set to <code><key>.png</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.png".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasURL</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the texture atlas data file from. If undefined or <code>null</code> it will be set to <code><key>.txt</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.txt".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">textureXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the atlas image file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">atlasXhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object for the atlas data file. Used in replacement of the Loaders default XHR Settings.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.unityAtlas</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66288</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="update"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>update</span><ahref="#update"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="update.update-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">update</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#update.update-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Called automatically during the load process.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.update</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66683</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="updateProgress"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>update<wbr/>Progress</span><ahref="#updateProgress"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="updateProgress.updateProgress-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">update<wbr/>Progress</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">void</span><ahref="#updateProgress.updateProgress-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Called automatically during the load process.
It updates the <code>progress</code> value and then emits a progress event, which you can use to
display a loading bar in your game.</p>
</div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">void</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.updateProgress</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66678</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="video"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>video</span><ahref="#video"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="video.video-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">video</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">urls</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">noAudio</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#video.video-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds a Video file, or array of video files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.VideoFileConfig</code> for more details.</p>
<p>The URLs can be relative or absolute. If the URLs are relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to them.</p>
<p>Due to different browsers supporting different video file types you should usually provide your video files in a variety of formats.
mp4, mov and webm are the most common. If you provide an array of URLs then the Loader will determine which <em>one</em> file to load based on
browser support, starting with the first in the array and progressing to the end.</p>
<p>Unlike most asset-types, videos do not <em>need</em> to be preloaded. You can create a Video Game Object and then call its <code>loadURL</code> method,
to load a video at run-time, rather than in advance.</p>
<p>Note: The ability to load this type of file will only be available if the Video File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">VideoFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">VideoFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">urls</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol">[]</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">VideoFileURLConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">VideoFileURLConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load the video files from.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">noAudio</span>: <spanclass="tsd-signature-type">boolean</span></span><divclass="tsd-comment tsd-typography"><p>Does the video have an audio track? If not you can enable auto-playing on it. Default false.</p>
</div><divclass="tsd-comment tsd-typography"></div></li></ul></div><h4class="tsd-returns-title">Returns <spanclass="tsd-signature-type">this</span></h4><divclass="tsd-comment tsd-typography"></div><asideclass="tsd-sources"><p>Inherited from Phaser.Loader.LoaderPlugin.video</p><ul><li>Defined in node_modules/phaser/types/phaser.d.ts:66342</li></ul></aside></li></ul></section><sectionclass="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><aid="xml"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>xml</span><ahref="#xml"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited tsd-is-external"><liclass="tsd-signature tsd-anchor-link"><aid="xml.xml-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">xml</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">key</span>, <spanclass="tsd-kind-parameter">url</span><spanclass="tsd-signature-symbol">?</span>, <spanclass="tsd-kind-parameter">xhrSettings</span><spanclass="tsd-signature-symbol">?</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><spanclass="tsd-signature-type">this</span><ahref="#xml.xml-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-comment tsd-typography"><p>Adds an XML file, or array of XML files, to the current load queue.</p>
<p>You can call this method from within your Scene's <code>preload</code>, along with any other files you wish to load:</p>
<p>See the documentation for <code>Phaser.Types.Loader.FileTypes.XMLFileConfig</code> for more details.</p>
<p>Once the file has finished loading you can access it from its Cache using its key:</p>
<pre><codeclass="language-javascript"><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">load</span><spanclass="hl-1">.</span><spanclass="hl-6">xml</span><spanclass="hl-1">(</span><spanclass="hl-7">'wavedata'</span><spanclass="hl-1">, </span><spanclass="hl-7">'files/AlienWaveData.xml'</span><spanclass="hl-1">);</span><br/><spanclass="hl-8">// and later in your game ...</span><br/><spanclass="hl-4">var</span><spanclass="hl-1"></span><spanclass="hl-2">data</span><spanclass="hl-1"> = </span><spanclass="hl-4">this</span><spanclass="hl-1">.</span><spanclass="hl-2">cache</span><spanclass="hl-1">.</span><spanclass="hl-2">xml</span><spanclass="hl-1">.</span><spanclass="hl-6">get</span><spanclass="hl-1">(</span><spanclass="hl-7">'wavedata'</span><spanclass="hl-1">);</span>
</code><button>Copy</button></pre>
<p>If you have specified a prefix in the loader, via <code>Loader.setPrefix</code> then this value will be prepended to this files
key. For example, if the prefix was <code>LEVEL1.</code> and the key was <code>Waves</code> the final key will be <code>LEVEL1.Waves</code> and
this is what you would use to retrieve the text from the XML Cache.</p>
<p>The URL can be relative or absolute. If the URL is relative the <code>Loader.baseURL</code> and <code>Loader.path</code> values will be prepended to it.</p>
<p>If the URL isn't specified the Loader will take the key and create a filename from that. For example if the key is "data"
and no URL is given then the Loader will set the URL to be "data.xml". It will always add <code>.xml</code> as the extension, although
this can be overridden if using an object instead of method arguments. If you do not desire this action then provide a URL.</p>
<p>Note: The ability to load this type of file will only be available if the XML File type has been built into Phaser.
It is available in the default build but can be excluded from custom builds.</p>
</div><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">key</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">XMLFileConfig</span><spanclass="tsd-signature-symbol"> | </span><spanclass="tsd-signature-type">XMLFileConfig</span><spanclass="tsd-signature-symbol">[]</span></span><divclass="tsd-comment tsd-typography"><p>The key to use for this file, or a file configuration object, or array of them.</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">url</span>: <spanclass="tsd-signature-type">string</span></span><divclass="tsd-comment tsd-typography"><p>The absolute or relative URL to load this file from. If undefined or <code>null</code> it will be set to <code><key>.xml</code>, i.e. if <code>key</code> was "alien" then the URL will be "alien.xml".</p>
</div><divclass="tsd-comment tsd-typography"></div></li><li><span><codeclass="tsd-tag ts-flagOptional">Optional</code><spanclass="tsd-kind-parameter">xhrSettings</span>: <spanclass="tsd-signature-type">XHRSettingsObject</span></span><divclass="tsd-comment tsd-typography"><p>An XHR Settings configuration object. Used in replacement of the Loaders default XHR Settings.</p>
