迷你小引擎的资源管理

Constructor

new ()

Variables

@:value([])@:keephaxeMaps:Map<String, MiniEngineHaxe> = []

@:value("Main")@:keepmainClassName:String = "Main"

@:value(null)@:keeppath:String = null

@:value([])@:keepstaticData:Map<String, Dynamic> = []

模拟静态属性

Methods

@:value({ mainClassName : "Main" })@:keepcreateApp (parent:DisplayObject, call:Builder ‑> Void, mainClassName:String = "Main"):Void

创建APP,注意第一次调用一般为异步,第二次调用一般为同步,多次创建会重新new对象。

Parameters:

parent
null

call

@:keepgetApp ():MiniEngineScene

获取当前运行的APP迷你内置小程序

Returns:

MiniEngineScene

@:keepdynamiconParsingHaxeData (name:String, haxeData:Xml):Xml

解析HaxeData

Parameters:

haxeData

Returns:

Xml

@:keepunloadAll ():Void

卸载所有逻辑,内置小程序使用的内存,应由小程序自主移除。

Inherited Variables

Defined by ZAssets

@:value(false)canError:Bool = false

@:value(new Map())extPasrer:Map<String, String> = new Map()

扩展格式解析器,例如命名为data,实际为xml时,则可以设置扩展命名映射 extPasrer.set("data","xml");

@:value(5)maxLoadNumber:Int = 5

最大可同时加载数量

Inherited Methods

Defined by ZAssets

buildMesh3D (id:String):Dynamic

创建Mesh副本

Parameters:

id

Returns:

if zygame3d away3d.entities.Mesh #else Dynamic #end

buildObject3D (id:String):Dynamic

创建3D对象

Parameters:

null

id

@:value({ autoWarp : false, color : 0xffffff })cacheText (id:String, text:String, fontName:String, size:UInt, color:UInt = 0xffffff, autoWarp:Bool = false):Void

缓存文本

Parameters:

id

缓存ID,通过getTextAtlas获取精灵表时使用的ID标记

text

需要缓存的文字

fontName

缓存字体

size

缓存文字大小

color

缓存的颜色

autoWarp

是否自动换行,这将会减少约1半的可用字的数量,HTML5无效化不可用(HTML5平台采取了更优的方案进行渲染)

create3DParticleGroup (name:String):Dynamic

创建3D容器

Parameters:

name

Returns:

if zygame3d away3d.entities.ParticleGroup #else Dynamic #end

createSpineSpriteSkeleton (atalsName:String, skeletonJsonName:String):SkeletonAnimation

创建Sprite渲染器的Spine骨骼

Parameters:

atalsName
skeletonJsonName

Returns:

spine.openfl.SkeletonAnimation

createSpineTilemapSkeleton (atalsName:String, skeletonJsonName:String):SkeletonAnimation

创建Tilemap渲染器的Spine骨骼

Parameters:

atalsName
skeletonJsonName

Returns:

spine.tilemap.SkeletonAnimation

existZipAssets (id:String, type:String):Bool

检查压缩包中是否含有对应的文件

Parameters:

id
null

type

get3DMesh (id:String):Dynamic

获取3DMesh对象

Parameters:

id

Returns:

away3d.entities.Mesh

getAsepriteTextureAtlas (id:String):AsepriteTextureAtlas

获取Aseprite的精灵图对象

Returns:

AsepriteTextureAtlas

@:value({ foundAtlas : false })getBitmapData (id:String, foundAtlas:Bool = false):Dynamic

获取位图数据

 *  @param id -
 *  @return BitmapData 这里获取的精灵表中的位图数据,将会是BitmapDataFrame对象。

getCDBData (id:String):CDBData

获取CDB的数据

Parameters:

id

Returns:

CDBData

getCurrentBGMusicID ():String

获取当前播放的ID

Returns:

String

getDynamicTextureAtlas (id:String):DynamicTextureAtlas

获取动态纹理集合

Parameters:

id

Returns:

DynamicTextureAtlas

getFntData (id:String):FntData

获取位图文本数据

Parameters:

id

Returns:

FntData

getLDTKProject (id:String):Dynamic

获取LDTK编辑的地图数据,请注意,需要引入zygameui-ldtk库才能正常使用。

Parameters:

id

Returns:

if ldtk zygame.ldtk.LDTKProject #else Dynamic #end

getMapliveData (id:String):MapliveData

获取MapliveData数据

Parameters:

id

Returns:

MapliveData

getMovieClip (id:String):MovieClip

获取MovieClip对象,SWF名:SWF映射

Parameters:

id

Returns:

MovieClip

getMusic (id:String):Music

获取音乐

Parameters:

id

Returns:

Music

getObject (id:String):Dynamic

获取JSON对象

 *  @param id -
 *  @return Dynamic

getProgress ():Float

当前资源器的载入进度(精细化)

Returns:

Float

getSound (id:String):Sound

获取音乐

Parameters:

id

Returns:

Sound

getSpineSpriteSkeletonData (atlasAndJson:String):SkeletonData

获取SkeletonData

Parameters:

atlasAndJson

纹理名:JSON名

Returns:

spine.SkeletonData

getSpineTextureAlats (atalsName:String):SpineTextureAtals

获取纹理集

Parameters:

atalsName

Returns:

SpineTextureAtals

getSpineTilemapSkeletonData (atlasAndJson:String):SkeletonData

获取SkeletonData(Tilemap)

Parameters:

