Files
esengine/source/docs/classes/_graphics_transitions_fadetransition_.es.fadetransition.html

579 lines
37 KiB
HTML
Raw Normal View History

2020-11-20 14:07:34 +08:00
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FadeTransition | @esengine/egret-framework</title>
<meta name="description" content="Documentation for @esengine/egret-framework">
<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.json" 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">@esengine/egret-framework</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="../modules/_graphics_transitions_fadetransition_.html">&quot;Graphics/Transitions/FadeTransition&quot;</a>
</li>
<li>
<a href="../modules/_graphics_transitions_fadetransition_.es.html">es</a>
</li>
<li>
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html">FadeTransition</a>
</li>
</ul>
<h1>Class FadeTransition</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="_graphics_transitions_scenetransition_.es.scenetransition.html" class="tsd-signature-type">SceneTransition</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FadeTransition</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 ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="_graphics_transitions_fadetransition_.es.fadetransition.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-private"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#_alpha" class="tsd-kind-icon">_alpha</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#_mask" class="tsd-kind-icon">_mask</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#delaybeforefadeinduration" class="tsd-kind-icon">delay<wbr>Before<wbr>Fade<wbr>InDuration</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#fadeeasetype" class="tsd-kind-icon">fade<wbr>Ease<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#fadeoutduration" class="tsd-kind-icon">fade<wbr>Out<wbr>Duration</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#fadetocolor" class="tsd-kind-icon">fade<wbr>ToColor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#isnewsceneloaded" class="tsd-kind-icon">is<wbr>New<wbr>Scene<wbr>Loaded</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#loadsnewscene" class="tsd-kind-icon">loads<wbr>New<wbr>Scene</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#onscreenobscured" class="tsd-kind-icon">on<wbr>Screen<wbr>Obscured</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#ontransitioncompleted" class="tsd-kind-icon">on<wbr>Transition<wbr>Completed</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#sceneloadaction" class="tsd-kind-icon">scene<wbr>Load<wbr>Action</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#haspreviousscenerender" class="tsd-kind-icon">has<wbr>Previous<wbr>Scene<wbr>Render</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-inherited tsd-is-protected"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#loadnextscene" class="tsd-kind-icon">load<wbr>Next<wbr>Scene</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#onbegintransition" class="tsd-kind-icon">on<wbr>Begin<wbr>Transition</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#prerender" class="tsd-kind-icon">pre<wbr>Render</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#render" class="tsd-kind-icon">render</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#tickeffectprogressproperty" class="tsd-kind-icon">tick<wbr>Effect<wbr>Progress<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_graphics_transitions_fadetransition_.es.fadetransition.html#transitioncomplete" class="tsd-kind-icon">transition<wbr>Complete</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 tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Fade<wbr>Transition<span class="tsd-signature-symbol">(</span>sceneLoadAction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_graphics_transitions_fadetransition_.es.fadetransition.html" class="tsd-signature-type">FadeTransition</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L9">src/Graphics/Transitions/FadeTransition.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>sceneLoadAction: <span class="tsd-signature-type">Function</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_graphics_transitions_fadetransition_.es.fadetransition.html" class="tsd-signature-type">FadeTransition</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-private">
<a name="_alpha" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _alpha</h3>
<div class="tsd-signature tsd-kind-icon">_alpha<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L9">src/Graphics/Transitions/FadeTransition.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_mask" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _mask</h3>
<div class="tsd-signature tsd-kind-icon">_mask<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Shape</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L8">src/Graphics/Transitions/FadeTransition.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="delaybeforefadeinduration" class="tsd-anchor"></a>
<h3>delay<wbr>Before<wbr>Fade<wbr>InDuration</h3>
<div class="tsd-signature tsd-kind-icon">delay<wbr>Before<wbr>Fade<wbr>InDuration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L7">src/Graphics/Transitions/FadeTransition.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fadeeasetype" class="tsd-anchor"></a>
<h3>fade<wbr>Ease<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">fade<wbr>Ease<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> = egret.Ease.quadInOut</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L6">src/Graphics/Transitions/FadeTransition.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fadeoutduration" class="tsd-anchor"></a>
<h3>fade<wbr>Out<wbr>Duration</h3>
<div class="tsd-signature tsd-kind-icon">fade<wbr>Out<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.4</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L5">src/Graphics/Transitions/FadeTransition.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="fadetocolor" class="tsd-anchor"></a>
<h3>fade<wbr>ToColor</h3>
<div class="tsd-signature tsd-kind-icon">fade<wbr>ToColor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L4">src/Graphics/Transitions/FadeTransition.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="isnewsceneloaded" class="tsd-anchor"></a>
<h3>is<wbr>New<wbr>Scene<wbr>Loaded</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>New<wbr>Scene<wbr>Loaded<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#isnewsceneloaded">isNewSceneLoaded</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/SceneTransition.ts#L12">src/Graphics/Transitions/SceneTransition.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>将此用于两个部分的转换。例如淡出会先淡出到黑色然后当isNewSceneLoaded为true它会淡出。
对于场景过渡isNewSceneLoaded应该在中点设置为true这就标识一个新的场景被加载了。</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="loadsnewscene" class="tsd-anchor"></a>
<h3>loads<wbr>New<wbr>Scene</h3>
<div class="tsd-signature tsd-kind-icon">loads<wbr>New<wbr>Scene<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#loadsnewscene">loadsNewScene</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/SceneTransition.ts#L7">src/Graphics/Transitions/SceneTransition.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>是否加载新场景的标志</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="onscreenobscured" class="tsd-anchor"></a>
<h3>on<wbr>Screen<wbr>Obscured</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Screen<wbr>Obscured<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#onscreenobscured">onScreenObscured</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/SceneTransition.ts#L14">src/Graphics/Transitions/SceneTransition.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>在loadNextScene执行时调用。这在进行场景间过渡时很有用这样你就知道什么时候可以更多地使用相机或者重置任何实体</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="ontransitioncompleted" class="tsd-anchor"></a>
<h3>on<wbr>Transition<wbr>Completed</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Transition<wbr>Completed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#ontransitioncompleted">onTransitionCompleted</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/SceneTransition.ts#L16">src/Graphics/Transitions/SceneTransition.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>当转换完成执行时调用,以便可以调用其他工作,比如启动另一个转换。</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="sceneloadaction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> scene<wbr>Load<wbr>Action</h3>
<div class="tsd-signature tsd-kind-icon">scene<wbr>Load<wbr>Action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#sceneloadaction">sceneLoadAction</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/SceneTransition.ts#L18">src/Graphics/Transitions/SceneTransition.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>返回新加载场景的函数</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="haspreviousscenerender" class="tsd-anchor"></a>
<h3>has<wbr>Previous<wbr>Scene<wbr>Render</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> hasPreviousSceneRender<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#haspreviousscenerender">hasPreviousSceneRender</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/SceneTransition.ts#L27">src/Graphics/Transitions/SceneTransition.ts:27</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</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-inherited tsd-is-protected">
<a name="loadnextscene" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> load<wbr>Next<wbr>Scene</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">load<wbr>Next<wbr>Scene<span class="tsd-signature-symbol">(</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#loadnextscene">loadNextScene</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/SceneTransition.ts#L67">src/Graphics/Transitions/SceneTransition.ts:67</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="onbegintransition" class="tsd-anchor"></a>
<h3>on<wbr>Begin<wbr>Transition</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">on<wbr>Begin<wbr>Transition<span class="tsd-signature-symbol">(</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#onbegintransition">onBeginTransition</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L16">src/Graphics/Transitions/FadeTransition.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="prerender" class="tsd-anchor"></a>
<h3>pre<wbr>Render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">pre<wbr>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">
<p>Inherited from <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#prerender">preRender</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/SceneTransition.ts#L36">src/Graphics/Transitions/SceneTransition.ts:36</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-overwrite">
<a name="render" class="tsd-anchor"></a>
<h3>render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<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">
<p>Overrides <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#render">render</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L41">src/Graphics/Transitions/FadeTransition.ts:41</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-inherited">
<a name="tickeffectprogressproperty" class="tsd-anchor"></a>
<h3>tick<wbr>Effect<wbr>Progress<wbr>Property</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">tick<wbr>Effect<wbr>Progress<wbr>Property<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CustomFilter</span>, duration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, easeType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span>, reverseDirection<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#tickeffectprogressproperty">tickEffectProgressProperty</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/SceneTransition.ts#L48">src/Graphics/Transitions/SceneTransition.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filter: <span class="tsd-signature-type">CustomFilter</span></h5>
</li>
<li>
<h5>duration: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>easeType: <span class="tsd-signature-type">Function</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> reverseDirection: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<a name="transitioncomplete" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> transition<wbr>Complete</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">transition<wbr>Complete<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>Overrides <a href="_graphics_transitions_scenetransition_.es.scenetransition.html">SceneTransition</a>.<a href="_graphics_transitions_scenetransition_.es.scenetransition.html#transitioncomplete">transitionComplete</a></p>
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/Graphics/Transitions/FadeTransition.ts#L34">src/Graphics/Transitions/FadeTransition.ts:34</a></li>
</ul>
</aside>
<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="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_graphics_transitions_fadetransition_.html">&quot;<wbr>Graphics/<wbr>Transitions/<wbr>Fade<wbr>Transition&quot;</a>
<ul>
<li class="current tsd-kind-namespace tsd-parent-kind-module">
<a href="../modules/_graphics_transitions_fadetransition_.es.html">es</a>
</li>
</ul>
</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-parent-kind-namespace">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html" class="tsd-kind-icon">Fade<wbr>Transition</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#_alpha" class="tsd-kind-icon">_alpha</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#_mask" class="tsd-kind-icon">_mask</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#delaybeforefadeinduration" class="tsd-kind-icon">delay<wbr>Before<wbr>Fade<wbr>InDuration</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#fadeeasetype" class="tsd-kind-icon">fade<wbr>Ease<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#fadeoutduration" class="tsd-kind-icon">fade<wbr>Out<wbr>Duration</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#fadetocolor" class="tsd-kind-icon">fade<wbr>ToColor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#isnewsceneloaded" class="tsd-kind-icon">is<wbr>New<wbr>Scene<wbr>Loaded</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#loadsnewscene" class="tsd-kind-icon">loads<wbr>New<wbr>Scene</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#onscreenobscured" class="tsd-kind-icon">on<wbr>Screen<wbr>Obscured</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#ontransitioncompleted" class="tsd-kind-icon">on<wbr>Transition<wbr>Completed</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#sceneloadaction" class="tsd-kind-icon">scene<wbr>Load<wbr>Action</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#haspreviousscenerender" class="tsd-kind-icon">has<wbr>Previous<wbr>Scene<wbr>Render</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#loadnextscene" class="tsd-kind-icon">load<wbr>Next<wbr>Scene</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#onbegintransition" class="tsd-kind-icon">on<wbr>Begin<wbr>Transition</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#prerender" class="tsd-kind-icon">pre<wbr>Render</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#render" class="tsd-kind-icon">render</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#tickeffectprogressproperty" class="tsd-kind-icon">tick<wbr>Effect<wbr>Progress<wbr>Property</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<a href="_graphics_transitions_fadetransition_.es.fadetransition.html#transitioncomplete" class="tsd-kind-icon">transition<wbr>Complete</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-class"><span class="tsd-kind-icon">Class</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>
</ul>
<ul class="tsd-legend">
<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>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</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>
</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>