跳到主要内容
版本:3.0.x

Class ResourcePackage

资源包裹类

Assembly: YooAsset.dll
View Source
Declaration
public class ResourcePackage

Properties

PackageName

包裹名称

View Source
Declaration
public string PackageName { get; }

PackageValid

包裹是否有效

View Source
Declaration
public bool PackageValid { get; }

PackagePriority

包裹优先级(值越大越优先更新)

View Source
Declaration
public uint PackagePriority { get; set; }

InitializeStatus

初始化状态

View Source
Declaration
public EOperationStatus InitializeStatus { get; }

Methods

InitializePackageAsync(InitializePackageOptions)

初始化包裹

View Source
Declaration
public InitializePackageOperation InitializePackageAsync(InitializePackageOptions options)
Returns

YooAsset.InitializePackageOperation: 返回初始化操作对象

Parameters
TypeNameDescription
YooAsset.InitializePackageOptionsoptions初始化参数

DestroyPackageAsync()

销毁包裹

View Source
Declaration
public DestroyPackageOperation DestroyPackageAsync()
Returns

YooAsset.DestroyPackageOperation: 返回销毁包裹操作对象### RequestPackageVersionAsync() 请求最新的资源版本

View Source
Declaration
public RequestPackageVersionOperation RequestPackageVersionAsync()
Returns

YooAsset.RequestPackageVersionOperation: 返回请求版本操作对象### RequestPackageVersionAsync(RequestPackageVersionOptions) 请求最新的资源版本

View Source
Declaration
public RequestPackageVersionOperation RequestPackageVersionAsync(RequestPackageVersionOptions options)
Returns

YooAsset.RequestPackageVersionOperation: 返回请求版本操作对象

Parameters
TypeNameDescription
YooAsset.RequestPackageVersionOptionsoptions请求版本选项

LoadPackageManifestAsync(LoadPackageManifestOptions)

加载指定版本的资源清单

View Source
Declaration
public LoadPackageManifestOperation LoadPackageManifestAsync(LoadPackageManifestOptions options)
Returns

YooAsset.LoadPackageManifestOperation: 返回加载清单操作对象

Parameters
TypeNameDescription
YooAsset.LoadPackageManifestOptionsoptions加载清单选项

PrefetchManifestAsync(PrefetchManifestOptions)

预取指定版本的包裹资源清单

View Source
Declaration
public PrefetchManifestOperation PrefetchManifestAsync(PrefetchManifestOptions options)
Returns

YooAsset.PrefetchManifestOperation: 返回预取清单操作对象

Parameters
TypeNameDescription
YooAsset.PrefetchManifestOptionsoptions预取清单选项

ClearCacheAsync(ClearCacheOptions)

清理缓存文件

View Source
Declaration
public ClearCacheOperation ClearCacheAsync(ClearCacheOptions options)
Returns

YooAsset.ClearCacheOperation: 返回清理缓存操作对象

Parameters
TypeNameDescription
YooAsset.ClearCacheOptionsoptions清理缓存选项

GetPackageVersion()

获取当前加载包裹的版本信息

View Source
Declaration
public string GetPackageVersion()
Returns

System.String: 返回当前包裹版本字符串### GetPackageNote() 获取当前加载包裹的备注信息

View Source
Declaration
public string GetPackageNote()
Returns

System.String: 返回当前包裹备注字符串### GetPackageDetails() 获取当前加载包裹的详细信息

View Source
Declaration
public PackageDetails GetPackageDetails()
Returns

YooAsset.PackageDetails: 返回包含包裹配置的详细信息对象### UnloadAllAssetsAsync() 强制回收所有资源

View Source
Declaration
public UnloadAllAssetsOperation UnloadAllAssetsAsync()
Returns

YooAsset.UnloadAllAssetsOperation: 返回卸载资源操作对象### UnloadAllAssetsAsync(UnloadAllAssetsOptions) 强制回收所有资源

