UIPackage

命名空间：FairyGUI
源码：Assets/Scripts/UI/UIPackage.cs (行 15)

public class UIPackage

A UI Package contains a description file and some texture, sound assets.

构造函数

UIPackage()

public UIPackage();

源码：UI/UIPackage.cs (行 112)

事件

onReleaseResource

public static event Action<PackageItem> onReleaseResource;

The event is triggered when all reference to this package item dropped.

源码：UI/UIPackage.cs (行 27)

字段

URL_PREFIX

public const string URL_PREFIX = "ui://";

源码：UI/UIPackage.cs (行 96)

unloadBundleByFGUI

public static bool unloadBundleByFGUI;

Unload UIAssetBundle by FairyGUI system. if use AssetBundlesManager set value to false then unload UIAssetBundle by AssetBundlesManager

源码：UI/UIPackage.cs (行 22)

方法

AddPackage(AssetBundle)

public static UIPackage AddPackage(AssetBundle bundle);

Add a UI package from assetbundle.

返回值

UIPackage

参数	类型	说明
bundle	AssetBundle	A assetbundle.

源码：UI/UIPackage.cs (行 201)

AddPackage(AssetBundle, AssetBundle)

public static UIPackage AddPackage(AssetBundle desc, AssetBundle res);

Add a UI package from two assetbundles. desc and res can be same.

返回值

UIPackage

参数	类型	说明
desc	AssetBundle	A assetbunble contains description file.
res	AssetBundle	A assetbundle contains resources.

源码：UI/UIPackage.cs (行 212)

AddPackage(AssetBundle, AssetBundle, string)

public static UIPackage AddPackage(AssetBundle desc, AssetBundle res, string mainAssetName);

Add a UI package from two assetbundles with a optional main asset name.

返回值

UIPackage

参数	类型	说明
desc	AssetBundle	A assetbunble contains description file.
res	AssetBundle	A assetbundle contains resources.
mainAssetName	string	Main asset name. e.g. Basics_fui

源码：UI/UIPackage.cs (行 224)

AddPackage(byte[], string, LoadResource)

public static UIPackage AddPackage(byte[] descData, string assetNamePrefix, LoadResource loadFunc);

Load Package by custom load method.

参数	类型	说明
descData	byte[]	Description file data
assetNamePrefix	string	Prefix of the resource file name. The file name would be in format of 'assetNamePrefix_resFileName'. It can be empty.
loadFunc	LoadResource	Load method

源码：UI/UIPackage.cs (行 340)

AddPackage(byte[], string, LoadResourceAsync)

public static UIPackage AddPackage(byte[] descData, string assetNamePrefix, LoadResourceAsync loadFunc);

Load Package async by custom load method.

参数	类型	说明
descData	byte[]	Description file data
assetNamePrefix	string	refix of the resource file name. The file name would be in format of 'assetNamePrefix_resFileName'. It can be empty.
loadFunc	LoadResourceAsync	Load method

源码：UI/UIPackage.cs (行 363)

AddPackage(string, LoadResource)

public static UIPackage AddPackage(string assetPath, LoadResource loadFunc);

使用自定义的加载方式载入一个包。

参数	类型	说明
assetPath	string	包资源路径。
loadFunc	LoadResource	载入函数

源码：UI/UIPackage.cs (行 303)

AddPackage(string)

public static UIPackage AddPackage(string descFilePath);

Add a UI package from a path relative to Unity Resources path.

返回值

UIPackage

参数	类型	说明
descFilePath	string	Path relative to Unity Resources path.

源码：UI/UIPackage.cs (行 281)

CreateObject(string)

public GObject CreateObject(string resName);

参数	类型	说明
resName	string

源码：UI/UIPackage.cs (行 1074)

CreateObject(string, Type)

public GObject CreateObject(string resName, System.Type userClass);

参数	类型	说明
resName	string
userClass	Type

源码：UI/UIPackage.cs (行 1092)

CreateObject(string, string)

public static GObject CreateObject(string pkgName, string resName);

Create a UI object.

返回值

A UI object.

参数	类型	说明
pkgName	string	Package name.
resName	string	Resource name.

源码：UI/UIPackage.cs (行 435)

CreateObject(string, string, Type)

public static GObject CreateObject(string pkgName, string resName, System.Type userClass);

Create a UI object.

返回值

A UI object.

参数	类型	说明
pkgName	string	Package name.
resName	string	Resource name.
userClass	Type	Custom implementation of this object.

源码：UI/UIPackage.cs (行 451)

CreateObjectAsync(string, string, CreateObjectCallback)

public static void CreateObjectAsync(string pkgName, string resName, CreateObjectCallback callback);

参数	类型	说明
pkgName	string
resName	string
callback	CreateObjectCallback

源码：UI/UIPackage.cs (行 489)

CreateObjectAsync(string, CreateObjectCallback)

public void CreateObjectAsync(string resName, CreateObjectCallback callback);

参数	类型	说明
resName	string
callback	CreateObjectCallback

源码：UI/UIPackage.cs (行 1104)

CreateObjectFromURL(string)

public static GObject CreateObjectFromURL(string url);

Create a UI object.

返回值

A UI object.

参数	类型	说明
url	string	Resource url.

源码：UI/UIPackage.cs (行 465)

CreateObjectFromURL(string, Type)

public static GObject CreateObjectFromURL(string url, System.Type userClass);

Create a UI object.

返回值

A UI object.