atlasAndJson

纹理名:JSON名

Returns:

spine.SkeletonData

getString (id:String):String

获取字符串

Parameters:

id

Returns:

String

getTextAtlas (id:String):TextureAtlas

获取文本精灵表

Parameters:

id

Returns:

TextureAtlas

getTextureAtlas (id:String):TextureAtlas

获取纹理集合

 *  @param id -
 *  @return TextureAtlas

getXml (id:String):Xml

获取Xml格式

 *  @param id -
 *  @return Xml

getZLoader3D (id:String):Dynamic

根据ID获取3D的加载数据

Returns:

ZLoader3D

getZip (id:String):Zip

获取Zip数据包

Parameters:

id

Returns:

Zip

load3DFile (path:String):Void

加载3D文件

Parameters:

path

3D文件

contextFiles

该3D文件关联的文件,如动画文件。

loadAsepriteTextureAtlas (texPath:String, jsonPath:String):Void

加载Aseprite生成的JSONTextureAtlas精灵图

Parameters:

texPath
null

jsonPath

loadAssetsZip (path:String):Void

加载Zip资源包

Parameters:

null

path

loadBase64SpineTextAlats (texPaths:Array<{path:String, base64data:String}>, jsonData:String, texJsonPath:String):Void

加载Base64Spine纹理集资源

Parameters:

texPaths

需要提供路径/base64数据,支持多纹理

jsonData

纹理json数据

texJsonPath

纹理json路径

loadBase64Textures (imgBase64:String, xmlString:String, filename:String, isAtf:Bool):Void

以Base64格式加载资源

Parameters:

imgBase64

图片base64格式数据

xmlString

xml字符串数据

filename

储存到assets中的映射名

null

isAtf

loadDynamicTextureAtlasImage (atlasName:String, path:String):Void

加载动态纹理图

Parameters:

atlasName
null

path

loadFile (data:Dynamic):Void

载入单个文件

 *  @param path -

loadFiles (arr:Array<String>):Void

载入资源列表

 *  @param arr -

loadFnt (pngPath:String, xmlPath:String):Void

载入位图字体

Parameters:

pngPath
null

xmlPath

loadMapliveData (bundlePath:String):Void

载入Maplive2格式数据资源

Parameters:

null

bundlePath

loadMusic (path:String):Void

加载音乐

Parameters:

null

path

loadSpineTextAlats (texPaths:Array<String>, texJsonPath:String):Void

加载Spine纹理集资源

Parameters:

texPath
texJsonPath

该参数可以传入数组,支持多纹理加载

@:value({ isZip : true })loadSwfliteFile (path:String, isZip:Bool = true):Void

加载SWFLite压缩文件

Parameters:

path

加载路径

isZip

是否为压缩包,默认为压缩包

@:value({ isAtf : false, xml : null })loadTextures (img:String, ?xml:String, isAtf:Bool = false):Void

载入纹理资源

 *  @param img 如果只传递图片,xml会直接识别图片资源
 *  @param xml -

dynamiconPasingPathName (path:String):String

用于重写解析路径名称

Parameters:

path

Returns:

String

playBGMusic (id:String):Void

播放背景音乐

Parameters:

null

id

@:value({ loop : 1 })playSound (id:String, loop:Int = 1):SoundChannel

播放音效,如果需要操作复杂的,可使用getSound()方法进行实现

Parameters:

id
null

loop

putTextureAtlas (id:String, textureAtlas:TextureAtlas):Void

追加纹理集合

 *  @param id -
 *  @param textureAtlas -

removeBitmapData (id:String):Void

删除指定ID的位图数据

Parameters:

null

id

removeCDBData (id:String):Void

删除CDB的数据

Parameters:

null

id

removeFnt (id:String):Void

卸载Fnt资源

Parameters:

null

id

removeMapliveData (id:String):Void

卸载MapliveData的数据

Parameters:

null

id

removeMusic (id:String):Void

删除音乐

Parameters:

null

id

removeSound (id:String):Void

删除指定ID的音频数据

Parameters:

null

id

removeSpineTextureAtlas (id:String):Void

卸载SpineTextureAtlas资源

Parameters:

null

id

removeTextCache (id:String):Void

删除指定的缓存对象

Parameters:

null

id

removeTextureAtlas (id:String):Void

setBitmapData (id:String, bitmapData:BitmapData):Void

手动设置位图

Parameters:

id
null

bitmapData

setMusic (id:String, data:Music):Void

setObject (id:String, data:Dynamic):Void

设置JSON对象

Parameters:

id
null

data

setSound (id:String, sound:Sound):Void

设置音频对象

Parameters:

id
null

sound

setXml (id:String, xml:Xml):Void

设置Xml格式对象

Parameters:

id
null

xml

setZLoader3D (id:String, loader:Dynamic):Void

设置ZLoader3D对象

Parameters:

id
null

loader

@:value({ canError : false, errorCall : null })start (func:Float ‑> Void, ?errorCall:String ‑> Void, canError:Bool = false):Void

开始加载

 *  @param func - 加载进度回调
 *  @param errorCall - 错误回调
 *  @param canError - 是否允许容错加载,如果设置为true,则永远不会触发errorCall

stopBGMusic ():Void

停止背景音乐

toString ():String

unloadAssetsZip (id:String):Void

卸载对应的压缩文件

Parameters:

null

id

unloadSwfliteFile (id:String):Void

卸载指定的Swflite对象

Parameters:

null

id