starling-framework
Version:
A fast, productive library for 2D cross-platform development.
807 lines • 66 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>EnterFrameEvent | 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.events.html">events</a>
</li>
<li>
<a href="starling.events.enterframeevent.html">EnterFrameEvent</a>
</li>
</ul>
<h1>Class EnterFrameEvent</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>An EnterFrameEvent is triggered once per frame and is dispatched to all objects in the
display tree.</p>
</div>
<p> It contains information about the time that has passed since the last frame. That way, you
can easily make animations that are independent of the frame rate, taking the passed time
into account.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="starling.events.event.html" class="tsd-signature-type">Event</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">EnterFrameEvent</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>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.events.enterframeevent.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-inherited tsd-is-external"><a href="starling.events.enterframeevent.html#bubbles" class="tsd-kind-icon">bubbles</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.events.enterframeevent.html#currenttarget" class="tsd-kind-icon">current<wbr>Target</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.events.enterframeevent.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="starling.events.enterframeevent.html#passedtime" class="tsd-kind-icon">passed<wbr>Time</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.events.enterframeevent.html#target" class="tsd-kind-icon">target</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.events.enterframeevent.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#added" class="tsd-kind-icon">ADDED</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#added_to_stage" class="tsd-kind-icon">ADDED_<wbr>TO_<wbr>STAGE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#cancel" class="tsd-kind-icon">CANCEL</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#change" class="tsd-kind-icon">CHANGE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#close" class="tsd-kind-icon">CLOSE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#complete" class="tsd-kind-icon">COMPLETE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#context3d_create" class="tsd-kind-icon">CONTEXT3<wbr>D_<wbr>CREATE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#enter_frame" class="tsd-kind-icon">ENTER_<wbr>FRAME</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#fatal_error" class="tsd-kind-icon">FATAL_<wbr>ERROR</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#io_error" class="tsd-kind-icon">IO_<wbr>ERROR</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#open" class="tsd-kind-icon">OPEN</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#parse_error" class="tsd-kind-icon">PARSE_<wbr>ERROR</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#ready" class="tsd-kind-icon">READY</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#removed" class="tsd-kind-icon">REMOVED</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#removed_from_stage" class="tsd-kind-icon">REMOVED_<wbr>FROM_<wbr>STAGE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#remove_from_juggler" class="tsd-kind-icon">REMOVE_<wbr>FROM_<wbr>JUGGLER</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#render" class="tsd-kind-icon">RENDER</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#resize" class="tsd-kind-icon">RESIZE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#root_created" class="tsd-kind-icon">ROOT_<wbr>CREATED</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#scroll" class="tsd-kind-icon">SCROLL</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#security_error" class="tsd-kind-icon">SECURITY_<wbr>ERROR</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#select" class="tsd-kind-icon">SELECT</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#textures_restored" class="tsd-kind-icon">TEXTURES_<wbr>RESTORED</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#triggered" class="tsd-kind-icon">TRIGGERED</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="starling.events.enterframeevent.html#update" class="tsd-kind-icon">UPDATE</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-protected tsd-is-external"><a href="starling.events.enterframeevent.html#get_passedtime" class="tsd-kind-icon">get_<wbr>passed<wbr>Time</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.events.enterframeevent.html#stopimmediatepropagation" class="tsd-kind-icon">stop<wbr>Immediate<wbr>Propagation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.events.enterframeevent.html#stoppropagation" class="tsd-kind-icon">stop<wbr>Propagation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="starling.events.enterframeevent.html#tostring" class="tsd-kind-icon">to<wbr>String</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>Enter<wbr>Frame<wbr>Event<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, passedTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, bubbles<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><a href="starling.events.enterframeevent.html" class="tsd-signature-type">EnterFrameEvent</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/EnterFrameEvent.d.ts#L15">lib/starling/events/EnterFrameEvent.d.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates an enter frame event with the passed time.</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>passedTime: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> bubbles: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="starling.events.enterframeevent.html" class="tsd-signature-type">EnterFrameEvent</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-inherited tsd-is-external">
<a name="bubbles" class="tsd-anchor"></a>
<h3>bubbles</h3>
<div class="tsd-signature tsd-kind-icon">bubbles<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#bubbles">bubbles</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L94">lib/starling/events/Event.d.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Indicates if event will bubble.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="currenttarget" class="tsd-anchor"></a>
<h3>current<wbr>Target</h3>
<div class="tsd-signature tsd-kind-icon">current<wbr>Target<span class="tsd-signature-symbol">:</span> <a href="starling.events.eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#currenttarget">currentTarget</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L100">lib/starling/events/Event.d.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The object the event is currently bubbling at.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="data" class="tsd-anchor"></a>
<h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#data">data</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L106">lib/starling/events/Event.d.ts:106</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Arbitrary data that is attached to the event.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
<a name="passedtime" class="tsd-anchor"></a>
<h3>passed<wbr>Time</h3>
<div class="tsd-signature tsd-kind-icon">passed<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/events/EnterFrameEvent.d.ts#L21">lib/starling/events/EnterFrameEvent.d.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The time that has passed since the last frame (in seconds).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited 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> <a href="starling.events.eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#target">target</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L97">lib/starling/events/Event.d.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The object that dispatched the event.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="type" class="tsd-anchor"></a>
<h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L103">lib/starling/events/Event.d.ts:103</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A string that identifies the event.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="added" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> ADDED</h3>
<div class="tsd-signature tsd-kind-icon">ADDED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#added">ADDED</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L28">lib/starling/events/Event.d.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type for a display object that is added to a parent.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="added_to_stage" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> ADDED_<wbr>TO_<wbr>STAGE</h3>
<div class="tsd-signature tsd-kind-icon">ADDED_<wbr>TO_<wbr>STAGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#added_to_stage">ADDED_TO_STAGE</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L30">lib/starling/events/Event.d.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type for a display object that is added to the stage</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="cancel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> CANCEL</h3>
<div class="tsd-signature tsd-kind-icon">CANCEL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#cancel">CANCEL</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L67">lib/starling/events/Event.d.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event type to be utilized in custom events. Not used by Starling right now.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="change" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> CHANGE</h3>
<div class="tsd-signature tsd-kind-icon">CHANGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#change">CHANGE</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L65">lib/starling/events/Event.d.ts:65</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event type to be utilized in custom events. Not used by Starling right now.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="close" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> CLOSE</h3>
<div class="tsd-signature tsd-kind-icon">CLOSE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#close">CLOSE</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L73">lib/starling/events/Event.d.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event type to be utilized in custom events. Not used by Starling right now.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="complete" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> COMPLETE</h3>
<div class="tsd-signature tsd-kind-icon">COMPLETE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#complete">COMPLETE</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L42">lib/starling/events/Event.d.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type that may be used whenever something finishes.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="context3d_create" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> CONTEXT3<wbr>D_<wbr>CREATE</h3>
<div class="tsd-signature tsd-kind-icon">CONTEXT3<wbr>D_<wbr>CREATE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#context3d_create">CONTEXT3D_CREATE</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L44">lib/starling/events/Event.d.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type for a (re)created stage3D rendering context.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-static tsd-is-external">
<a name="enter_frame" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> ENTER_<wbr>FRAME</h3>
<div class="tsd-signature tsd-kind-icon">ENTER_<wbr>FRAME<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Overrides <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#enter_frame">ENTER_FRAME</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/EnterFrameEvent.d.ts#L15">lib/starling/events/EnterFrameEvent.d.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type for a display object that is entering a new frame.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="fatal_error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> FATAL_<wbr>ERROR</h3>
<div class="tsd-signature tsd-kind-icon">FATAL_<wbr>ERROR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#fatal_error">FATAL_ERROR</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L62">lib/starling/events/Event.d.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type that is dispatched by the Starling instance when it encounters a problem
from which it cannot recover, e.g. a lost device context.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="io_error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> IO_<wbr>ERROR</h3>
<div class="tsd-signature tsd-kind-icon">IO_<wbr>ERROR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#io_error">IO_ERROR</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L54">lib/starling/events/Event.d.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type that is dispatched by the AssetManager when a file/url cannot be loaded.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="open" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> OPEN</h3>
<div class="tsd-signature tsd-kind-icon">OPEN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#open">OPEN</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L71">lib/starling/events/Event.d.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event type to be utilized in custom events. Not used by Starling right now.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="parse_error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> PARSE_<wbr>ERROR</h3>
<div class="tsd-signature tsd-kind-icon">PARSE_<wbr>ERROR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#parse_error">PARSE_ERROR</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L59">lib/starling/events/Event.d.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type that is dispatched by the AssetManager when an xml or json file couldn't
be parsed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="ready" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> READY</h3>
<div class="tsd-signature tsd-kind-icon">READY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#ready">READY</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L77">lib/starling/events/Event.d.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event type to be utilized in custom events. Not used by Starling right now.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="removed" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> REMOVED</h3>
<div class="tsd-signature tsd-kind-icon">REMOVED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#removed">REMOVED</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L34">lib/starling/events/Event.d.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type for a display object that is removed from its parent.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="removed_from_stage" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> REMOVED_<wbr>FROM_<wbr>STAGE</h3>
<div class="tsd-signature tsd-kind-icon">REMOVED_<wbr>FROM_<wbr>STAGE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#removed_from_stage">REMOVED_FROM_STAGE</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L36">lib/starling/events/Event.d.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type for a display object that is removed from the stage.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="remove_from_juggler" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> REMOVE_<wbr>FROM_<wbr>JUGGLER</h3>
<div class="tsd-signature tsd-kind-icon">REMOVE_<wbr>FROM_<wbr>JUGGLER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#remove_from_juggler">REMOVE_FROM_JUGGLER</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L50">lib/starling/events/Event.d.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type for an animated object that requests to be removed from the juggler.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="render" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> RENDER</h3>
<div class="tsd-signature tsd-kind-icon">RENDER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#render">RENDER</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L46">lib/starling/events/Event.d.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type that is dispatched by the Starling instance directly before rendering.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="resize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> RESIZE</h3>
<div class="tsd-signature tsd-kind-icon">RESIZE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#resize">RESIZE</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L40">lib/starling/events/Event.d.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type for a resized Flash Player.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="root_created" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> ROOT_<wbr>CREATED</h3>
<div class="tsd-signature tsd-kind-icon">ROOT_<wbr>CREATED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#root_created">ROOT_CREATED</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L48">lib/starling/events/Event.d.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type that indicates that the root DisplayObject has been created.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="scroll" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> SCROLL</h3>
<div class="tsd-signature tsd-kind-icon">SCROLL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#scroll">SCROLL</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L69">lib/starling/events/Event.d.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event type to be utilized in custom events. Not used by Starling right now.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="security_error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> SECURITY_<wbr>ERROR</h3>
<div class="tsd-signature tsd-kind-icon">SECURITY_<wbr>ERROR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#security_error">SECURITY_ERROR</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L56">lib/starling/events/Event.d.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type that is dispatched by the AssetManager when a file/url cannot be loaded.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="select" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> SELECT</h3>
<div class="tsd-signature tsd-kind-icon">SELECT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#select">SELECT</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L75">lib/starling/events/Event.d.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event type to be utilized in custom events. Not used by Starling right now.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="textures_restored" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> TEXTURES_<wbr>RESTORED</h3>
<div class="tsd-signature tsd-kind-icon">TEXTURES_<wbr>RESTORED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#textures_restored">TEXTURES_RESTORED</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L52">lib/starling/events/Event.d.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type that is dispatched by the AssetManager after a context loss.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="triggered" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> TRIGGERED</h3>
<div class="tsd-signature tsd-kind-icon">TRIGGERED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#triggered">TRIGGERED</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L38">lib/starling/events/Event.d.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Event type for a triggered button.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external">
<a name="update" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> UPDATE</h3>
<div class="tsd-signature tsd-kind-icon">UPDATE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#update">UPDATE</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L79">lib/starling/events/Event.d.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event type to be utilized in custom events. Not used by Starling right now.</p>
</div>
</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-protected tsd-is-external">
<a name="get_passedtime" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get_<wbr>passed<wbr>Time</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-external">
<li class="tsd-signature tsd-kind-icon">get_<wbr>passed<wbr>Time<span class="tsd-signature-symbol">(</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">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/EnterFrameEvent.d.ts#L22">lib/starling/events/EnterFrameEvent.d.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</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="stopimmediatepropagation" class="tsd-anchor"></a>
<h3>stop<wbr>Immediate<wbr>Propagation</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">stop<wbr>Immediate<wbr>Propagation<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="starling.events.event.html">Event</a>.<a href="starling.events.event.html#stopimmediatepropagation">stopImmediatePropagation</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L88">lib/starling/events/Event.d.ts:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Prevents any other listeners from receiving the event.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="stoppropagation" class="tsd-anchor"></a>
<h3>stop<wbr>Propagation</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">stop<wbr>Propagation<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="starling.events.event.html">Event</a>.<a href="starling.events.event.html#stoppropagation">stopPropagation</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L85">lib/starling/events/Event.d.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Prevents listeners at the next bubble stage from receiving the event.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</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">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="starling.events.event.html">Event</a>.<a href="starling.events.event.html#tostring">toString</a></p>
<ul>
<li>Defined in <a href="https://github.com/openfl/starling/blob/bce2af2/lib/starling/events/Event.d.ts#L91">lib/starling/events/Event.d.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns a description of the event, containing type and bubble information.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="label tsd-is-external">
<span>Externals</span>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.animation.html">starling.animation</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.assets.html">starling.assets</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.core.html">starling.core</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.display.html">starling.display</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.errors.html">starling.errors</a>
</li>
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.events.html">starling.events</a>
</li>
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
<a href="../modules/starling.extensions.html">starling.extension