参数	类型	说明
url	string	Resource url.
userClass	Type	Custom implementation of this object.

源码：UI/UIPackage.cs (行 480)

CreateObjectFromURL(string, CreateObjectCallback)

public static void CreateObjectFromURL(string url, CreateObjectCallback callback);

参数	类型	说明
url	string
callback	CreateObjectCallback

源码：UI/UIPackage.cs (行 498)

GetById(string)

public static UIPackage GetById(string id);

Return a UIPackage with a certain id.

返回值

UIPackage

参数	类型	说明
id	string	ID of the package.

源码：UI/UIPackage.cs (行 173)

GetByName(string)

public static UIPackage GetByName(string name);

Return a UIPackage with a certain name.

返回值

UIPackage

参数	类型	说明
name	string	Name of the package.

源码：UI/UIPackage.cs (行 187)

GetItem(string)

public PackageItem GetItem(string itemId);

参数	类型	说明
itemId	string

源码：UI/UIPackage.cs (行 1157)

GetItemAsset(PackageItem)

public object GetItemAsset(PackageItem item);

参数	类型	说明
item	PackageItem

源码：UI/UIPackage.cs (行 1175)

GetItemAsset(string)

public object GetItemAsset(string resName);

参数	类型	说明
resName	string

源码：UI/UIPackage.cs (行 1140)

GetItemAsset(string, string)

public static object GetItemAsset(string pkgName, string resName);

Get a asset with a certain name.

返回值

If resource is atlas, returns NTexture; If resource is sound, returns AudioClip.

参数	类型	说明
pkgName	string	Package name.
resName	string	Resource name.

源码：UI/UIPackage.cs (行 513)

GetItemAssetByURL(string)

public static object GetItemAssetByURL(string url);

Get a asset with a certain name.

返回值

If resource is atlas, returns NTexture; If resource is sound, returns AudioClip.

参数	类型	说明
url	string	Resource url.

源码：UI/UIPackage.cs (行 527)

GetItemByName(string)

public PackageItem GetItemByName(string itemName);

参数	类型	说明
itemName	string

源码：UI/UIPackage.cs (行 1166)

GetItemByURL(string)

public static PackageItem GetItemByURL(string url);

参数	类型	说明
url	string

源码：UI/UIPackage.cs (行 555)

GetItemURL(string, string)

public static string GetItemURL(string pkgName, string resName);

Get url of an item in package.

返回值

Url.

参数	类型	说明
pkgName	string	Package name.
resName	string	Resource name.

源码：UI/UIPackage.cs (行 542)

GetItems()

public List<PackageItem> GetItems();

源码：UI/UIPackage.cs (行 1152)

GetPackages()

public static List<UIPackage> GetPackages();

源码：UI/UIPackage.cs (行 424)

GetVar(string)

public static string GetVar(string key);

参数	类型	说明
key	string

源码：UI/UIPackage.cs (行 148)

LoadAllAssets()

public void LoadAllAssets();

源码：UI/UIPackage.cs (行 964)

NormalizeURL(string)

public static string NormalizeURL(string url);

将'ui://包名/组件名'转换为以内部id表达的url格式。如果传入的url本身就是内部id格式，则直接返回。 同时这个方法还带格式检测，如果传入不正确的url，会返回null。

参数	类型	说明
url	string

源码：UI/UIPackage.cs (行 598)

ReloadAssets()

public void ReloadAssets();

源码：UI/UIPackage.cs (行 1003)

ReloadAssets(AssetBundle)

public void ReloadAssets(AssetBundle resBundle);

参数	类型	说明
resBundle	AssetBundle

源码：UI/UIPackage.cs (行 1014)

RemoveAllPackages()

public static void RemoveAllPackages();

源码：UI/UIPackage.cs (行 404)

RemovePackage(string)

public static void RemovePackage(string packageIdOrName);

Remove a package. All resources in this package will be disposed.

参数	类型	说明
packageIdOrName	string

源码：UI/UIPackage.cs (行 383)

SetItemAsset(PackageItem, object, DestroyMethod)

public void SetItemAsset(PackageItem item, object asset, DestroyMethod destroyMethod);

参数	类型	说明
item	PackageItem
asset	object
destroyMethod	DestroyMethod

源码：UI/UIPackage.cs (行 1233)

SetStringsSource(XML)

public static void SetStringsSource(XML source);

Set strings source.

参数	类型	说明
source	XML

源码：UI/UIPackage.cs (行 622)

SetVar(string, string)

public static void SetVar(string key, string value);

参数	类型	说明
key	string
value	string

源码：UI/UIPackage.cs (行 160)

UnloadAssets()

public void UnloadAssets();

源码：UI/UIPackage.cs (行 974)

属性

assetPath

public string assetPath { get; }

源码：UI/UIPackage.cs (行 630)

branch

public static string branch { get; set; }

源码：UI/UIPackage.cs (行 125)

customId

public string customId { get; set; }

Set a custom id for package, then you can use it in GetById.

源码：UI/UIPackage.cs (行 638)

dependencies

public Dictionary<string, string>[] dependencies { get; }

获得本包依赖的包的id列表

源码：UI/UIPackage.cs (行 662)

id

public string id { get; private set; }

Package id. It is generated by the Editor.

源码：UI/UIPackage.cs (行 32)

name

public string name { get; private set; }

Package name.

源码：UI/UIPackage.cs (行 37)

resBundle

public AssetBundle resBundle { get; }

源码：UI/UIPackage.cs (行 654)