1344 lines
78 KiB
HTML
1344 lines
78 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>LoaderInfo | openfl</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">openfl</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">openfl</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/openfl.display.html">display</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.display.loaderinfo.html">LoaderInfo</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class LoaderInfo</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>The LoaderInfo class provides information about a loaded SWF file or a
|
|
loaded image file(JPEG, GIF, or PNG). LoaderInfo objects are available for
|
|
any display object. The information provided includes load progress, the
|
|
URLs of the loader and loaded content, the number of bytes total for the
|
|
media, and the nominal height and width of the media.</p>
|
|
</div>
|
|
<p>You can access LoaderInfo objects in two ways:</p>
|
|
<ul>
|
|
<li>The <code>contentLoaderInfo</code> property of a flash.display.Loader
|
|
object - The <code>contentLoaderInfo</code> property is always available
|
|
for any Loader object. For a Loader object that has not called the
|
|
<code>load()</code> or <code>loadBytes()</code> method, or that has not
|
|
sufficiently loaded, attempting to access many of the properties of the
|
|
<code>contentLoaderInfo</code> property throws an error.</li>
|
|
<li>The <code>loaderInfo</code> property of a display object.</li>
|
|
</ul>
|
|
<p>The <code>contentLoaderInfo</code> property of a Loader object provides
|
|
information about the content that the Loader object is loading, whereas
|
|
the <code>loaderInfo</code> property of a DisplayObject provides
|
|
information about the root SWF file for that display object.</p>
|
|
<p>When you use a Loader object to load a display object(such as a SWF
|
|
file or a bitmap), the <code>loaderInfo</code> property of the display
|
|
object is the same as the <code>contentLoaderInfo</code> property of the
|
|
Loader object(<code>DisplayObject.loaderInfo =
|
|
Loader.contentLoaderInfo</code>). Because the instance of the main class of
|
|
the SWF file has no Loader object, the <code>loaderInfo</code> property is
|
|
the only way to access the LoaderInfo for the instance of the main class of
|
|
the SWF file.</p>
|
|
<p>The following diagram shows the different uses of the LoaderInfo
|
|
object - for the instance of the main class of the SWF file, for the
|
|
<code>contentLoaderInfo</code> property of a Loader object, and for the
|
|
<code>loaderInfo</code> property of a loaded object:</p>
|
|
<p>When a loading operation is not complete, some properties of the
|
|
<code>contentLoaderInfo</code> property of a Loader object are not
|
|
available. You can obtain some properties, such as
|
|
<code>bytesLoaded</code>, <code>bytesTotal</code>, <code>url</code>,
|
|
<code>loaderURL</code>, and <code>applicationDomain</code>. When the
|
|
<code>loaderInfo</code> object dispatches the <code>init</code> event, you
|
|
can access all properties of the <code>loaderInfo</code> object and the
|
|
loaded image or SWF file.</p>
|
|
<p><strong>Note:</strong> All properties of LoaderInfo objects are read-only.</p>
|
|
<p>The <code>EventDispatcher.dispatchEvent()</code> method is not
|
|
applicable to LoaderInfo objects. If you call <code>dispatchEvent()</code>
|
|
on a LoaderInfo object, an IllegalOperationError exception is thrown.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>:event</dt>
|
|
<dd><p>complete Dispatched when data has loaded successfully. In other
|
|
words, it is dispatched when all the content has been
|
|
downloaded and the loading has finished. The
|
|
<code>complete</code> event is always dispatched after
|
|
the <code>init</code> event. The <code>init</code> event
|
|
is dispatched when the object is ready to access, though
|
|
the content may still be downloading.</p>
|
|
</dd>
|
|
<dt>:event</dt>
|
|
<dd><p>httpStatus Dispatched when a network request is made over HTTP and
|
|
an HTTP status code can be detected.</p>
|
|
</dd>
|
|
<dt>:event</dt>
|
|
<dd><p>init Dispatched when the properties and methods of a loaded
|
|
SWF file are accessible and ready for use. The content,
|
|
however, can still be downloading. A LoaderInfo object
|
|
dispatches the <code>init</code> event when the following
|
|
conditions exist:</p>
|
|
<pre><code> * All properties <span class="hljs-keyword">and</span> methods associated <span class="hljs-keyword">with</span> the
|
|
loaded <span class="hljs-built_in">object</span> <span class="hljs-keyword">and</span> those associated <span class="hljs-keyword">with</span> the LoaderInfo
|
|
<span class="hljs-built_in">object</span> are accessible.
|
|
* The constructors <span class="hljs-keyword">for</span> all child objects have
|
|
completed.
|
|
* All ActionScript code <span class="hljs-keyword">in</span> the first frame <span class="hljs-keyword">of</span> the
|
|
loaded SWF<span class="hljs-comment">'s main timeline has been executed.</span>
|
|
|
|
|
|
<span class="hljs-keyword">For</span> example, an `<span class="hljs-keyword">Event</span>.INIT` <span class="hljs-keyword">is</span> dispatched
|
|
<span class="hljs-keyword">when</span> the first frame <span class="hljs-keyword">of</span> a movie <span class="hljs-keyword">or</span> animation <span class="hljs-keyword">is</span> loaded.
|
|
The movie <span class="hljs-keyword">is</span> <span class="hljs-keyword">then</span> accessible <span class="hljs-keyword">and</span> can be added <span class="hljs-keyword">to</span> the
|
|
display list. The complete movie, however, can <span class="hljs-keyword">take</span>
|
|
longer <span class="hljs-keyword">to</span> download. The `<span class="hljs-keyword">Event</span>.COMPLETE` <span class="hljs-keyword">is</span>
|
|
only dispatched once the full movie <span class="hljs-keyword">is</span> loaded.
|
|
|
|
The `init` <span class="hljs-keyword">event</span> always precedes the
|
|
`complete` <span class="hljs-keyword">event</span>.
|
|
</code></pre></dd>
|
|
<dt>:event</dt>
|
|
<dd><p>ioError Dispatched when an input or output error occurs that
|
|
causes a load operation to fail.</p>
|
|
</dd>
|
|
<dt>:event</dt>
|
|
<dd><p>open Dispatched when a load operation starts.</p>
|
|
</dd>
|
|
<dt>:event</dt>
|
|
<dd><p>progress Dispatched when data is received as the download
|
|
operation progresses.</p>
|
|
</dd>
|
|
<dt>:event</dt>
|
|
<dd><p>unload Dispatched by a LoaderInfo object whenever a loaded
|
|
object is removed by using the <code>unload()</code>
|
|
method of the Loader object, or when a second load is
|
|
performed by the same Loader object and the original
|
|
content is removed prior to the load beginning.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="openfl.events.eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">LoaderInfo</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="openfl.events.ieventdispatcher.html" class="tsd-signature-type">IEventDispatcher</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-inherited tsd-is-external">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.display.loaderinfo.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="openfl.display.loaderinfo.html#applicationdomain" class="tsd-kind-icon">application<wbr>Domain</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#bytes" class="tsd-kind-icon">bytes</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#bytesloaded" class="tsd-kind-icon">bytes<wbr>Loaded</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#bytestotal" class="tsd-kind-icon">bytes<wbr>Total</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#childallowsparent" class="tsd-kind-icon">child<wbr>Allows<wbr>Parent</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#content" class="tsd-kind-icon">content</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#contenttype" class="tsd-kind-icon">content<wbr>Type</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#framerate" class="tsd-kind-icon">frame<wbr>Rate</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#height" class="tsd-kind-icon">height</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#loader" class="tsd-kind-icon">loader</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#loaderurl" class="tsd-kind-icon">loaderURL</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#parameters" class="tsd-kind-icon">parameters</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#parentallowschild" class="tsd-kind-icon">parent<wbr>Allows<wbr>Child</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#samedomain" class="tsd-kind-icon">same<wbr>Domain</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#sharedevents" class="tsd-kind-icon">shared<wbr>Events</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#uncaughterrorevents" class="tsd-kind-icon">uncaught<wbr>Error<wbr>Events</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#url" class="tsd-kind-icon">url</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="openfl.display.loaderinfo.html#width" class="tsd-kind-icon">width</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-inherited 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="openfl.display.loaderinfo.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.display.loaderinfo.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="openfl.display.loaderinfo.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.display.loaderinfo.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="openfl.display.loaderinfo.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="openfl.display.loaderinfo.html#willtrigger" class="tsd-kind-icon">will<wbr>Trigger</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited 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-inherited tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Loader<wbr>Info<span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">?: </span><a href="openfl.events.ieventdispatcher.html" class="tsd-signature-type">IEventDispatcher</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.display.loaderinfo.html" class="tsd-signature-type">LoaderInfo</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#constructor">constructor</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L50">lib/openfl/events/EventDispatcher.d.ts:50</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Aggregates an instance of the EventDispatcher class.</p>
|
|
</div>
|
|
<p>The EventDispatcher class is generally used as a base class, which
|
|
means that most developers do not need to use this constructor function.
|
|
However, advanced developers who are implementing the IEventDispatcher
|
|
interface need to use this constructor. If you are unable to extend the
|
|
EventDispatcher class and must instead implement the IEventDispatcher
|
|
interface, use this constructor to aggregate an instance of the
|
|
EventDispatcher class.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> target: <a href="openfl.events.ieventdispatcher.html" class="tsd-signature-type">IEventDispatcher</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The target object for events dispatched to the
|
|
EventDispatcher object. This parameter is used when the
|
|
EventDispatcher instance is aggregated by a class that
|
|
implements IEventDispatcher; it is necessary so that the
|
|
containing object can be the target for events. Do not use
|
|
this parameter in simple cases in which a class extends
|
|
EventDispatcher.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="openfl.display.loaderinfo.html" class="tsd-signature-type">LoaderInfo</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="applicationdomain" class="tsd-anchor"></a>
|
|
<h3>application<wbr>Domain</h3>
|
|
<div class="tsd-signature tsd-kind-icon">application<wbr>Domain<span class="tsd-signature-symbol">:</span> <a href="openfl.system.applicationdomain.html" class="tsd-signature-type">ApplicationDomain</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L138">lib/openfl/display/LoaderInfo.d.ts:138</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>When an external SWF file is loaded, all ActionScript 3.0 definitions
|
|
contained in the loaded class are stored in the
|
|
<code>applicationDomain</code> property.</p>
|
|
</div>
|
|
<p>All code in a SWF file is defined to exist in an application domain.
|
|
The current application domain is where your main application runs. The
|
|
system domain contains all application domains, including the current
|
|
domain and all classes used by Flash Player or Adobe AIR.</p>
|
|
<p>All application domains, except the system domain, have an associated
|
|
parent domain. The parent domain of your main application's
|
|
<code>applicationDomain</code> is the system domain. Loaded classes are
|
|
defined only when their parent doesn't already define them. You cannot
|
|
override a loaded class definition with a newer definition.</p>
|
|
<p>For usage examples of application domains, see the "Client System
|
|
Environment" chapter in the <em>ActionScript 3.0 Developer's Guide</em>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>SecurityError This security sandbox of the caller is not allowed
|
|
to access this ApplicationDomain.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="bytes" class="tsd-anchor"></a>
|
|
<h3>bytes</h3>
|
|
<div class="tsd-signature tsd-kind-icon">bytes<span class="tsd-signature-symbol">:</span> <a href="openfl.utils.bytearray.html" class="tsd-signature-type">ByteArray</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L155">lib/openfl/display/LoaderInfo.d.ts:155</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The bytes associated with a LoaderInfo object.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>SecurityError If the object accessing this API is prevented from
|
|
accessing the loaded object due to security
|
|
restrictions. This situation can occur, for
|
|
instance, when a Loader object attempts to access
|
|
the <code>contentLoaderInfo.content</code> property
|
|
and it is not granted security permission to access
|
|
the loaded content.</p>
|
|
<pre><code> <span class="hljs-keyword">For</span> more information related <span class="hljs-keyword">to</span> security, see the
|
|
Flash <span class="hljs-built_in">Player</span> Developer Center Topic:
|
|
[Security](http:<span class="hljs-comment">//www.adobe.com/go/devnet_security_en).</span>
|
|
</code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="bytesloaded" class="tsd-anchor"></a>
|
|
<h3>bytes<wbr>Loaded</h3>
|
|
<div class="tsd-signature tsd-kind-icon">bytes<wbr>Loaded<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L161">lib/openfl/display/LoaderInfo.d.ts:161</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The number of bytes that are loaded for the media. When this number equals
|
|
the value of <code>bytesTotal</code>, all of the bytes are loaded.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="bytestotal" class="tsd-anchor"></a>
|
|
<h3>bytes<wbr>Total</h3>
|
|
<div class="tsd-signature tsd-kind-icon">bytes<wbr>Total<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L172">lib/openfl/display/LoaderInfo.d.ts:172</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The number of compressed bytes in the entire media file.</p>
|
|
</div>
|
|
<p>Before the first <code>progress</code> event is dispatched by this
|
|
LoaderInfo object's corresponding Loader object, <code>bytesTotal</code>
|
|
is 0. After the first <code>progress</code> event from the Loader object,
|
|
<code>bytesTotal</code> reflects the actual number of bytes to be
|
|
downloaded.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="childallowsparent" class="tsd-anchor"></a>
|
|
<h3>child<wbr>Allows<wbr>Parent</h3>
|
|
<div class="tsd-signature tsd-kind-icon">child<wbr>Allows<wbr>Parent<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L189">lib/openfl/display/LoaderInfo.d.ts:189</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Expresses the trust relationship from content(child) to the Loader
|
|
(parent). If the child has allowed the parent access, <code>true</code>;
|
|
otherwise, <code>false</code>. This property is set to <code>true</code>
|
|
if the child object has called the <code>allowDomain()</code> method to
|
|
grant permission to the parent domain or if a URL policy is loaded at the
|
|
child domain that grants permission to the parent domain. If child and
|
|
parent are in the same domain, this property is set to <code>true</code>.</p>
|
|
</div>
|
|
<p>For more information related to security, see the Flash Player
|
|
Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en">Security</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error Thrown if the file is not downloaded sufficiently to
|
|
retrieve the requested information.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="content" class="tsd-anchor"></a>
|
|
<h3>content</h3>
|
|
<div class="tsd-signature tsd-kind-icon">content<span class="tsd-signature-symbol">:</span> <a href="openfl.display.displayobject.html" class="tsd-signature-type">DisplayObject</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L210">lib/openfl/display/LoaderInfo.d.ts:210</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The loaded object associated with this LoaderInfo object.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>SecurityError If the object accessing this API is prevented from
|
|
accessing the loaded object due to security
|
|
restrictions. This situation can occur, for
|
|
instance, when a Loader object attempts to access
|
|
the <code>contentLoaderInfo.content</code> property
|
|
and it is not granted security permission to access
|
|
the loaded content.</p>
|
|
<pre><code> <span class="hljs-keyword">For</span> more information related <span class="hljs-keyword">to</span> security, see the
|
|
Flash <span class="hljs-built_in">Player</span> Developer Center Topic:
|
|
[Security](http:<span class="hljs-comment">//www.adobe.com/go/devnet_security_en).</span>
|
|
</code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="contenttype" class="tsd-anchor"></a>
|
|
<h3>content<wbr>Type</h3>
|
|
<div class="tsd-signature tsd-kind-icon">content<wbr>Type<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L223">lib/openfl/display/LoaderInfo.d.ts:223</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The MIME type of the loaded file. The value is <code>null</code> if not
|
|
enough of the file has loaded in order to determine the type. The
|
|
following list gives the possible values:</p>
|
|
</div>
|
|
<ul>
|
|
<li><code>"application/x-shockwave-flash"</code></li>
|
|
<li><code>"image/jpeg"</code></li>
|
|
<li><code>"image/gif"</code></li>
|
|
<li><code>"image/png"</code></li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="framerate" class="tsd-anchor"></a>
|
|
<h3>frame<wbr>Rate</h3>
|
|
<div class="tsd-signature tsd-kind-icon">frame<wbr>Rate<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L240">lib/openfl/display/LoaderInfo.d.ts:240</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The nominal frame rate, in frames per second, of the loaded SWF file. This
|
|
number is often an integer, but need not be.</p>
|
|
</div>
|
|
<p>This value may differ from the actual frame rate in use. Flash Player
|
|
or Adobe AIR only uses a single frame rate for all loaded SWF files at any
|
|
one time, and this frame rate is determined by the nominal frame rate of
|
|
the main SWF file. Also, the main frame rate may not be able to be
|
|
achieved, depending on hardware, sound synchronization, and other
|
|
factors.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error If the file is not downloaded sufficiently to retrieve the
|
|
requested information.</p>
|
|
</dd>
|
|
<dt>throws</dt>
|
|
<dd><p>Error If the file is not a SWF file.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="height" class="tsd-anchor"></a>
|
|
<h3>height</h3>
|
|
<div class="tsd-signature tsd-kind-icon">height<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L250">lib/openfl/display/LoaderInfo.d.ts:250</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The nominal height of the loaded file. This value might differ from the
|
|
actual height at which the content is displayed, since the loaded content
|
|
or its parent display objects might be scaled.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error If the file is not downloaded sufficiently to retrieve the
|
|
requested information.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="loader" class="tsd-anchor"></a>
|
|
<h3>loader</h3>
|
|
<div class="tsd-signature tsd-kind-icon">loader<span class="tsd-signature-symbol">:</span> <a href="openfl.display.loader.html" class="tsd-signature-type">Loader</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L273">lib/openfl/display/LoaderInfo.d.ts:273</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The Loader object associated with this LoaderInfo object. If this
|
|
LoaderInfo object is the <code>loaderInfo</code> property of the instance
|
|
of the main class of the SWF file, no Loader object is associated.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>SecurityError If the object accessing this API is prevented from
|
|
accessing the Loader object because of security
|
|
restrictions. This can occur, for instance, when a
|
|
loaded SWF file attempts to access its
|
|
<code>loaderInfo.loader</code> property and it is
|
|
not granted security permission to access the
|
|
loading SWF file.</p>
|
|
<pre><code> <span class="hljs-keyword">For</span> more information related <span class="hljs-keyword">to</span> security, see the
|
|
Flash <span class="hljs-built_in">Player</span> Developer Center Topic:
|
|
[Security](http:<span class="hljs-comment">//www.adobe.com/go/devnet_security_en).</span>
|
|
</code></pre></dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="loaderurl" class="tsd-anchor"></a>
|
|
<h3>loaderURL</h3>
|
|
<div class="tsd-signature tsd-kind-icon">loaderURL<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L280">lib/openfl/display/LoaderInfo.d.ts:280</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The URL of the SWF file that initiated the loading of the media described
|
|
by this LoaderInfo object. For the instance of the main class of the SWF
|
|
file, this URL is the same as the SWF file's own URL.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="parameters" class="tsd-anchor"></a>
|
|
<h3>parameters</h3>
|
|
<div class="tsd-signature tsd-kind-icon">parameters<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L302">lib/openfl/display/LoaderInfo.d.ts:302</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An object that contains name-value pairs that represent the parameters
|
|
provided to the loaded SWF file.</p>
|
|
</div>
|
|
<p>You can use a <code>for-in</code> loop to extract all the names and
|
|
values from the <code>parameters</code> object.</p>
|
|
<p>The two sources of parameters are: the query string in the URL of the
|
|
main SWF file, and the value of the <code>FlashVars</code> HTML parameter
|
|
(this affects only the main SWF file).</p>
|
|
<p>The <code>parameters</code> property replaces the ActionScript 1.0 and
|
|
2.0 technique of providing SWF file parameters as properties of the main
|
|
timeline.</p>
|
|
<p>The value of the <code>parameters</code> property is null for Loader
|
|
objects that contain SWF files that use ActionScript 1.0 or 2.0. It is
|
|
only non-null for Loader objects that contain SWF files that use
|
|
ActionScript 3.0.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="parentallowschild" class="tsd-anchor"></a>
|
|
<h3>parent<wbr>Allows<wbr>Child</h3>
|
|
<div class="tsd-signature tsd-kind-icon">parent<wbr>Allows<wbr>Child<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L319">lib/openfl/display/LoaderInfo.d.ts:319</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Expresses the trust relationship from Loader(parent) to the content
|
|
(child). If the parent has allowed the child access, <code>true</code>;
|
|
otherwise, <code>false</code>. This property is set to <code>true</code>
|
|
if the parent object called the <code>allowDomain()</code> method to grant
|
|
permission to the child domain or if a URL policy file is loaded at the
|
|
parent domain granting permission to the child domain. If child and parent
|
|
are in the same domain, this property is set to <code>true</code>.</p>
|
|
</div>
|
|
<p>For more information related to security, see the Flash Player
|
|
Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en">Security</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error Thrown if the file is not downloaded sufficiently to
|
|
retrieve the requested information.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="samedomain" class="tsd-anchor"></a>
|
|
<h3>same<wbr>Domain</h3>
|
|
<div class="tsd-signature tsd-kind-icon">same<wbr>Domain<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L333">lib/openfl/display/LoaderInfo.d.ts:333</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Expresses the domain relationship between the loader and the content:
|
|
<code>true</code> if they have the same origin domain; <code>false</code>
|
|
otherwise.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error Thrown if the file is not downloaded sufficiently to
|
|
retrieve the requested information.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="sharedevents" class="tsd-anchor"></a>
|
|
<h3>shared<wbr>Events</h3>
|
|
<div class="tsd-signature tsd-kind-icon">shared<wbr>Events<span class="tsd-signature-symbol">:</span> <a href="openfl.events.eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L342">lib/openfl/display/LoaderInfo.d.ts:342</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An EventDispatcher instance that can be used to exchange events across
|
|
security boundaries. Even when the Loader object and the loaded content
|
|
originate from security domains that do not trust one another, both can
|
|
access <code>sharedEvents</code> and send and receive events via this
|
|
object.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="uncaughterrorevents" class="tsd-anchor"></a>
|
|
<h3>uncaught<wbr>Error<wbr>Events</h3>
|
|
<div class="tsd-signature tsd-kind-icon">uncaught<wbr>Error<wbr>Events<span class="tsd-signature-symbol">:</span> <a href="openfl.events.uncaughterrorevents.html" class="tsd-signature-type">UncaughtErrorEvents</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L363">lib/openfl/display/LoaderInfo.d.ts:363</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An object that dispatches an <code>uncaughtError</code> event when an
|
|
unhandled error occurs in code in this LoaderInfo object's SWF file. An
|
|
uncaught error happens when an error is thrown outside of any
|
|
<code>try..catch</code> blocks or when an ErrorEvent object is dispatched
|
|
with no registered listeners.</p>
|
|
</div>
|
|
<p>This property is created when the SWF associated with this LoaderInfo
|
|
has finished loading. Until then the <code>uncaughtErrorEvents</code>
|
|
property is <code>null</code>. In an ActionScript-only project, you can
|
|
access this property during or after the execution of the constructor
|
|
of the main class of the SWF file. For a Flex project, the
|
|
<code>uncaughtErrorEvents</code> property is available after the
|
|
<code>applicationComplete</code> event is dispatched.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="url" class="tsd-anchor"></a>
|
|
<h3>url</h3>
|
|
<div class="tsd-signature tsd-kind-icon">url<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L379">lib/openfl/display/LoaderInfo.d.ts:379</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The URL of the media being loaded.</p>
|
|
</div>
|
|
<p>Before the first <code>progress</code> event is dispatched by this
|
|
LoaderInfo object's corresponding Loader object, the value of the
|
|
<code>url</code> property might reflect only the initial URL specified in
|
|
the call to the <code>load()</code> method of the Loader object. After the
|
|
first <code>progress</code> event, the <code>url</code> property reflects
|
|
the media's final URL, after any redirects and relative URLs are
|
|
resolved.</p>
|
|
<p>In some cases, the value of the <code>url</code> property is truncated;
|
|
see the <code>isURLInaccessible</code> property for details.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a name="width" class="tsd-anchor"></a>
|
|
<h3>width</h3>
|
|
<div class="tsd-signature tsd-kind-icon">width<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/openfl/blob/9921d3bf/lib/openfl/display/LoaderInfo.d.ts#L389">lib/openfl/display/LoaderInfo.d.ts:389</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The nominal width of the loaded content. This value might differ from the
|
|
actual width at which the content is displayed, since the loaded content
|
|
or its parent display objects might be scaled.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error If the file is not downloaded sufficiently to retrieve the
|
|
requested information.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-inherited 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>, useCapture<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, priority<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, useWeakReference<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#addeventlistener">addEventListener</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L168">lib/openfl/events/EventDispatcher.d.ts:168</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Registers an event listener object with an EventDispatcher object so that
|
|
the listener receives notification of an event. You can register event
|
|
listeners on all nodes in the display list for a specific type of event,
|
|
phase, and priority.</p>
|
|
</div>
|
|
<p>After you successfully register an event listener, you cannot change
|
|
its priority through additional calls to <code>addEventListener()</code>.
|
|
To change a listener's priority, you must first call
|
|
<code>removeListener()</code>. Then you can register the listener again
|
|
with the new priority level.</p>
|
|
<p>Keep in mind that after the listener is registered, subsequent calls to
|
|
<code>addEventListener()</code> with a different <code>type</code> or
|
|
<code>useCapture</code> value result in the creation of a separate
|
|
listener registration. For example, if you first register a listener with
|
|
<code>useCapture</code> set to <code>true</code>, it listens only during
|
|
the capture phase. If you call <code>addEventListener()</code> again using
|
|
the same listener object, but with <code>useCapture</code> set to
|
|
<code>false</code>, you have two separate listeners: one that listens
|
|
during the capture phase and another that listens during the target and
|
|
bubbling phases.</p>
|
|
<p>You cannot register an event listener for only the target phase or the
|
|
bubbling phase. Those phases are coupled during registration because
|
|
bubbling applies only to the ancestors of the target node.</p>
|
|
<p>If you no longer need an event listener, remove it by calling
|
|
<code>removeEventListener()</code>, or memory problems could result. Event
|
|
listeners are not automatically removed from memory because the garbage
|
|
collector does not remove the listener as long as the dispatching object
|
|
exists(unless the <code>useWeakReference</code> parameter is set to
|
|
<code>true</code>).</p>
|
|
<p>Copying an EventDispatcher instance does not copy the event listeners
|
|
attached to it.(If your newly created node needs an event listener, you
|
|
must attach the listener after creating the node.) However, if you move an
|
|
EventDispatcher instance, the event listeners attached to it move along
|
|
with it.</p>
|
|
<p>If the event listener is being registered on a node while an event is
|
|
being processed on this node, the event listener is not triggered during
|
|
the current phase but can be triggered during a later phase in the event
|
|
flow, such as the bubbling phase.</p>
|
|
<p>If an event listener is removed from a node while an event is being
|
|
processed on the node, it is still triggered by the current actions. After
|
|
it is removed, the event listener is never invoked again(unless
|
|
registered again for future processing).</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>ArgumentError The <code>listener</code> specified is not a
|
|
function.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>listener: <span class="tsd-signature-type">function</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-siganture">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <span class="tsd-signature-type">object</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useCapture: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Determines whether the listener works in the
|
|
capture phase or the target and bubbling phases.
|
|
If <code>useCapture</code> is set to
|
|
<code>true</code>, the listener processes the
|
|
event only during the capture phase and not in the
|
|
target or bubbling phase. If
|
|
<code>useCapture</code> is <code>false</code>, the
|
|
listener processes the event only during the
|
|
target or bubbling phase. To listen for the event
|
|
in all three phases, call
|
|
<code>addEventListener</code> twice, once with
|
|
<code>useCapture</code> set to <code>true</code>,
|
|
then again with <code>useCapture</code> set to
|
|
<code>false</code>.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> priority: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The priority level of the event listener. The
|
|
priority is designated by a signed 32-bit integer.
|
|
The higher the number, the higher the priority.
|
|
All listeners with priority <em>n</em> are processed
|
|
before listeners of priority <em>n</em>-1. If two or
|
|
more listeners share the same priority, they are
|
|
processed in the order in which they were added.
|
|
The default priority is 0.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useWeakReference: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Determines whether the reference to the listener
|
|
is strong or weak. A strong reference(the
|
|
default) prevents your listener from being
|
|
garbage-collected. A weak reference does not.</p>
|
|
<pre><code> Class-level member functions are not subject to
|
|
garbage collection, so you can <span class="hljs-keyword">set</span>
|
|
<span class="hljs-string">`useWeakReference`</span> <span class="hljs-keyword">to</span> <span class="hljs-string">`true`</span>
|
|
<span class="hljs-keyword">for</span> <span class="hljs-keyword">class</span>-<span class="hljs-keyword">level</span> <span class="hljs-keyword">member</span> functions <span class="hljs-keyword">without</span>
|
|
subjecting them <span class="hljs-keyword">to</span> garbage collection. <span class="hljs-keyword">If</span> you <span class="hljs-keyword">set</span>
|
|
<span class="hljs-string">`useWeakReference`</span> <span class="hljs-keyword">to</span> <span class="hljs-string">`true`</span>
|
|
<span class="hljs-keyword">for</span> a listener that <span class="hljs-keyword">is</span> a <span class="hljs-keyword">nested</span> <span class="hljs-keyword">inner</span> <span class="hljs-keyword">function</span>,
|
|
the <span class="hljs-keyword">function</span> will be garbage-collected <span class="hljs-keyword">and</span> <span class="hljs-keyword">no</span>
|
|
longer persistent. <span class="hljs-keyword">If</span> you <span class="hljs-keyword">create</span> <span class="hljs-keyword">references</span> <span class="hljs-keyword">to</span> the
|
|
<span class="hljs-keyword">inner</span> <span class="hljs-keyword">function</span>(<span class="hljs-keyword">save</span> it <span class="hljs-keyword">in</span> another <span class="hljs-keyword">variable</span>) <span class="hljs-keyword">then</span>
|
|
it <span class="hljs-keyword">is</span> <span class="hljs-keyword">not</span> garbage-collected <span class="hljs-keyword">and</span> stays
|
|
persistent.
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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="openfl.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">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#dispatchevent">dispatchEvent</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L186">lib/openfl/events/EventDispatcher.d.ts:186</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Dispatches an event into the event flow. The event target is the
|
|
EventDispatcher object upon which the <code>dispatchEvent()</code> method
|
|
is called.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>Error The event dispatch recursion limit has been reached.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <a href="openfl.events.event.html" class="tsd-signature-type">Event</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The Event object that is dispatched into the event flow. If
|
|
the event is being redispatched, a clone of the event is
|
|
created automatically. After an event is dispatched, its
|
|
<code>target</code> property cannot be changed, so you must
|
|
create a new copy of the event for redispatching to work.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>A value of <code>true</code> if the event was successfully
|
|
dispatched. A value of <code>false</code> indicates failure or
|
|
that <code>preventDefault()</code> was called on the event.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="haseventlistener" class="tsd-anchor"></a>
|
|
<h3>has<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">has<wbr>Event<wbr>Listener<span class="tsd-signature-symbol">(</span>type<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">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#haseventlistener">hasEventListener</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L209">lib/openfl/events/EventDispatcher.d.ts:209</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks whether the EventDispatcher object has any listeners registered for
|
|
a specific type of event. This allows you to determine where an
|
|
EventDispatcher object has altered handling of an event type in the event
|
|
flow hierarchy. To determine whether a specific event type actually
|
|
triggers an event listener, use <code>willTrigger()</code>.</p>
|
|
</div>
|
|
<p>The difference between <code>hasEventListener()</code> and
|
|
<code>willTrigger()</code> is that <code>hasEventListener()</code>
|
|
examines only the object to which it belongs, whereas
|
|
<code>willTrigger()</code> examines the entire event flow for the event
|
|
specified by the <code>type</code> parameter.</p>
|
|
<p>When <code>hasEventListener()</code> is called from a LoaderInfo
|
|
object, only the listeners that the caller can access are considered.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>A value of <code>true</code> if a listener of the specified type
|
|
is registered; <code>false</code> otherwise.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a name="removeeventlistener" class="tsd-anchor"></a>
|
|
<h3>remove<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">remove<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>, useCapture<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#removeeventlistener">removeEventListener</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L227">lib/openfl/events/EventDispatcher.d.ts:227</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Removes a listener from the EventDispatcher object. If there is no
|
|
matching listener registered with the EventDispatcher object, a call to
|
|
this method has no effect.</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>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>listener: <span class="tsd-signature-type">function</span></h5>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-siganture">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>event: <span class="tsd-signature-type">object</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useCapture: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Specifies whether the listener was registered for the
|
|
capture phase or the target and bubbling phases. If the
|
|
listener was registered for both the capture phase and
|
|
the target and bubbling phases, two calls to
|
|
<code>removeEventListener()</code> are required to
|
|
remove both, one call with <code>useCapture()</code> set
|
|
to <code>true</code>, and another call with
|
|
<code>useCapture()</code> set to <code>false</code>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class 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="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#tostring">toString</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L230">lib/openfl/events/EventDispatcher.d.ts:230</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="willtrigger" class="tsd-anchor"></a>
|
|
<h3>will<wbr>Trigger</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">will<wbr>Trigger<span class="tsd-signature-symbol">(</span>type<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">
|
|
<p>Inherited from <a href="openfl.events.eventdispatcher.html">EventDispatcher</a>.<a href="openfl.events.eventdispatcher.html#willtrigger">willTrigger</a></p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/events/EventDispatcher.d.ts#L253">lib/openfl/events/EventDispatcher.d.ts:253</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Checks whether an event listener is registered with this EventDispatcher
|
|
object or any of its ancestors for the specified event type. This method
|
|
returns <code>true</code> if an event listener is triggered during any
|
|
phase of the event flow when an event of the specified type is dispatched
|
|
to this EventDispatcher object or any of its descendants.</p>
|
|
</div>
|
|
<p>The difference between the <code>hasEventListener()</code> and the
|
|
<code>willTrigger()</code> methods is that <code>hasEventListener()</code>
|
|
examines only the object to which it belongs, whereas the
|
|
<code>willTrigger()</code> method examines the entire event flow for the
|
|
event specified by the <code>type</code> parameter.</p>
|
|
<p>When <code>willTrigger()</code> is called from a LoaderInfo object,
|
|
only the listeners that the caller can access are considered.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The type of event.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>A value of <code>true</code> if a listener of the specified type
|
|
will be triggered; <code>false</code> otherwise.</p>
|
|
</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/openfl.desktop.html">openfl.desktop</a>
|
|
</li>
|
|
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display.html">openfl.display</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display3d.html">openfl.display3D</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.errors.html">openfl.errors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.events.html">openfl.events</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.external.html">openfl.external</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.filters.html">openfl.filters</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.geom.html">openfl.geom</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.media.html">openfl.media</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.net.html">openfl.net</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.profiler.html">openfl.profiler</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.sensors.html">openfl.sensors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.system.html">openfl.system</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.text.html">openfl.text</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.ui.html">openfl.ui</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.utils.html">openfl.utils</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html" class="tsd-kind-icon">Loader<wbr>Info</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#applicationdomain" class="tsd-kind-icon">application<wbr>Domain</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#bytes" class="tsd-kind-icon">bytes</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#bytesloaded" class="tsd-kind-icon">bytes<wbr>Loaded</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#bytestotal" class="tsd-kind-icon">bytes<wbr>Total</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#childallowsparent" class="tsd-kind-icon">child<wbr>Allows<wbr>Parent</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#content" class="tsd-kind-icon">content</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#contenttype" class="tsd-kind-icon">content<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#framerate" class="tsd-kind-icon">frame<wbr>Rate</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#height" class="tsd-kind-icon">height</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#loader" class="tsd-kind-icon">loader</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#loaderurl" class="tsd-kind-icon">loaderURL</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#parameters" class="tsd-kind-icon">parameters</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#parentallowschild" class="tsd-kind-icon">parent<wbr>Allows<wbr>Child</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#samedomain" class="tsd-kind-icon">same<wbr>Domain</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#sharedevents" class="tsd-kind-icon">shared<wbr>Events</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#uncaughterrorevents" class="tsd-kind-icon">uncaught<wbr>Error<wbr>Events</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#url" class="tsd-kind-icon">url</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#width" class="tsd-kind-icon">width</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#addeventlistener" class="tsd-kind-icon">add<wbr>Event<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.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="openfl.display.loaderinfo.html#haseventlistener" class="tsd-kind-icon">has<wbr>Event<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.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="openfl.display.loaderinfo.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external">
|
|
<a href="openfl.display.loaderinfo.html#willtrigger" class="tsd-kind-icon">will<wbr>Trigger</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="http://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> |