@megavr/ecsy-babylon

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>GameSystem | ecsy-babylon@0.0.10</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">ecsy-babylon@0.0.10</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="gamesystem.html">GameSystem</a> </li> </ul> <h1>Class GameSystem</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Core system of ecsy-babylon.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="tsd-signature-type">System</span> <ul class="tsd-hierarchy"> <li> <span class="target">GameSystem</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-external"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-external"><a href="gamesystem.html#_activescene" class="tsd-kind-icon">_active<wbr>Scene</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-external"><a href="gamesystem.html#_assetmanagers" class="tsd-kind-icon">_asset<wbr>Managers</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-external"><a href="gamesystem.html#_engine" class="tsd-kind-icon">_engine</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="gamesystem.html#enabled" class="tsd-kind-icon">enabled</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="gamesystem.html#onsceneswitched" class="tsd-kind-icon">on<wbr>Scene<wbr>Switched</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="gamesystem.html#activescene" class="tsd-kind-icon">active<wbr>Scene</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="gamesystem.html#renderingcanvas" class="tsd-kind-icon">rendering<wbr>Canvas</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="gamesystem.html#scenes" class="tsd-kind-icon">scenes</a></li> </ul> </section> <section class="tsd-index-section tsd-is-external"> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"><a href="gamesystem.html#_render" class="tsd-kind-icon">_render</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"><a href="gamesystem.html#_updatecolor" class="tsd-kind-icon">_update<wbr>Color</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"><a href="gamesystem.html#_updatescene" class="tsd-kind-icon">_update<wbr>Scene</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="gamesystem.html#getassetmanager" class="tsd-kind-icon">get<wbr>Asset<wbr>Manager</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="gamesystem.html#play" class="tsd-kind-icon">play</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="gamesystem.html#start" class="tsd-kind-icon">start</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="gamesystem.html#stop" class="tsd-kind-icon">stop</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="gamesystem.html#switchscene" class="tsd-kind-icon">switch<wbr>Scene</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-external"> <a name="_activescene" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _active<wbr>Scene</h3> <div class="tsd-signature tsd-kind-icon">_active<wbr>Scene<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Scene</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L25">src/systems/GameSystem.ts:25</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-external"> <a name="_assetmanagers" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _asset<wbr>Managers</h3> <div class="tsd-signature tsd-kind-icon">_asset<wbr>Managers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">String</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">AssetsManager</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new Map<String, BABYLON.AssetsManager>()</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L30">src/systems/GameSystem.ts:30</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p><Scene UID, BABYLON.AssetsManager></p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-external"> <a name="_engine" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _engine</h3> <div class="tsd-signature tsd-kind-icon">_engine<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Engine</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L19">src/systems/GameSystem.ts:19</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="enabled" class="tsd-anchor"></a> <h3>enabled</h3> <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <p>Inherited from System.enabled</p> <ul> <li>Defined in node_modules/ecsy/src/System.d.ts:10</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether the system will execute during the world tick.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a name="onsceneswitched" class="tsd-anchor"></a> <h3>on<wbr>Scene<wbr>Switched</h3> <div class="tsd-signature tsd-kind-icon">on<wbr>Scene<wbr>Switched<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Observable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Scene</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new BABYLON.Observable<BABYLON.Scene>()</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L33">src/systems/GameSystem.ts:33</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Observable event when active scene is switched.</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <a name="activescene" class="tsd-anchor"></a> <h3>active<wbr>Scene</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> activeScene<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Scene</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L27">src/systems/GameSystem.ts:27</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get active scene.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Scene</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <a name="renderingcanvas" class="tsd-anchor"></a> <h3>rendering<wbr>Canvas</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> renderingCanvas<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLCanvasElement</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L21">src/systems/GameSystem.ts:21</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get canvas used for rendering.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">HTMLCanvasElement</span> </h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <a name="scenes" class="tsd-anchor"></a> <h3>scenes</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> scenes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Scene</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L23">src/systems/GameSystem.ts:23</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get all scenes in engine.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Scene</span><span class="tsd-signature-symbol">[]</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"> <a name="_render" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _render</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"> <li class="tsd-signature tsd-kind-icon">_render<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L129">src/systems/GameSystem.ts:129</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"> <a name="_updatecolor" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _update<wbr>Color</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"> <li class="tsd-signature tsd-kind-icon">_update<wbr>Color<span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><a href="scene.html" class="tsd-signature-type">Scene</a>, color<span class="tsd-signature-symbol">: </span><a href="../interfaces/scenecolorproperties.html" class="tsd-signature-type">SceneColorProperties</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L80">src/systems/GameSystem.ts:80</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>scene: <a href="scene.html" class="tsd-signature-type">Scene</a></h5> </li> <li> <h5>color: <a href="../interfaces/scenecolorproperties.html" class="tsd-signature-type">SceneColorProperties</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"> <a name="_updatescene" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _update<wbr>Scene</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"> <li class="tsd-signature tsd-kind-icon">_update<wbr>Scene<span class="tsd-signature-symbol">(</span>entity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Entity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L63">src/systems/GameSystem.ts:63</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>entity: <span class="tsd-signature-type">Entity</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="getassetmanager" class="tsd-anchor"></a> <h3>get<wbr>Asset<wbr>Manager</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">get<wbr>Asset<wbr>Manager<span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Entity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AssetsManager</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L121">src/systems/GameSystem.ts:121</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get scene AssetManager or return AssetManager in active scene.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> scene: <span class="tsd-signature-type">Entity</span></h5> <div class="tsd-comment tsd-typography"> <p>Scene entity</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AssetsManager</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="play" class="tsd-anchor"></a> <h3>play</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <li class="tsd-signature tsd-kind-icon">play<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from System.play</p> <ul> <li>Defined in node_modules/ecsy/src/System.d.ts:14</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Resume execution of this system.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="start" class="tsd-anchor"></a> <h3>start</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span>canvas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLCanvasElement</span>, antialias<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BABYLON.EngineOptions</span>, adaptToDeviceRatio<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="gamesystem.html" class="tsd-signature-type">GameSystem</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L101">src/systems/GameSystem.ts:101</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Start game system in the world can be used by other systems & components.</p> </div> <dl class="tsd-comment-tags"> <dt>see</dt> <dd><p><a href="https://doc.babylonjs.com/api/classes/babylon.engine#constructor">https://doc.babylonjs.com/api/classes/babylon.engine#constructor</a></p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>canvas: <span class="tsd-signature-type">HTMLCanvasElement</span></h5> <div class="tsd-comment tsd-typography"> <p>WebGL context to be used for rendering</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> antialias: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5> <div class="tsd-comment tsd-typography"> <p>defines enable antialiasing (default: false)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">BABYLON.EngineOptions</span></h5> <div class="tsd-comment tsd-typography"> <p>@see <a href="https://doc.babylonjs.com/api/interfaces/babylon.engineoptions">https://doc.babylonjs.com/api/interfaces/babylon.engineoptions</a></p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> adaptToDeviceRatio: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5> <div class="tsd-comment tsd-typography"> <p>defines whether to adapt to the device's viewport characteristics (default: false)</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="gamesystem.html" class="tsd-signature-type">GameSystem</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a name="stop" class="tsd-anchor"></a> <h3>stop</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from System.stop</p> <ul> <li>Defined in node_modules/ecsy/src/System.d.ts:19</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Stop execution of this system.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a name="switchscene" class="tsd-anchor"></a> <h3>switch<wbr>Scene</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"> <li class="tsd-signature tsd-kind-icon">switch<wbr>Scene<span class="tsd-signature-symbol">(</span>scene<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Entity</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="gamesystem.html" class="tsd-signature-type">GameSystem</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/megavr/ecsy-babylon/blob/920ca10/src/systems/GameSystem.ts#L111">src/systems/GameSystem.ts:111</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Switch to a scene by given scene entity.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>scene: <span class="tsd-signature-type">Entity</span></h5> <div class="tsd-comment tsd-typography"> <p>Scene entity</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="gamesystem.html" class="tsd-signature-type">GameSystem</a></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-is-external"> <a href="gamesystem.html" class="tsd-kind-icon">Game<wbr>System</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-external"> <a href="gamesystem.html#_activescene" class="tsd-kind-icon">_active<wbr>Scene</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-external"> <a href="gamesystem.html#_assetmanagers" class="tsd-kind-icon">_asset<wbr>Managers</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-external"> <a href="gamesystem.html#_engine" class="tsd-kind-icon">_engine</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a href="gamesystem.html#enabled" class="tsd-kind-icon">enabled</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external"> <a href="gamesystem.html#onsceneswitched" class="tsd-kind-icon">on<wbr>Scene<wbr>Switched</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <a href="gamesystem.html#activescene" class="tsd-kind-icon">active<wbr>Scene</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <a href="gamesystem.html#renderingcanvas" class="tsd-kind-icon">rendering<wbr>Canvas</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"> <a href="gamesystem.html#scenes" class="tsd-kind-icon">scenes</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"> <a href="gamesystem.html#_render" class="tsd-kind-icon">_render</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"> <a href="gamesystem.html#_updatecolor" class="tsd-kind-icon">_update<wbr>Color</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-external"> <a href="gamesystem.html#_updatescene" class="tsd-kind-icon">_update<wbr>Scene</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="gamesystem.html#getassetmanager" class="tsd-kind-icon">get<wbr>Asset<wbr>Manager</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a href="gamesystem.html#play" class="tsd-kind-icon">play</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="gamesystem.html#start" class="tsd-kind-icon">start</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"> <a href="gamesystem.html#stop" class="tsd-kind-icon">stop</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external"> <a href="gamesystem.html#switchscene" class="tsd-kind-icon">switch<wbr>Scene</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>