duckengine
Version:
A 2D Game Engine for the web.
51 lines • 44.1 kB
HTML
<html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Cutscene | DuckEngine - v2.1.0</title><meta name="description" content="Documentation for DuckEngine - v2.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">DuckEngine - v2.1.0</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></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="../modules.html">DuckEngine - v2.1.0</a></li><li><a href="../modules/core_cutscene_cutscene.html">core/cutscene/cutscene</a></li><li><a href="core_cutscene_cutscene.Cutscene.html">Cutscene</a></li></ul><h1>Class Cutscene</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"><dl class="tsd-comment-tags"><dt>classdesc</dt><dd><p>Creates a DuckEngine Cutscene</p>
</dd><dt>description</dt><dd><p>The Cutscene Class. Create a cutscene</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Cutscene</span></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 "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#camera" class="tsd-kind-icon">camera</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#config" class="tsd-kind-icon">config</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#game" class="tsd-kind-icon">game</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#instructions" class="tsd-kind-icon">instructions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#mainObject" class="tsd-kind-icon">main<wbr/>Object</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#otherCameras" class="tsd-kind-icon">other<wbr/>Cameras</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#otherObjects" class="tsd-kind-icon">other<wbr/>Objects</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#running" class="tsd-kind-icon">running</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#steps" class="tsd-kind-icon">steps</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#next" class="tsd-kind-icon">next</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#sleep" class="tsd-kind-icon">sleep</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#stop" class="tsd-kind-icon">stop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#update" class="tsd-kind-icon">update</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Cutscene<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.html" class="tsd-signature-type" data-tsd-kind="Namespace">Types</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Cutscene.html" class="tsd-signature-type" data-tsd-kind="Namespace">Cutscene</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/index.Duck.Types.Cutscene.Config.html" class="tsd-signature-type" data-tsd-kind="Interface">Config</a>, instructions<span class="tsd-signature-symbol">: </span><a href="../interfaces/index.Duck.Types.Cutscene.Instructions.html" class="tsd-signature-type" data-tsd-kind="Interface">Instructions</a>, game<span class="tsd-signature-symbol">: </span><a href="core_game.Game.html" class="tsd-signature-type" data-tsd-kind="Class">Game</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="core_cutscene_cutscene.Cutscene.html" class="tsd-signature-type" data-tsd-kind="Class">Cutscene</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L52">core/cutscene/cutscene.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>description</dt><dd><p>Creates an instance of a Cutscene.</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>config: <a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.html" class="tsd-signature-type" data-tsd-kind="Namespace">Types</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Cutscene.html" class="tsd-signature-type" data-tsd-kind="Namespace">Cutscene</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/index.Duck.Types.Cutscene.Config.html" class="tsd-signature-type" data-tsd-kind="Interface">Config</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Configuration</p>
</div></div></li><li><h5>instructions: <a href="../interfaces/index.Duck.Types.Cutscene.Instructions.html" class="tsd-signature-type" data-tsd-kind="Interface">Instructions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Cutscene instructions</p>
</div></div></li><li><h5>game: <a href="core_game.Game.html" class="tsd-signature-type" data-tsd-kind="Class">Game</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="core_cutscene_cutscene.Cutscene.html" class="tsd-signature-type" data-tsd-kind="Class">Cutscene</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="camera" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> camera</h3><div class="tsd-signature tsd-kind-icon">camera<span class="tsd-signature-symbol">:</span> <a href="core_camera_camera.Camera.html" class="tsd-signature-type" data-tsd-kind="Class">Camera</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L27">core/cutscene/cutscene.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="config" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> config</h3><div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.html" class="tsd-signature-type" data-tsd-kind="Namespace">Types</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Cutscene.html" class="tsd-signature-type" data-tsd-kind="Namespace">Cutscene</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/index.Duck.Types.Cutscene.Config.html" class="tsd-signature-type" data-tsd-kind="Interface">Config</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L14">core/cutscene/cutscene.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="game" class="tsd-anchor"></a><h3>game</h3><div class="tsd-signature tsd-kind-icon">game<span class="tsd-signature-symbol">:</span> <a href="core_game.Game.html" class="tsd-signature-type" data-tsd-kind="Class">Game</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L22">core/cutscene/cutscene.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>Game instance</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="index" class="tsd-anchor"></a><h3>index</h3><div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L35">core/cutscene/cutscene.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>The index of the current cutscene step</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="instructions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> instructions</h3><div class="tsd-signature tsd-kind-icon">instructions<span class="tsd-signature-symbol">:</span> <a href="../interfaces/index.Duck.Types.Cutscene.Instructions.html" class="tsd-signature-type" data-tsd-kind="Interface">Instructions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L15">core/cutscene/cutscene.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="mainObject" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> main<wbr/>Object</h3><div class="tsd-signature tsd-kind-icon">main<wbr/>Object<span class="tsd-signature-symbol">:</span> <a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.TypeClasses.html" class="tsd-signature-type" data-tsd-kind="Namespace">TypeClasses</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.TypeClasses.GameObjects.html" class="tsd-signature-type" data-tsd-kind="Namespace">GameObjects</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.TypeClasses.GameObjects.html#GameObject" class="tsd-signature-type" data-tsd-kind="Type alias">GameObject</a><span class="tsd-signature-symbol"><</span><a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.html" class="tsd-signature-type" data-tsd-kind="Namespace">Types</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Texture.html" class="tsd-signature-type" data-tsd-kind="Namespace">Texture</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Texture.html#Type" class="tsd-signature-type" data-tsd-kind="Type alias">Type</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L25">core/cutscene/cutscene.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="otherCameras" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> other<wbr/>Cameras</h3><div class="tsd-signature tsd-kind-icon">other<wbr/>Cameras<span class="tsd-signature-symbol">:</span> <a href="core_camera_camera.Camera.html" class="tsd-signature-type" data-tsd-kind="Class">Camera</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L28">core/cutscene/cutscene.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="otherObjects" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> other<wbr/>Objects</h3><div class="tsd-signature tsd-kind-icon">other<wbr/>Objects<span class="tsd-signature-symbol">:</span> <a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.TypeClasses.html" class="tsd-signature-type" data-tsd-kind="Namespace">TypeClasses</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.TypeClasses.GameObjects.html" class="tsd-signature-type" data-tsd-kind="Namespace">GameObjects</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.TypeClasses.GameObjects.html#GameObject" class="tsd-signature-type" data-tsd-kind="Type alias">GameObject</a><span class="tsd-signature-symbol"><</span><a href="../modules/index.Duck.html" class="tsd-signature-type" data-tsd-kind="Namespace">Duck</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.html" class="tsd-signature-type" data-tsd-kind="Namespace">Types</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Texture.html" class="tsd-signature-type" data-tsd-kind="Namespace">Texture</a><span class="tsd-signature-symbol">.</span><a href="../modules/index.Duck.Types.Texture.html#Type" class="tsd-signature-type" data-tsd-kind="Type alias">Type</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L26">core/cutscene/cutscene.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="running" class="tsd-anchor"></a><h3>running</h3><div class="tsd-signature tsd-kind-icon">running<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L42">core/cutscene/cutscene.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>The state of the Cutscene running</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="steps" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> steps</h3><div class="tsd-signature tsd-kind-icon">steps<span class="tsd-signature-symbol">:</span> <a href="../interfaces/index.Duck.Types.Cutscene.Step.html" class="tsd-signature-type" data-tsd-kind="Interface">Step</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L24">core/cutscene/cutscene.ts:24</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="init" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagProtected">Protected</span> init</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"><li class="tsd-signature tsd-kind-icon">init<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/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L74">core/cutscene/cutscene.ts:74</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"><a id="next" class="tsd-anchor"></a><h3>next</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">next<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/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L275">core/cutscene/cutscene.ts:275</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>Starts the next step</p>
</dd><dt>emits</dt><dd><p>EVENTS.CUTSCENE.NEXT</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></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"><a id="off" class="tsd-anchor"></a><h3>off</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules/index.Duck.Types.Cutscene.html#OnListenerType" class="tsd-signature-type" data-tsd-kind="Type alias">OnListenerType</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/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L315">core/cutscene/cutscene.ts:315</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>Removes an event listener from Cutscene</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <a href="../modules/index.Duck.Types.Cutscene.html#OnListenerType" class="tsd-signature-type" data-tsd-kind="Type alias">OnListenerType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Listener type</p>
</div></div></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"><a id="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../modules/index.Duck.Types.Cutscene.html#OnListenerType" class="tsd-signature-type" data-tsd-kind="Type alias">OnListenerType</a>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</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/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L301">core/cutscene/cutscene.ts:301</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>Adds an event listener to Cutscene</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>type: <a href="../modules/index.Duck.Types.Cutscene.html#OnListenerType" class="tsd-signature-type" data-tsd-kind="Type alias">OnListenerType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Listener type</p>
</div></div></li><li><h5>cb: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Callback function</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></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"><a id="sleep" class="tsd-anchor"></a><h3>sleep</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">sleep<span class="tsd-signature-symbol">(</span>ms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</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/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L290">core/cutscene/cutscene.ts:290</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>Sleeps/Waits for a duration</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>ms: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>Duration in millisecond</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="start" class="tsd-anchor"></a><h3>start</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">start<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/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L92">core/cutscene/cutscene.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>Starts the cutscene</p>
</dd><dt>emits</dt><dd><p>EVENTS.CUTSCENE.START</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></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"><a id="stop" class="tsd-anchor"></a><h3>stop</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><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"><ul><li>Defined in <a href="https://github.com/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L104">core/cutscene/cutscene.ts:104</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>Stops the cutscene</p>
</dd><dt>emits</dt><dd><p>EVENTS.CUTSCENE.END</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></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"><a id="update" class="tsd-anchor"></a><h3>update</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<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/ksplatdev/DuckEngine/blob/717462d/src/core/cutscene/cutscene.ts#L115">core/cutscene/cutscene.ts:115</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>memberof</dt><dd><p>Cutscene</p>
</dd><dt>description</dt><dd><p>Updates the cutscene, must be in a loop or interval and come before Cutscene.next()</p>
</dd><dt>since</dt><dd><p>1.0.0-beta</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></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=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animation.html">core/animation/animation</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animationFrame.html">core/animation/animation<wbr/>Frame</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animationManager.html">core/animation/animation<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_animationState.html">core/animation/animation<wbr/>State</a></li><li class=" tsd-kind-module"><a href="../modules/core_animation_stateMachine.html">core/animation/state<wbr/>Machine</a></li><li class=" tsd-kind-module"><a href="../modules/core_camera_camera.html">core/camera/camera</a></li><li class="current tsd-kind-module"><a href="../modules/core_cutscene_cutscene.html">core/cutscene/cutscene</a></li><li class=" tsd-kind-module"><a href="../modules/core_debug_debug.html">core/debug/debug</a></li><li class=" tsd-kind-module"><a href="../modules/core_display_displayManager.html">core/display/display<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_effect_effect.html">core/effect/effect</a></li><li class=" tsd-kind-module"><a href="../modules/core_effect_preset_explosion.html">core/effect/preset/explosion</a></li><li class=" tsd-kind-module"><a href="../modules/core_effect_preset_smoke.html">core/effect/preset/smoke</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_eventEmitter.html">core/events/event<wbr/>Emitter</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_events.html">core/events/events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_main_displayEvents.html">core/events/main/display<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_main_gameEvents.html">core/events/main/game<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_main_rendererEvents.html">core/events/main/renderer<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_other_buttonEvents.html">core/events/other/button<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_other_cutsceneEvents.html">core/events/other/cutscene<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_events_other_groupEvents.html">core/events/other/group<wbr/>Events</a></li><li class=" tsd-kind-module"><a href="../modules/core_game.html">core/game</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_circle.html">core/gameobjects/circle</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_gameObject.html">core/gameobjects/game<wbr/>Object</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_misc_canvasModulate.html">core/gameobjects/misc/canvas<wbr/>Modulate</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_particles_particle.html">core/gameobjects/particles/particle</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_particles_particleEmitter.html">core/gameobjects/particles/particle<wbr/>Emitter</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_rect.html">core/gameobjects/rect</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_roundrect.html">core/gameobjects/roundrect</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_sprite.html">core/gameobjects/sprite</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_button.html">core/gameobjects/ui/button</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_imageRect.html">core/gameobjects/ui/image<wbr/>Rect</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_panel.html">core/gameobjects/ui/panel</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_text.html">core/gameobjects/ui/text</a></li><li class=" tsd-kind-module"><a href="../modules/core_gameobjects_ui_ui.html">core/gameobjects/ui/ui</a></li><li class=" tsd-kind-module"><a href="../modules/core_group_group.html">core/group/group</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_input.html">core/input/input</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_keyboardInput.html">core/input/keyboard<wbr/>Input</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_models_key.html">core/input/models/key</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_models_mouse.html">core/input/models/mouse</a></li><li class=" tsd-kind-module"><a href="../modules/core_input_mouseInput.html">core/input/mouse<wbr/>Input</a></li><li class=" tsd-kind-module"><a href="../modules/core_lights_staticLight.html">core/lights/static<wbr/>Light</a></li><li class=" tsd-kind-module"><a href="../modules/core_loader_loader.html">core/loader/loader</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_map.html">core/map/map</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tile.html">core/map/tile</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tilelayer.html">core/map/tilelayer</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tilemap.html">core/map/tilemap</a></li><li class=" tsd-kind-module"><a href="../modules/core_map_tileset.html">core/map/tileset</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_clamp.html">core/math/clamp</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_lerp.html">core/math/lerp</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_randomFloat.html">core/math/random<wbr/>Float</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_randomInt.html">core/math/random<wbr/>Int</a></li><li class=" tsd-kind-module"><a href="../modules/core_math_vector2.html">core/math/vector2</a></li><li class=" tsd-kind-module"><a href="../modules/core_misc_pluginManager.html">core/misc/plugin<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_models_displayList.html">core/models/display<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/core_models_physicsList.html">core/models/physics<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_models_area.html">core/physics/models/area</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_models_collider.html">core/physics/models/collider</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_models_hitbox.html">core/physics/models/hitbox</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_physicsBody.html">core/physics/physics<wbr/>Body</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_server_physicsServer.html">core/physics/server/physics<wbr/>Server</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_utils_circleToRectIntersect.html">core/physics/utils/circle<wbr/>To<wbr/>Rect<wbr/>Intersect</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_utils_hitboxFaceIntersect.html">core/physics/utils/hitbox<wbr/>Face<wbr/>Intersect</a></li><li class=" tsd-kind-module"><a href="../modules/core_physics_utils_rectToRectIntersect.html">core/physics/utils/rect<wbr/>To<wbr/>Rect<wbr/>Intersect</a></li><li class=" tsd-kind-module"><a href="../modules/core_renderer_baseRenderer.html">core/renderer/base<wbr/>Renderer</a></li><li class=" tsd-kind-module"><a href="../modules/core_renderer_canvas_canvasRenderer.html">core/renderer/canvas/canvas<wbr/>Renderer</a></li><li class=" tsd-kind-module"><a href="../modules/core_renderer_canvas_const_blendModes.html">core/renderer/canvas/const/blend<wbr/>Modes</a></li><li class=" tsd-kind-module"><a href="../modules/core_renderer_canvas_pipeline_rendererPipeline.html">core/renderer/canvas/pipeline/renderer<wbr/>Pipeline</a></li><li class=" tsd-kind-module"><a href="../modules/core_scene.html">core/scene</a></li><li class=" tsd-kind-module"><a href="../modules/core_sound_soundPlayer.html">core/sound/sound<wbr/>Player</a></li><li class=" tsd-kind-module"><a href="../modules/core_storage_cacheManager.html">core/storage/cache<wbr/>Manager</a></li><li class=" tsd-kind-module"><a href="../modules/core_texture_texture.html">core/texture/texture</a></li><li class=" tsd-kind-module"><a href="../modules/core_texture_textureAtlas.html">core/texture/texture<wbr/>Atlas</a></li><li class=" tsd-kind-module"><a href="../modules/core_texture_textureBase.html">core/texture/texture<wbr/>Base</a></li><li class=" tsd-kind-module"><a href="../modules/core_texture_textureSheet.html">core/texture/texture<wbr/>Sheet</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="core_cutscene_cutscene.Cutscene.html" class="tsd-kind-icon">Cutscene</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#camera" class="tsd-kind-icon">camera</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#config" class="tsd-kind-icon">config</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#game" class="tsd-kind-icon">game</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#index" class="tsd-kind-icon">index</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#instructions" class="tsd-kind-icon">instructions</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#mainObject" class="tsd-kind-icon">main<wbr/>Object</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#otherCameras" class="tsd-kind-icon">other<wbr/>Cameras</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#otherObjects" class="tsd-kind-icon">other<wbr/>Objects</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#running" class="tsd-kind-icon">running</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#steps" class="tsd-kind-icon">steps</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="core_cutscene_cutscene.Cutscene.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#next" class="tsd-kind-icon">next</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#sleep" class="tsd-kind-icon">sleep</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#start" class="tsd-kind-icon">start</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#stop" class="tsd-kind-icon">stop</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="core_cutscene_cutscene.Cutscene.html#update" class="tsd-kind-icon">update</a></li></ul></li></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-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></ul><ul class="tsd-legend"><li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</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></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></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></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/main.js"></script></body></html>