starling-framework
Version:
A fast, productive library for 2D cross-platform development.
780 lines • 142 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Tween | starling-framework</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">starling-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="../index.html">starling</a>
</li>
<li>
<a href="../modules/starling.animation.html">animation</a>
</li>
<li>
<a href="starling.animation.tween.html">Tween</a>
</li>
</ul>
<h1>Class Tween</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>A Tween animates numeric properties of objects. It uses different transition functions
to give the animations various styles.</p>
</div>
<p>The primary use of this class is to do standard animations like movement, fading,
rotation, etc. But there are no limits on what to animate; as long as the property you want
to animate is numeric (<code>int, uint, Number</code>), the tween can handle it. For a list
of available Transition types, look at the "Transitions" class.</p>
<p>Here is an example of a tween that moves an object to the right, rotates it, and
fades it out:</p>
<listing>
tween:Tween = new Tween(object, 2.0, Transitions.EASE_IN_OUT);
tween.animate("x", object.x + 50);
tween.animate("rotation", deg2rad(45));
tween.fadeTo(0); // equivalent to 'animate("alpha", 0)'
Starling.juggler.add(tween);</listing>
<p>Note that the object is added to a juggler at the end of this sample. That's because a
tween will only be executed if its "advanceTime" method is executed regularly - the
juggler will do that for you, and will remove the tween when it is finished.</p>
<p> @see Juggler
@see Transitions</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="starling.events.eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">Tween</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="starling.animation.ianimatable.html" class="tsd-signature-type">IAnimatable</a></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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="starling.animation.tween.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<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-external"><a href="starling.animation.tween.html#currenttime" class="tsd-kind-icon">current<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#delay" class="tsd-kind-icon">delay</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#iscomplete" class="tsd-kind-icon">is<wbr>Complete</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#nexttween" class="tsd-kind-icon">next<wbr>Tween</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#oncomplete" class="tsd-kind-icon">on<wbr>Complete</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#oncompleteargs" class="tsd-kind-icon">on<wbr>Complete<wbr>Args</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#onrepeat" class="tsd-kind-icon">on<wbr>Repeat</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#onrepeatargs" class="tsd-kind-icon">on<wbr>Repeat<wbr>Args</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#onstart" class="tsd-kind-icon">on<wbr>Start</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#onstartargs" class="tsd-kind-icon">on<wbr>Start<wbr>Args</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#onupdate" class="tsd-kind-icon">on<wbr>Update</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#onupdateargs" class="tsd-kind-icon">on<wbr>Update<wbr>Args</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#progress" class="tsd-kind-icon">progress</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#repeatcount" class="tsd-kind-icon">repeat<wbr>Count</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#repeatdelay" class="tsd-kind-icon">repeat<wbr>Delay</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#reverse" class="tsd-kind-icon">reverse</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#roundtoint" class="tsd-kind-icon">round<wbr>ToInt</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#target" class="tsd-kind-icon">target</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#totaltime" class="tsd-kind-icon">total<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#transition" class="tsd-kind-icon">transition</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#transitionfunc" class="tsd-kind-icon">transition<wbr>Func</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-inherited tsd-is-external"><a href="starling.animation.tween.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#advancetime" class="tsd-kind-icon">advance<wbr>Time</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#animate" class="tsd-kind-icon">animate</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#animatesproperty" class="tsd-kind-icon">animates<wbr>Property</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.animation.tween.html#dispatchevent" class="tsd-kind-icon">dispatch<wbr>Event</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.animation.tween.html#dispatcheventwith" class="tsd-kind-icon">dispatch<wbr>Event<wbr>With</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#fadeto" class="tsd-kind-icon">fade<wbr>To</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#getendvalue" class="tsd-kind-icon">get<wbr>End<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_currenttime" class="tsd-kind-icon">get_<wbr>current<wbr>Time</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_delay" class="tsd-kind-icon">get_<wbr>delay</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_iscomplete" class="tsd-kind-icon">get_<wbr>is<wbr>Complete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_nexttween" class="tsd-kind-icon">get_<wbr>next<wbr>Tween</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_oncomplete" class="tsd-kind-icon">get_<wbr>on<wbr>Complete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_oncompleteargs" class="tsd-kind-icon">get_<wbr>on<wbr>Complete<wbr>Args</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_onrepeat" class="tsd-kind-icon">get_<wbr>on<wbr>Repeat</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_onrepeatargs" class="tsd-kind-icon">get_<wbr>on<wbr>Repeat<wbr>Args</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_onstart" class="tsd-kind-icon">get_<wbr>on<wbr>Start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_onstartargs" class="tsd-kind-icon">get_<wbr>on<wbr>Start<wbr>Args</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_onupdate" class="tsd-kind-icon">get_<wbr>on<wbr>Update</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_onupdateargs" class="tsd-kind-icon">get_<wbr>on<wbr>Update<wbr>Args</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_progress" class="tsd-kind-icon">get_<wbr>progress</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_repeatcount" class="tsd-kind-icon">get_<wbr>repeat<wbr>Count</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_repeatdelay" class="tsd-kind-icon">get_<wbr>repeat<wbr>Delay</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_reverse" class="tsd-kind-icon">get_<wbr>reverse</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_roundtoint" class="tsd-kind-icon">get_<wbr>round<wbr>ToInt</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_target" class="tsd-kind-icon">get_<wbr>target</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_totaltime" class="tsd-kind-icon">get_<wbr>total<wbr>Time</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_transition" class="tsd-kind-icon">get_<wbr>transition</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#get_transitionfunc" class="tsd-kind-icon">get_<wbr>transition<wbr>Func</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.animation.tween.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#moveto" class="tsd-kind-icon">move<wbr>To</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.animation.tween.html#removeeventlistener" class="tsd-kind-icon">remove<wbr>Event<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.animation.tween.html#removeeventlisteners" class="tsd-kind-icon">remove<wbr>Event<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#reset" class="tsd-kind-icon">reset</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#rotateto" class="tsd-kind-icon">rotate<wbr>To</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="starling.animation.tween.html#scaleto" class="tsd-kind-icon">scale<wbr>To</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_delay" class="tsd-kind-icon">set_<wbr>delay</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_nexttween" class="tsd-kind-icon">set_<wbr>next<wbr>Tween</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_oncomplete" class="tsd-kind-icon">set_<wbr>on<wbr>Complete</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_oncompleteargs" class="tsd-kind-icon">set_<wbr>on<wbr>Complete<wbr>Args</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_onrepeat" class="tsd-kind-icon">set_<wbr>on<wbr>Repeat</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_onrepeatargs" class="tsd-kind-icon">set_<wbr>on<wbr>Repeat<wbr>Args</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_onstart" class="tsd-kind-icon">set_<wbr>on<wbr>Start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_onstartargs" class="tsd-kind-icon">set_<wbr>on<wbr>Start<wbr>Args</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_onupdate" class="tsd-kind-icon">set_<wbr>on<wbr>Update</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_onupdateargs" class="tsd-kind-icon">set_<wbr>on<wbr>Update<wbr>Args</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_repeatcount" class="tsd-kind-icon">set_<wbr>repeat<wbr>Count</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_repeatdelay" class="tsd-kind-icon">set_<wbr>repeat<wbr>Delay</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_reverse" class="tsd-kind-icon">set_<wbr>reverse</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_roundtoint" class="tsd-kind-icon">set_<wbr>round<wbr>ToInt</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_transition" class="tsd-kind-icon">set_<wbr>transition</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external"><a href="starling.animation.tween.html#set_transitionfunc" class="tsd-kind-icon">set_<wbr>transition<wbr>Func</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external">
<li class="tsd-signature tsd-kind-icon">new <wbr>Tween<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, time<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, transition<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><a href="starling.animation.tween.html" class="tsd-signature-type">Tween</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="starling.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L34">lib/starling/animation/Tween.d.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a tween with a target, duration (in seconds) and a transition function.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>target: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the object that you want to animate</p>
</div>
</div>
</li>
<li>
<h5>time: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the duration of the Tween (in seconds)</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> transition: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>can be either a String (e.g. one of the constants defined in the
Transitions class) or a function. Look up the 'Transitions' class for a
documentation about the required signature.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.animation.tween.html" class="tsd-signature-type">Tween</a></h4>
</li>
</ul>
</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-external">
<a name="currenttime" class="tsd-anchor"></a>
<h3>current<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">current<wbr>Time<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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L110">lib/starling/animation/Tween.d.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The time that has passed since the tween was created (in seconds).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="delay" class="tsd-anchor"></a>
<h3>delay</h3>
<div class="tsd-signature tsd-kind-icon">delay<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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L118">lib/starling/animation/Tween.d.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The delay before the tween is started (in seconds). @default 0</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="iscomplete" class="tsd-anchor"></a>
<h3>is<wbr>Complete</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Complete<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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L88">lib/starling/animation/Tween.d.ts:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if the tween is finished.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="nexttween" class="tsd-anchor"></a>
<h3>next<wbr>Tween</h3>
<div class="tsd-signature tsd-kind-icon">next<wbr>Tween<span class="tsd-signature-symbol">:</span> <a href="starling.animation.tween.html" class="tsd-signature-type">Tween</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L187">lib/starling/animation/Tween.d.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Another tween that will be started (i.e. added to the same juggler) as soon as
this tween is completed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="oncomplete" class="tsd-anchor"></a>
<h3>on<wbr>Complete</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Complete<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L161">lib/starling/animation/Tween.d.ts:161</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A that will be called when the tween is complete.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="oncompleteargs" class="tsd-anchor"></a>
<h3>on<wbr>Complete<wbr>Args</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Complete<wbr>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L181">lib/starling/animation/Tween.d.ts:181</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The arguments that will be passed to the 'onComplete' function.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="onrepeat" class="tsd-anchor"></a>
<h3>on<wbr>Repeat</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Repeat<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L156">lib/starling/animation/Tween.d.ts:156</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A that will be called each time the tween finishes one repetition
(except the last, which will trigger 'onComplete').</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="onrepeatargs" class="tsd-anchor"></a>
<h3>on<wbr>Repeat<wbr>Args</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Repeat<wbr>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L176">lib/starling/animation/Tween.d.ts:176</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The arguments that will be passed to the 'onRepeat' function.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="onstart" class="tsd-anchor"></a>
<h3>on<wbr>Start</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Start<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L145">lib/starling/animation/Tween.d.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A that will be called when the tween starts (after a possible delay).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="onstartargs" class="tsd-anchor"></a>
<h3>on<wbr>Start<wbr>Args</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Start<wbr>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L166">lib/starling/animation/Tween.d.ts:166</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The arguments that will be passed to the 'onStart' function.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="onupdate" class="tsd-anchor"></a>
<h3>on<wbr>Update</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Update<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L150">lib/starling/animation/Tween.d.ts:150</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A that will be called each time the tween is advanced.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="onupdateargs" class="tsd-anchor"></a>
<h3>on<wbr>Update<wbr>Args</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Update<wbr>Args<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L171">lib/starling/animation/Tween.d.ts:171</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The arguments that will be passed to the 'onUpdate' function.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="progress" class="tsd-anchor"></a>
<h3>progress</h3>
<div class="tsd-signature tsd-kind-icon">progress<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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L114">lib/starling/animation/Tween.d.ts:114</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The current progress between 0 and 1, as calculated by the transition function.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="repeatcount" class="tsd-anchor"></a>
<h3>repeat<wbr>Count</h3>
<div class="tsd-signature tsd-kind-icon">repeat<wbr>Count<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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L124">lib/starling/animation/Tween.d.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The number of times the tween will be executed.
Set to '0' to tween indefinitely. @default 1</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="repeatdelay" class="tsd-anchor"></a>
<h3>repeat<wbr>Delay</h3>
<div class="tsd-signature tsd-kind-icon">repeat<wbr>Delay<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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L129">lib/starling/animation/Tween.d.ts:129</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The amount of time to wait between repeat cycles (in seconds). @default 0</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="reverse" class="tsd-anchor"></a>
<h3>reverse</h3>
<div class="tsd-signature tsd-kind-icon">reverse<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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L135">lib/starling/animation/Tween.d.ts:135</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if the tween should be reversed when it is repeating. If enabled,
every second repetition will be reversed. @default false</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="roundtoint" class="tsd-anchor"></a>
<h3>round<wbr>ToInt</h3>
<div class="tsd-signature tsd-kind-icon">round<wbr>ToInt<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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L140">lib/starling/animation/Tween.d.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if the numeric values should be cast to Integers. @default false</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="target" class="tsd-anchor"></a>
<h3>target</h3>
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L92">lib/starling/animation/Tween.d.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The target object that is animated.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="totaltime" class="tsd-anchor"></a>
<h3>total<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Time<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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L106">lib/starling/animation/Tween.d.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The total time the tween will take per repetition (in seconds).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="transition" class="tsd-anchor"></a>
<h3>transition</h3>
<div class="tsd-signature tsd-kind-icon">transition<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L96">lib/starling/animation/Tween.d.ts:96</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The transition method used for the animation. @see Transitions</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="transitionfunc" class="tsd-anchor"></a>
<h3>transition<wbr>Func</h3>
<div class="tsd-signature tsd-kind-icon">transition<wbr>Func<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L101">lib/starling/animation/Tween.d.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The actual transition used for the animation.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>number<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">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>number: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</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-inherited tsd-is-external">
<a name="addeventlistener" class="tsd-anchor"></a>
<h3>add<wbr>Event<wbr>Listener</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">add<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<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><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="starling.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#addeventlistener">addEventListener</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/EventDispatcher.d.ts#L32">lib/starling/events/EventDispatcher.d.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registers an event listener at a certain object.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>listener: <span class="tsd-signature-type">Function</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="advancetime" class="tsd-anchor"></a>
<h3>advance<wbr>Time</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">advance<wbr>Time<span class="tsd-signature-symbol">(</span>time<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">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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L78">lib/starling/animation/Tween.d.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>inheritdoc</dt>
<dd></dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>time: <span class="tsd-signature-type">number</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="animate" class="tsd-anchor"></a>
<h3>animate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">animate<span class="tsd-signature-symbol">(</span>property<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, endValue<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">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/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L61">lib/starling/animation/Tween.d.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Animates the property of the target to a certain value. You can call this method
multiple times on one tween.</p>
</div>
<p><p>Some property types are handled in a special way:</p></p>
<ul>
<li>If the property contains the string <code>color</code> or <code>Color</code>,
it will be treated as an unsigned integer with a color value
(e.g. <code>0xff0000</code> for red). Each color channel will be animated
individually.</li>
<li>The same happens if you append the string <code>#rgb</code> to the name.</li>
<li>If you append <code>#rad</code>, the property is treated as an angle in radians,
making sure it always uses the shortest possible arc for the rotation.</li>
<li>The string <code>#deg</code> does the same for angles in degrees.</li>
</ul>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>property: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>endValue: <span class="tsd-signature-type">number</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="animatesproperty" class="tsd-anchor"></a>
<h3>animates<wbr>Property</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
<li class="tsd-signature tsd-kind-icon">animates<wbr>Property<span class="tsd-signature-symbol">(</span>property<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/animation/Tween.d.ts#L85">lib/starling/animation/Tween.d.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if a property with the given name is being animated by this tween.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>property: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</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="dispatchevent" class="tsd-anchor"></a>
<h3>dispatch<wbr>Event</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">dispatch<wbr>Event<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><a href="starling.events.event.html" class="tsd-signature-type">Event</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">
<p>Inherited from <a href="starling.events.eventdispatcher.html">EventDispatcher</a>.<a href="starling.events.eventdispatcher.html#dispatchevent">dispatchEvent</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/EventDispatcher.d.ts#L45">lib/starling/events/EventDispatcher.d.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dispatches an event to all objects that have registered listeners for its type.
If an event with enabled 'bubble' property is dispatched to a display object, it will
travel up along the line of parents, until it either hits the root object or someone
stops its propagation manually.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <a href="starling.events.event.html" class="tsd-signature-type">Event</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-inherited tsd-is-external">
<a name="dispatcheventwith" class="tsd-anchor"></a>
<h3>dispatch<wbr>Event<wbr>With</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">dispatch<wbr>Event<wbr>With<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, bubbles<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean