Hilo/docs/api-zh/symbols/LoadQueue.html
2019-05-27 11:41:53 +08:00

1028 lines
31 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="JsDoc Toolkit"/>
<title>LoadQueue - Hilo API 参考文档</title>
<style>
iframe{
border:1px solid #333;
}
</style>
<link href="../../bootstrap3.0.3/css/bootstrap.min.css" rel="stylesheet">
<link href="../../bootstrap3.0.3/css/bootstrap-theme.min.css" rel="stylesheet">
<link href="../../css/prettify.min.css" rel="stylesheet">
<link href="../../css/api.min.css" rel="stylesheet">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="#">
<span>Hilo</span><span></span>
</a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="//hiloteam.github.io/index.html">首页</a></li>
<li><a href="//github.com/hiloteam/Hilo" target="_blank">源码下载</a></li>
<li class="active"><a href="../index.html">API文档</a></li>
<li><a href="//hiloteam.github.io/tutorial/index.html">教程文档</a></li>
<li><a href="//hiloteam.github.io/examples/index.html">作品演示</a></li>
</u>
</div>
</div>
</div>
<div class="container main">
<div class="col-md-3">
<div class="bs-sidebar well">
<!-- <div class="hilo-header">类列表</div> -->
<ul class="nav bs-sidenav">
<li class="nav-pkg">core<span></span></li>
<li class="nav-class"><a href="../symbols/Class.html">Class</a></li>
<li class="nav-class"><a href="../symbols/Hilo.html">Hilo</a></li>
<li class="nav-pkg">event<span></span></li>
<li class="nav-class"><a href="../symbols/EventMixin.html">EventMixin</a></li>
<li class="nav-pkg">game<span></span></li>
<li class="nav-class"><a href="../symbols/Camera.html">Camera</a></li>
<li class="nav-class"><a href="../symbols/Camera3d.html">Camera3d</a></li>
<li class="nav-class"><a href="../symbols/ParticleSystem.html">ParticleSystem</a></li>
<li class="nav-pkg">geom<span></span></li>
<li class="nav-class"><a href="../symbols/Matrix.html">Matrix</a></li>
<li class="nav-pkg">loader<span></span></li>
<li class="nav-class"><a href="../symbols/LoadQueue.html">LoadQueue</a></li>
<li class="nav-pkg">media<span></span></li>
<li class="nav-class"><a href="../symbols/HTMLAudio.html">HTMLAudio</a></li>
<li class="nav-class"><a href="../symbols/WebAudio.html">WebAudio</a></li>
<li class="nav-class"><a href="../symbols/WebSound.html">WebSound</a></li>
<li class="nav-pkg">renderer<span></span></li>
<li class="nav-class"><a href="../symbols/CanvasRenderer.html">CanvasRenderer</a></li>
<li class="nav-class"><a href="../symbols/DOMRenderer.html">DOMRenderer</a></li>
<li class="nav-class"><a href="../symbols/Renderer.html">Renderer</a></li>
<li class="nav-class"><a href="../symbols/WebGLRenderer.html">WebGLRenderer</a></li>
<li class="nav-pkg">tween<span></span></li>
<li class="nav-class"><a href="../symbols/Ease.html">Ease</a></li>
<li class="nav-class"><a href="../symbols/Tween.html">Tween</a></li>
<li class="nav-pkg">util<span></span></li>
<li class="nav-class"><a href="../symbols/TextureAtlas.html">TextureAtlas</a></li>
<li class="nav-class"><a href="../symbols/Ticker.html">Ticker</a></li>
<li class="nav-class"><a href="../symbols/browser.html">browser</a></li>
<li class="nav-class"><a href="../symbols/drag.html">drag</a></li>
<li class="nav-class"><a href="../symbols/util.html">util</a></li>
<li class="nav-pkg">view<span></span></li>
<li class="nav-class"><a href="../symbols/Bitmap.html">Bitmap</a></li>
<li class="nav-class"><a href="../symbols/BitmapText.html">BitmapText</a></li>
<li class="nav-class"><a href="../symbols/Button.html">Button</a></li>
<li class="nav-class"><a href="../symbols/CacheMixin.html">CacheMixin</a></li>
<li class="nav-class"><a href="../symbols/Container.html">Container</a></li>
<li class="nav-class"><a href="../symbols/DOMElement.html">DOMElement</a></li>
<li class="nav-class"><a href="../symbols/Drawable.html">Drawable</a></li>
<li class="nav-class"><a href="../symbols/Graphics.html">Graphics</a></li>
<li class="nav-class"><a href="../symbols/Sprite.html">Sprite</a></li>
<li class="nav-class"><a href="../symbols/Stage.html">Stage</a></li>
<li class="nav-class"><a href="../symbols/Text.html">Text</a></li>
<li class="nav-class"><a href="../symbols/View.html">View</a></li>
</ul>
</div>
</div>
<div class="col-md-9">
<!-- ============================== class title ============================ -->
<h1 style="margin-top:0;">
LoadQueue
</h1><hr style="margin-top:10px;" />
<!-- ============================== class summary ========================== -->
<p class="description">
<span style="display:block;margin:0 0 2px 0;">
<b style="margin-right:10px;">模块</b> hilo/loader/LoadQueue
</span>
<span style="display:block;margin:0 0 2px 0;">
<b style="margin-right:10px;">依赖</b>
<span><a href="../symbols/Class.html">hilo/core/Class</a></span>, <span><a href="../symbols/EventMixin.html">hilo/event/EventMixin</a></span>, <span>hilo/loader/ImageLoader</span>, <span>hilo/loader/ScriptLoader</span>
</span>
<span style="display:block;margin:0 0 2px 0;">
<b style="margin-right:10px;">源码</b>
<a href="../symbols/src/docs_api-zh_code_loader_LoadQueue.js.html">LoadQueue.js</a>
</span>
<br>
LoadQueue是一个队列下载工具。
</p>
<!-- ============================== properties summary ===================== -->
<div style="margin:30px 0 5px 0;">
<h3 style="display:inline;margin-right:10px;">属性概览</h3>
</div>
<table class="table table-striped table-bordered table-condensed table-symbol" cellspacing="0">
<thead>
<tr>
<th scope="col"></th>
<th scope="col">属性</th>
<th scope="col">定义于</th>
</tr>
</thead>
<tbody>
<tr >
<td>
</td>
<td class="fixedFont">
<div>
<!-- -->
<b><a href="../symbols/LoadQueue.html#maxConnections">maxConnections</a></b>:Int
</div>
<div class="description">
同时下载的最大连接数。默认为2。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
</tbody>
</table>
<script type="text/javascript">
function toggleProperties(){
var alink = $('#propToggleIcon');
if(alink.hasClass('glyphicon-circle-arrow-right')){
alink.removeClass('glyphicon-circle-arrow-right');
alink.addClass('glyphicon-circle-arrow-down');
$('#propToggleTip').html('隐藏继承属性');
$('.inheritProp').show();
}else{
alink.removeClass('glyphicon-circle-arrow-down');
alink.addClass('glyphicon-circle-arrow-right');
$('#propToggleTip').html('显示继承属性');
$('.inheritProp').hide();
}
}
</script>
<!-- ============================== methods summary ======================== -->
<div style="margin:30px 0 5px; 0">
<h3 style="display:inline;margin-right:10px;">方法概览</h3>
</div>
<table class="table table-striped table-bordered table-condensed table-symbol" cellspacing="0">
<thead>
<tr>
<th scope="col"></th>
<th scope="col">方法</th>
<th scope="col">定义于</th>
</tr>
</thead>
<tbody>
<tr>
<td></td>
<td>
<div class="fixedFont">
<b><a href="#constructor">LoadQueue</a></b>(source:Object)
</div>
<div class="description">构造函数</div>
</td>
<td>LoadQueue</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#add">add</a></b>(source:Object|Array):LoadQueue
</div>
<div class="description">
增加要下载的资源。可以是单个资源对象或多个资源的数组。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#fire">fire</a></b>(type:String, detail:Object):Boolean
</div>
<div class="description">
发送事件。当第一个参数类型为Object时则把它作为一个整体事件对象。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#get">get</a></b>(id:String):Object
</div>
<div class="description">
根据id或src地址获取资源对象。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#getContent">getContent</a></b>(id:String):Object
</div>
<div class="description">
根据id或src地址获取资源内容。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#getLoaded">getLoaded</a></b>():Uint
</div>
<div class="description">
获取已下载的资源数量。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#getSize">getSize</a></b>(loaded:Boolean):Number
</div>
<div class="description">
获取全部或已下载的资源的字节大小。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#getTotal">getTotal</a></b>():Uint
</div>
<div class="description">
获取所有资源的数量。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#off">off</a></b>(type:String, listener:Function):Object
</div>
<div class="description">
删除一个事件监听。如果不传入任何参数,则删除所有的事件监听;如果不传入第二个参数,则删除指定类型的所有事件监听。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#on">on</a></b>(type:String, listener:Function, once:Boolean):Object
</div>
<div class="description">
增加一个事件监听。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#removeContent">removeContent</a></b>(id:String)
</div>
<div class="description">
根据id或src地址删除资源内容。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
<tr >
<td>
</td>
<td class="fixedFont">
<div><b><a href="../symbols/LoadQueue.html#start">start</a></b>():LoadQueue
</div>
<div class="description">
开始下载队列。
</div>
</td>
<td>
LoadQueue
</td>
</tr>
</tbody>
</table>
<script type="text/javascript">
function toggleMethods(){
var alink = $('#methodToggleIcon');
if(alink.hasClass('glyphicon-circle-arrow-right')){
alink.removeClass('glyphicon-circle-arrow-right');
alink.addClass('glyphicon-circle-arrow-down');
$('#methodToggleTip').html('隐藏继承方法');
$('.inheritMethod').show();
}else{
alink.removeClass('glyphicon-circle-arrow-down');
alink.addClass('glyphicon-circle-arrow-right');
$('#methodToggleTip').html('显示继承方法');
$('.inheritMethod').hide();
}
}
</script>
<!-- ============================== field details ========================== -->
<br/>
<div class="">
<h3 style="margin-bottom:15px;">属性详情</h3>
</div>
<a class="anchor" name="maxConnections"> </a>
<div class="member-box">
<div class="member-header">
<b>maxConnections</b><span class="light">:Int</span>
</div>
<div class="description">
同时下载的最大连接数。默认为2。
</div>
</div>
<!-- ============================== constructor details ==================== -->
<br/>
<div class="details">
<a class="anchor" name="constructor"> </a>
<div class="">
<h3 style="margin-bottom:15px;">构造函数</h3>
</div>
<div class="member-box">
<div class="member-header">
<b>LoadQueue</b>(source:Object)
</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>source</b>:<span>Object</span>
— 要下载的资源。可以是单个资源对象或多个资源的数组。
</dt>
</dl>
</div>
</div>
<!-- ============================== method details ========================= -->
<br/>
<div class=""><h3 style="margin-bottom:15px;">方法详情</h3></div>
<a class="anchor" name="add"> </a>
<div class="member-box">
<div class="member-header">
<b>add</b>(source:Object|Array):<span class="light"><a href="../symbols/LoadQueue.html">LoadQueue</a></span>
</div>
<div class="description">增加要下载的资源。可以是单个资源对象或多个资源的数组。</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>source</b>:<span>Object|Array</span>
— 资源对象或资源对象数组。每个资源对象包含以下属性:
<ul>
<li><b>id</b> - 资源的唯一标识符。可用于从下载队列获取目标资源。</li>
<li><b>src</b> - 资源的地址url。</li>
<li><b>type</b> - 指定资源的类型。默认会根据资源文件的后缀来自动判断类型,不同的资源类型会使用不同的加载器来加载资源。</li>
<li><b>loader</b> - 指定资源的加载器。默认会根据资源类型来自动选择加载器若指定loader则会使用指定的loader来加载资源。</li>
<li><b>noCache</b> - 指示加载资源时是否增加时间标签以防止缓存。</li>
<li><b>size</b> - 资源对象的预计大小。可用于预估下载进度。</li>
<li><b>crossOrigin</b> - 是否需要跨域,默认否。</li>
</ul>
</dt>
</dl>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span><a href="../symbols/LoadQueue.html">LoadQueue</a></span> — 下载队列实例本身。</dd>
</dl>
</div>
<a class="anchor" name="fire"> </a>
<div class="member-box">
<div class="member-header">
<b>fire</b>(type:String, detail:Object):<span class="light">Boolean</span>
</div>
<div class="description">发送事件。当第一个参数类型为Object时则把它作为一个整体事件对象。</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>type</b>:<span>String</span>
— 要发送的事件类型。
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>detail</b>:<span>Object</span>
— 要发送的事件的具体信息,即事件随带参数。
</dt>
</dl>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span>Boolean</span> — 是否成功调度事件。</dd>
</dl>
</div>
<a class="anchor" name="get"> </a>
<div class="member-box">
<div class="member-header">
<b>get</b>(id:String):<span class="light">Object</span>
</div>
<div class="description">根据id或src地址获取资源对象。</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>id</b>:<span>String</span>
— 指定资源的id或src。
</dt>
</dl>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span>Object</span> — 资源对象。</dd>
</dl>
</div>
<a class="anchor" name="getContent"> </a>
<div class="member-box">
<div class="member-header">
<b>getContent</b>(id:String):<span class="light">Object</span>
</div>
<div class="description">根据id或src地址获取资源内容。</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>id</b>:<span>String</span>
— 指定资源的id或src。
</dt>
</dl>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span>Object</span> — 资源内容。</dd>
</dl>
</div>
<a class="anchor" name="getLoaded"> </a>
<div class="member-box">
<div class="member-header">
<b>getLoaded</b>():<span class="light">Uint</span>
</div>
<div class="description">获取已下载的资源数量。</div>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span>Uint</span> — 已下载的资源数量。</dd>
</dl>
</div>
<a class="anchor" name="getSize"> </a>
<div class="member-box">
<div class="member-header">
<b>getSize</b>(loaded:Boolean):<span class="light">Number</span>
</div>
<div class="description">获取全部或已下载的资源的字节大小。</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>loaded</b>:<span>Boolean</span>
— 指示是已下载的资源还是全部资源。默认为全部。
</dt>
</dl>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span>Number</span> — 指定资源的字节大小。</dd>
</dl>
</div>
<a class="anchor" name="getTotal"> </a>
<div class="member-box">
<div class="member-header">
<b>getTotal</b>():<span class="light">Uint</span>
</div>
<div class="description">获取所有资源的数量。</div>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span>Uint</span> — 所有资源的数量。</dd>
</dl>
</div>
<a class="anchor" name="off"> </a>
<div class="member-box">
<div class="member-header">
<b>off</b>(type:String, listener:Function):<span class="light">Object</span>
</div>
<div class="description">删除一个事件监听。如果不传入任何参数,则删除所有的事件监听;如果不传入第二个参数,则删除指定类型的所有事件监听。</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>type</b>:<span>String</span>
— 要删除监听的事件类型。
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>listener</b>:<span>Function</span>
— 要删除监听的回调函数。
</dt>
</dl>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span>Object</span> — 对象本身。链式调用支持。</dd>
</dl>
</div>
<a class="anchor" name="on"> </a>
<div class="member-box">
<div class="member-header">
<b>on</b>(type:String, listener:Function, once:Boolean):<span class="light">Object</span>
</div>
<div class="description">增加一个事件监听。</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>type</b>:<span>String</span>
— 要监听的事件类型。
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>listener</b>:<span>Function</span>
— 事件监听回调函数。
</dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>once</b>:<span>Boolean</span>
— 是否是一次性监听,即回调函数响应一次后即删除,不再响应。
</dt>
</dl>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span>Object</span> — 对象本身。链式调用支持。</dd>
</dl>
</div>
<a class="anchor" name="removeContent"> </a>
<div class="member-box">
<div class="member-header">
<b>removeContent</b>(id:String)
</div>
<div class="description">根据id或src地址删除资源内容。</div>
<dl class="detailList">
<dt class="heading"><span class="label">parameters</span></dt>
<dt style="margin-left:20px;font-weight:normal;">
<b>id</b>:<span>String</span>
— 指定资源的id或src。
</dt>
</dl>
</div>
<a class="anchor" name="start"> </a>
<div class="member-box">
<div class="member-header">
<b>start</b>():<span class="light"><a href="../symbols/LoadQueue.html">LoadQueue</a></span>
</div>
<div class="description">开始下载队列。</div>
<dl class="detailList">
<dt class="heading"><span class="label">return</span></dt>
<dd style="margin-left:20px;font-weight:normal;"><span><a href="../symbols/LoadQueue.html">LoadQueue</a></span> — 下载队列实例本身。</dd>
</dl>
</div>
</div>
</div>
<footer class="col-md-12">
<hr>
<p>&copy; Hilo 2016</p>
</footer>
<script src="../../js/jquery.min.js"></script>
<script src="../../bootstrap3.0.3/js/bootstrap.min.js"></script>
<script src="../../js/prettify.min.js"></script>
<script type="text/javascript">
//make code pretty
$('pre').addClass('prettyprint linenums fixedFont');
window.prettyPrint && prettyPrint();
</script>
</body>
</html>