View Source
Declaration
public UnloadAllAssetsOperation UnloadAllAssetsAsync(UnloadAllAssetsOptions options)
Returns

YooAsset.UnloadAllAssetsOperation: 返回卸载资源操作对象

Parameters
TypeNameDescription
YooAsset.UnloadAllAssetsOptionsoptions卸载选项

UnloadUnusedAssetsAsync()

回收不再使用的资源

View Source
Declaration
public UnloadUnusedAssetsOperation UnloadUnusedAssetsAsync()
Returns

YooAsset.UnloadUnusedAssetsOperation: 返回卸载未使用资源操作对象### UnloadUnusedAssetsAsync(UnloadUnusedAssetsOptions) 回收不再使用的资源

View Source
Declaration
public UnloadUnusedAssetsOperation UnloadUnusedAssetsAsync(UnloadUnusedAssetsOptions options)
Returns

YooAsset.UnloadUnusedAssetsOperation: 返回卸载未使用资源操作对象

Parameters
TypeNameDescription
YooAsset.UnloadUnusedAssetsOptionsoptions卸载选项

TryUnloadUnusedAsset(string, int)

尝试卸载指定的未使用资源

View Source
Declaration
public void TryUnloadUnusedAsset(string location, int loopCount = 10)
Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.Int32loopCount最大循环卸载次数

TryUnloadUnusedAsset(AssetInfo, int)

尝试卸载指定的未使用资源

View Source
Declaration
public void TryUnloadUnusedAsset(AssetInfo assetInfo, int loopCount = 10)
Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息
System.Int32loopCount最大循环卸载次数

GetDownloadSize(string)

获取指定资源需要下载的文件总大小

View Source
Declaration
public long GetDownloadSize(string location)
Returns

System.Int64: 返回需要下载的字节数,0 表示不需要下载。

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址

GetDownloadSize(AssetInfo)

获取指定资源需要下载的文件总大小

View Source
Declaration
public long GetDownloadSize(AssetInfo assetInfo)
Returns

System.Int64: 返回需要下载的字节数,0 表示不需要下载。

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息

GetAllAssetInfos()

获取所有的资源信息

View Source
Declaration
public AssetInfo[] GetAllAssetInfos()
Returns

YooAsset.AssetInfo[]: 返回包含所有资源信息的数组### GetAssetInfos(string) 获取资源信息列表

View Source
Declaration
public AssetInfo[] GetAssetInfos(string tag)
Returns

YooAsset.AssetInfo[]: 返回匹配标签的资源信息数组

Parameters
TypeNameDescription
System.Stringtag资源标签

GetAssetInfos(string[])

获取资源信息列表

View Source
Declaration
public AssetInfo[] GetAssetInfos(string[] tags)
Returns

YooAsset.AssetInfo[]: 返回匹配标签的资源信息数组

Parameters
TypeNameDescription
System.String[]tags资源标签列表

GetAssetInfo(string)

获取资源信息

View Source
Declaration
public AssetInfo GetAssetInfo(string location)
Returns

YooAsset.AssetInfo: 返回资源信息对象

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址

GetAssetInfo(string, Type)

获取资源信息

View Source
Declaration
public AssetInfo GetAssetInfo(string location, Type type)
Returns

YooAsset.AssetInfo: 返回资源信息对象

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.Typetype资源类型

GetAssetInfoByGuid(string)

获取资源信息

View Source
Declaration
public AssetInfo GetAssetInfoByGuid(string assetGuid)
Returns

YooAsset.AssetInfo: 返回资源信息对象

Parameters
TypeNameDescription
System.StringassetGuid资源GUID

GetAssetInfoByGuid(string, Type)

获取资源信息

View Source
Declaration
public AssetInfo GetAssetInfoByGuid(string assetGuid, Type type)
Returns

YooAsset.AssetInfo: 返回资源信息对象

