Package | laya.net |
Class | public class Loader |
Inheritance | Loader EventDispatcher Object |
Loader
类可用来加载文本、JSON、XML、二进制、图像等资源。
Property | Defined By | ||
---|---|---|---|
cache : Boolean [read-only] 是否缓存。 | Loader | ||
data : * [read-only] 返回的数据。 | Loader | ||
maxTimeOut : int = 100 [static] 每帧回调最大超时时间,如果超时,则下帧再处理。 | Loader | ||
parserMap : Object [static] 资源解析函数对应表,用来扩展更多类型的资源加载解析。 | Loader | ||
type : String [read-only] 加载类型。 | Loader | ||
typeMap : Object [static] 文件后缀和类型对应表。 | Loader | ||
url : String [read-only] 加载地址。 | Loader |
Method | Defined By | ||
---|---|---|---|
cacheRes(url:String, data:*):void [static]
缓存资源。
| Loader | ||
clearRes(url:String, forceDispose:Boolean = false):void [static]
清理指定资源地址的缓存。
| Loader | ||
clearResByGroup(group:String):void [static]
根据分组清理资源。
| Loader | ||
endLoad(content:* = null):void
结束加载,处理是否缓存及派发完成事件 Event.COMPLETE 。
| Loader | ||
event(type:String, data:* = null):Boolean
派发事件。
| EventDispatcher | ||
getAtlas(url:String):Array [static]
获取指定资源地址的图集地址列表。
| Loader | ||
getRes(url:String):* [static]
获取指定资源地址的资源。
| Loader | ||
hasListener(type:String):Boolean
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
| EventDispatcher | ||
isMouseEvent(type:String):Boolean
检测指定事件类型是否是鼠标事件。
| EventDispatcher | ||
load(url:String, type:String = null, cache:Boolean = true, group:String = null, ignoreCache:Boolean = false):void
加载资源。加载错误会派发 Event.ERROR 事件,参数为错误信息。
| Loader | ||
off(type:String, caller:*, listener:Function, onceOnly:Boolean = false):EventDispatcher
从 EventDispatcher 对象中删除侦听器。
| EventDispatcher | ||
offAll(type:String = null):EventDispatcher
从 EventDispatcher 对象中删除指定事件类型的所有侦听器。
| EventDispatcher | ||
on(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
使用 EventDispatcher 对象注册指定类型的事件侦听器对象,以使侦听器能够接收事件通知。
| EventDispatcher | ||
once(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher
使用 EventDispatcher 对象注册指定类型的事件侦听器对象,以使侦听器能够接收事件通知,此侦听事件响应一次后自动移除。
| EventDispatcher | ||
setAtlasConfigs(url:String, config:Object):void [static]
设置预加载的图集配置文件
| Loader | ||
setGroup(url:String, group:String):void [static]
设置资源分组。
| Loader |
Method | Defined By | ||
---|---|---|---|
complete(data:*):void
加载完成。
| Loader | ||
getTypeFromUrl(url:String):String
获取指定资源地址的数据类型。
| Loader | ||
onLoaded(data:* = null):void
资源加载完成的处理函数。
| Loader |
Event | Summary | Defined By | ||
---|---|---|---|---|
加载完成后调度。 | Loader | |||
加载出错时调度。 | Loader | |||
加载进度发生改变时调度。 | Loader |
Constant | Defined By | ||
---|---|---|---|
ATLAS : String = atlas [static] 图集类型,加载完成后返回图集json信息(并创建图集内小图Texture)。 | Loader | ||
BUFFER : String = arraybuffer [static] 二进制类型,加载完成后返回arraybuffer二进制数据。 | Loader | ||
FONT : String = font [static] 位图字体类型,加载完成后返回BitmapFont。 | Loader | ||
groupMap : Object [static] 资源分组对应表。 | Loader | ||
IMAGE : String = image [static] 纹理类型,加载完成后返回Texture。 | Loader | ||
JSON : String = json [static] JSON 类型,加载完成后返回json数据。 | Loader | ||
PKM : String = pkm [static] | Loader | ||
SOUND : String = sound [static] 声音类型,加载完成后返回sound。 | Loader | ||
TEXT : String = text [static] 文本类型,加载完成后返回文本。 | Loader | ||
XML : String = xml [static] XML 类型,加载完成后返回domXML。 | Loader |
cache | property |
cache:Boolean
[read-only] 是否缓存。
public function get cache():Boolean
data | property |
data:*
[read-only] 返回的数据。
public function get data():*
maxTimeOut | property |
public static var maxTimeOut:int = 100
每帧回调最大超时时间,如果超时,则下帧再处理。
parserMap | property |
public static var parserMap:Object
资源解析函数对应表,用来扩展更多类型的资源加载解析。
type | property |
type:String
[read-only] 加载类型。
public function get type():String
typeMap | property |
public static var typeMap:Object
文件后缀和类型对应表。
url | property |
url:String
[read-only] 加载地址。
public function get url():String
cacheRes | () | method |
public static function cacheRes(url:String, data:*):void
缓存资源。
Parameters
url:String — 资源地址。
| |
data:* — 要缓存的内容。
|
clearRes | () | method |
public static function clearRes(url:String, forceDispose:Boolean = false):void
清理指定资源地址的缓存。
Parameters
url:String — 资源地址。
| |
forceDispose:Boolean (default = false ) — 是否强制销毁,有些资源是采用引用计数方式销毁,如果forceDispose=true,则忽略引用计数,直接销毁,比如Texture,默认为false
|
clearResByGroup | () | method |
public static function clearResByGroup(group:String):void
根据分组清理资源。
Parameters
group:String — 分组名。
|
complete | () | method |
protected function complete(data:*):void
加载完成。
Parameters
data:* — 加载的数据。
|
endLoad | () | method |
public function endLoad(content:* = null):void
结束加载,处理是否缓存及派发完成事件 Event.COMPLETE
。
Parameters
content:* (default = null ) — 加载后的数据
|
getAtlas | () | method |
public static function getAtlas(url:String):Array
获取指定资源地址的图集地址列表。
Parameters
url:String — 图集地址。
|
Array — 返回地址集合。
|
getRes | () | method |
public static function getRes(url:String):*
获取指定资源地址的资源。
Parameters
url:String — 资源地址。
|
* — 返回资源。
|
getTypeFromUrl | () | method |
protected function getTypeFromUrl(url:String):String
获取指定资源地址的数据类型。
Parameters
url:String — 资源地址。
|
String — 数据类型。
|
load | () | method |
public function load(url:String, type:String = null, cache:Boolean = true, group:String = null, ignoreCache:Boolean = false):void
加载资源。加载错误会派发 Event.ERROR 事件,参数为错误信息。
Parameters
url:String — 资源地址。
| |
type:String (default = null ) — (default = null)资源类型。可选值为:Loader.TEXT、Loader.JSON、Loader.XML、Loader.BUFFER、Loader.IMAGE、Loader.SOUND、Loader.ATLAS、Loader.FONT。如果为null,则根据文件后缀分析类型。
| |
cache:Boolean (default = true ) — (default = true)是否缓存数据。
| |
group:String (default = null ) — (default = null)分组名称。
| |
ignoreCache:Boolean (default = false ) — (default = false)是否忽略缓存,强制重新加载。
|
onLoaded | () | method |
protected function onLoaded(data:* = null):void
资源加载完成的处理函数。
Parameters
data:* (default = null ) — 数据。
|
setAtlasConfigs | () | method |
public static function setAtlasConfigs(url:String, config:Object):void
设置预加载的图集配置文件
Parameters
url:String — 资源地址。
| |
config:Object — 配置数据
|
setGroup | () | method |
public static function setGroup(url:String, group:String):void
设置资源分组。
Parameters
url:String — 资源地址。
| |
group:String — 分组名。
|
complete | Event |
error | Event |
progress | Event |
ATLAS | Constant |
public static const ATLAS:String = atlas
图集类型,加载完成后返回图集json信息(并创建图集内小图Texture)。
BUFFER | Constant |
public static const BUFFER:String = arraybuffer
二进制类型,加载完成后返回arraybuffer二进制数据。
FONT | Constant |
public static const FONT:String = font
位图字体类型,加载完成后返回BitmapFont。
groupMap | Constant |
public static const groupMap:Object
资源分组对应表。
IMAGE | Constant |
public static const IMAGE:String = image
纹理类型,加载完成后返回Texture。
JSON | Constant |
public static const JSON:String = json
JSON 类型,加载完成后返回json数据。
PKM | Constant |
public static const PKM:String = pkm
SOUND | Constant |
public static const SOUND:String = sound
声音类型,加载完成后返回sound。
TEXT | Constant |
public static const TEXT:String = text
文本类型,加载完成后返回文本。
XML | Constant |
public static const XML:String = xml
XML 类型,加载完成后返回domXML。