Parameters
TypeNameDescription
System.StringassetGuid资源GUID
System.Typetype资源类型

IsLocationValid(string)

资源定位地址是否有效

View Source
Declaration
public bool IsLocationValid(string location)
Returns

System.Boolean: 如果地址有效返回true,否则返回false。

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址

LoadRawFileSync(AssetInfo)

同步加载原生文件

View Source
Declaration
public RawFileHandle LoadRawFileSync(AssetInfo assetInfo)
Returns

YooAsset.RawFileHandle: 返回原生文件操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息

LoadRawFileSync(string)

同步加载原生文件

View Source
Declaration
public RawFileHandle LoadRawFileSync(string location)
Returns

YooAsset.RawFileHandle: 返回原生文件操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址

LoadRawFileAsync(AssetInfo, uint)

加载原生文件

View Source
Declaration
public RawFileHandle LoadRawFileAsync(AssetInfo assetInfo, uint priority = 0)
Returns

YooAsset.RawFileHandle: 返回原生文件操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息
System.UInt32priority加载的优先级

LoadRawFileAsync(string, uint)

加载原生文件

View Source
Declaration
public RawFileHandle LoadRawFileAsync(string location, uint priority = 0)
Returns

YooAsset.RawFileHandle: 返回原生文件操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.UInt32priority加载的优先级

LoadSceneSync(string, LoadSceneMode, LocalPhysicsMode)

同步加载场景

View Source
Declaration
public SceneHandle LoadSceneSync(string location, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None)
Returns

YooAsset.SceneHandle: 返回场景操作句柄

Parameters
TypeNameDescription
System.Stringlocation场景的定位地址
UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式
UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式

LoadSceneSync(AssetInfo, LoadSceneMode, LocalPhysicsMode)

同步加载场景

View Source
Declaration
public SceneHandle LoadSceneSync(AssetInfo assetInfo, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None)
Returns

YooAsset.SceneHandle: 返回场景操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo场景的资源信息
UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式
UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式

LoadSceneAsync(string, LoadSceneMode, LocalPhysicsMode, bool, uint)

加载场景

View Source
Declaration
public SceneHandle LoadSceneAsync(string location, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None, bool allowSceneActivation = true, uint priority = 0)
Returns

YooAsset.SceneHandle: 返回场景操作句柄

Parameters
TypeNameDescription
System.Stringlocation场景的定位地址
UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式
UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式
System.BooleanallowSceneActivation是否允许场景激活
System.UInt32priority加载的优先级

LoadSceneAsync(AssetInfo, LoadSceneMode, LocalPhysicsMode, bool, uint)

加载场景

View Source
Declaration
public SceneHandle LoadSceneAsync(AssetInfo assetInfo, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None, bool allowSceneActivation = true, uint priority = 0)
Returns

YooAsset.SceneHandle: 返回场景操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo场景的资源信息
UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式
UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式
System.BooleanallowSceneActivation是否允许场景激活
System.UInt32priority加载的优先级

LoadAssetSync(AssetInfo)

同步加载资源对象

View Source
Declaration
public AssetHandle LoadAssetSync(AssetInfo assetInfo)
Returns

YooAsset.AssetHandle: 返回资源操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息

LoadAssetSync<TObject>(string)

同步加载资源对象

View Source
Declaration
public AssetHandle LoadAssetSync<TObject>(string location) where TObject : Object
Returns

YooAsset.AssetHandle: 返回资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
Type Parameters
NameDescription
TObject资源类型

LoadAssetSync(string, Type)

同步加载资源对象

View Source
Declaration
public AssetHandle LoadAssetSync(string location, Type type)
Returns

YooAsset.AssetHandle: 返回资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.Typetype资源类型

LoadAssetSync(string)

同步加载资源对象

View Source
Declaration
public AssetHandle LoadAssetSync(string location)
Returns

YooAsset.AssetHandle: 返回资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址

LoadAssetAsync(AssetInfo, uint)

加载资源对象

View Source
Declaration
public AssetHandle LoadAssetAsync(AssetInfo assetInfo, uint priority = 0)
Returns

YooAsset.AssetHandle: 返回资源操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息
System.UInt32priority加载的优先级

LoadAssetAsync<TObject>(string, uint)

加载资源对象

View Source
Declaration
public AssetHandle LoadAssetAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns

YooAsset.AssetHandle: 返回资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.UInt32priority加载的优先级
Type Parameters
NameDescription
TObject资源类型

LoadAssetAsync(string, Type, uint)

加载资源对象

View Source
Declaration
public AssetHandle LoadAssetAsync(string location, Type type, uint priority = 0)
Returns

YooAsset.AssetHandle: 返回资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.Typetype资源类型
System.UInt32priority加载的优先级

LoadAssetAsync(string, uint)

加载资源对象

View Source
Declaration
public AssetHandle LoadAssetAsync(string location, uint priority = 0)
Returns

YooAsset.AssetHandle: 返回资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.UInt32priority加载的优先级

LoadSubAssetsSync(AssetInfo)

同步加载子资源对象

View Source
Declaration
public SubAssetsHandle LoadSubAssetsSync(AssetInfo assetInfo)
Returns

YooAsset.SubAssetsHandle: 返回子资源操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息

LoadSubAssetsSync<TObject>(string)

同步加载子资源对象

View Source
Declaration
public SubAssetsHandle LoadSubAssetsSync<TObject>(string location) where TObject : Object
Returns

YooAsset.SubAssetsHandle: 返回子资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
Type Parameters
NameDescription
TObject资源类型

LoadSubAssetsSync(string, Type)

同步加载子资源对象

View Source
Declaration
public SubAssetsHandle LoadSubAssetsSync(string location, Type type)
Returns

YooAsset.SubAssetsHandle: 返回子资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.Typetype子对象类型

LoadSubAssetsSync(string)

同步加载子资源对象

View Source
Declaration
public SubAssetsHandle LoadSubAssetsSync(string location)
Returns

YooAsset.SubAssetsHandle: 返回子资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址

LoadSubAssetsAsync(AssetInfo, uint)

加载子资源对象

View Source
Declaration
public SubAssetsHandle LoadSubAssetsAsync(AssetInfo assetInfo, uint priority = 0)
Returns

YooAsset.SubAssetsHandle: 返回子资源操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息
System.UInt32priority加载的优先级

LoadSubAssetsAsync<TObject>(string, uint)

加载子资源对象

View Source
Declaration
public SubAssetsHandle LoadSubAssetsAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns

YooAsset.SubAssetsHandle: 返回子资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.UInt32priority加载的优先级
Type Parameters
NameDescription
TObject资源类型

LoadSubAssetsAsync(string, Type, uint)

加载子资源对象

View Source
Declaration
public SubAssetsHandle LoadSubAssetsAsync(string location, Type type, uint priority = 0)
Returns

YooAsset.SubAssetsHandle: 返回子资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.Typetype子对象类型
System.UInt32priority加载的优先级

LoadSubAssetsAsync(string, uint)

加载子资源对象

View Source
Declaration
public SubAssetsHandle LoadSubAssetsAsync(string location, uint priority = 0)
Returns

YooAsset.SubAssetsHandle: 返回子资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.UInt32priority加载的优先级

LoadAllAssetsSync(AssetInfo)

同步加载资源包内所有资源对象

View Source
Declaration
public AllAssetsHandle LoadAllAssetsSync(AssetInfo assetInfo)
Returns

YooAsset.AllAssetsHandle: 返回全资源操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息

LoadAllAssetsSync<TObject>(string)

同步加载资源包内所有资源对象

View Source
Declaration
public AllAssetsHandle LoadAllAssetsSync<TObject>(string location) where TObject : Object
Returns

YooAsset.AllAssetsHandle: 返回全资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
Type Parameters
NameDescription
TObject资源类型

LoadAllAssetsSync(string, Type)

同步加载资源包内所有资源对象

View Source
Declaration
public AllAssetsHandle LoadAllAssetsSync(string location, Type type)
Returns

YooAsset.AllAssetsHandle: 返回全资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.Typetype子对象类型

LoadAllAssetsSync(string)

同步加载资源包内所有资源对象

View Source
Declaration
public AllAssetsHandle LoadAllAssetsSync(string location)
Returns

YooAsset.AllAssetsHandle: 返回全资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址

LoadAllAssetsAsync(AssetInfo, uint)

加载资源包内所有资源对象

View Source
Declaration
public AllAssetsHandle LoadAllAssetsAsync(AssetInfo assetInfo, uint priority = 0)
Returns

YooAsset.AllAssetsHandle: 返回全资源操作句柄

Parameters
TypeNameDescription
YooAsset.AssetInfoassetInfo资源信息
System.UInt32priority加载的优先级

LoadAllAssetsAsync<TObject>(string, uint)

加载资源包内所有资源对象

View Source
Declaration
public AllAssetsHandle LoadAllAssetsAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns

YooAsset.AllAssetsHandle: 返回全资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.UInt32priority加载的优先级
Type Parameters
NameDescription
TObject资源类型

LoadAllAssetsAsync(string, Type, uint)

加载资源包内所有资源对象

View Source
Declaration
public AllAssetsHandle LoadAllAssetsAsync(string location, Type type, uint priority = 0)
Returns

YooAsset.AllAssetsHandle: 返回全资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.Typetype子对象类型
System.UInt32priority加载的优先级

LoadAllAssetsAsync(string, uint)

加载资源包内所有资源对象

View Source
Declaration
public AllAssetsHandle LoadAllAssetsAsync(string location, uint priority = 0)
Returns

YooAsset.AllAssetsHandle: 返回全资源操作句柄

Parameters
TypeNameDescription
System.Stringlocation资源的定位地址
System.UInt32priority加载的优先级

CreateResourceDownloader(ResourceDownloaderOptions)

创建资源下载器,用于下载指定的资源标签关联的资源包文件。

View Source
Declaration
public ResourceDownloaderOperation CreateResourceDownloader(ResourceDownloaderOptions options)
Returns

YooAsset.ResourceDownloaderOperation: 返回资源下载操作对象

Parameters
TypeNameDescription
YooAsset.ResourceDownloaderOptionsoptions资源下载选项

CreateResourceDownloader(BundleDownloaderOptions)

创建资源下载器,用于下载指定的资源信息列表依赖的资源包文件。

View Source
Declaration
public ResourceDownloaderOperation CreateResourceDownloader(BundleDownloaderOptions options)
Returns

YooAsset.ResourceDownloaderOperation: 返回资源下载操作对象

Parameters
TypeNameDescription
YooAsset.BundleDownloaderOptionsoptions资源下载选项

CreateResourceUnpacker(ResourceUnpackerOptions)

创建内置资源解压器,用于解压指定的资源标签关联的资源包文件。

View Source
Declaration
public ResourceUnpackerOperation CreateResourceUnpacker(ResourceUnpackerOptions options)
Returns

YooAsset.ResourceUnpackerOperation: 返回资源解压操作对象

Parameters
TypeNameDescription
YooAsset.ResourceUnpackerOptionsoptions资源解压选项

CreateResourceImporter(BundleImporterOptions)

创建资源导入器

View Source
Declaration
public ResourceImporterOperation CreateResourceImporter(BundleImporterOptions options)
Returns

YooAsset.ResourceImporterOperation: 返回资源导入操作对象

Parameters
TypeNameDescription
YooAsset.BundleImporterOptionsoptions资源导入选项