Class ResourcePackage
资源包裹类
Assembly: YooAsset.dll
View Source
public class ResourcePackage
Properties
PackageName
包裹名称
View Source
public string PackageName { get; }
PackageValid
包裹是否有效
View Source
public bool PackageValid { get; }
PackagePriority
包裹优先级(值越大越优先更新)
View Source
public uint PackagePriority { get; set; }
InitializeStatus
初始化状态
View Source
public EOperationStatus InitializeStatus { get; }
Methods
InitializePackageAsync(InitializePackageOptions)
初始化包裹
View Source
public InitializePackageOperation InitializePackageAsync(InitializePackageOptions options)
Returns
YooAsset.InitializePackageOperation: 返回初始化操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.InitializePackageOptions | options | 初始化参数 |
DestroyPackageAsync()
销毁包裹
View Source
public DestroyPackageOperation DestroyPackageAsync()
Returns
YooAsset.DestroyPackageOperation: 返回销毁包裹操作对象### RequestPackageVersionAsync() 请求最新的资源版本
View Source
public RequestPackageVersionOperation RequestPackageVersionAsync()
Returns
YooAsset.RequestPackageVersionOperation: 返回请求版本操作对象### RequestPackageVersionAsync(RequestPackageVersionOptions) 请求最新的资源版本
View Source
public RequestPackageVersionOperation RequestPackageVersionAsync(RequestPackageVersionOptions options)
Returns
YooAsset.RequestPackageVersionOperation: 返回请求版本操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.RequestPackageVersionOptions | options | 请求版本选项 |
LoadPackageManifestAsync(LoadPackageManifestOptions)
加载指定版本的资源清单
View Source
public LoadPackageManifestOperation LoadPackageManifestAsync(LoadPackageManifestOptions options)
Returns
YooAsset.LoadPackageManifestOperation: 返回加载清单操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.LoadPackageManifestOptions | options | 加载清单选项 |
PrefetchManifestAsync(PrefetchManifestOptions)
预取指定版本的包裹资源清单
View Source
public PrefetchManifestOperation PrefetchManifestAsync(PrefetchManifestOptions options)
Returns
YooAsset.PrefetchManifestOperation: 返回预取清单操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.PrefetchManifestOptions | options | 预取清单选项 |
ClearCacheAsync(ClearCacheOptions)
清理缓存文件
View Source
public ClearCacheOperation ClearCacheAsync(ClearCacheOptions options)
Returns
YooAsset.ClearCacheOperation: 返回清理缓存操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.ClearCacheOptions | options | 清理缓存选项 |
GetPackageVersion()
获取当前加载包裹的版本信息
View Source
public string GetPackageVersion()
Returns
System.String: 返回当前包裹版本字符串### GetPackageNote()
获取当前加载包裹的备注信息
View Source
public string GetPackageNote()
Returns
System.String: 返回当前包裹备注字符串### GetPackageDetails()
获取当前加载包裹的详细信息
View Source
public PackageDetails GetPackageDetails()
Returns
YooAsset.PackageDetails: 返回包含包裹配置的详细信息对象### UnloadAllAssetsAsync() 强制回收所有资源
View Source
public UnloadAllAssetsOperation UnloadAllAssetsAsync()
Returns
YooAsset.UnloadAllAssetsOperation: 返回卸载资源操作对象### UnloadAllAssetsAsync(UnloadAllAssetsOptions) 强制回收所有资源
View Source
public UnloadAllAssetsOperation UnloadAllAssetsAsync(UnloadAllAssetsOptions options)
Returns
YooAsset.UnloadAllAssetsOperation: 返回卸载资源操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.UnloadAllAssetsOptions | options | 卸载选项 |
UnloadUnusedAssetsAsync()
回收不再使用的资源
View Source
public UnloadUnusedAssetsOperation UnloadUnusedAssetsAsync()
Returns
YooAsset.UnloadUnusedAssetsOperation: 返回卸载未使用资源操作对象### UnloadUnusedAssetsAsync(UnloadUnusedAssetsOptions) 回收不再使用的资源
View Source
public UnloadUnusedAssetsOperation UnloadUnusedAssetsAsync(UnloadUnusedAssetsOptions options)
Returns
YooAsset.UnloadUnusedAssetsOperation: 返回卸载未使用资源操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.UnloadUnusedAssetsOptions | options | 卸载选项 |
TryUnloadUnusedAsset(string, int)
尝试卸载指定的未使用资源
View Source
public void TryUnloadUnusedAsset(string location, int loopCount = 10)
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.Int32 | loopCount | 最大循环卸载次数 |
TryUnloadUnusedAsset(AssetInfo, int)
尝试卸载指定的未使用资源
View Source
public void TryUnloadUnusedAsset(AssetInfo assetInfo, int loopCount = 10)
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
System.Int32 | loopCount | 最大循环卸载次数 |
GetDownloadSize(string)
获取指定资源需要下载的文件总大小
View Source
public long GetDownloadSize(string location)
Returns
System.Int64: 返回需要下载的字节数,0 表示不需要下载。
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
GetDownloadSize(AssetInfo)
获取指定资源需要下载的文件总大小
View Source
public long GetDownloadSize(AssetInfo assetInfo)
Returns
System.Int64: 返回需要下载的字节数,0 表示不需要下载。
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
GetAllAssetInfos()
获取所有的资源信息
View Source
public AssetInfo[] GetAllAssetInfos()
Returns
YooAsset.AssetInfo[]: 返回包含所有资源信息的数组### GetAssetInfos(string)
获取资源信息列表
View Source
public AssetInfo[] GetAssetInfos(string tag)
Returns
YooAsset.AssetInfo[]: 返回匹配标签的资源信息数组
Parameters
| Type | Name | Description |
|---|---|---|
System.String | tag | 资源标签 |
GetAssetInfos(string[])
获取资源信息列表
View Source
public AssetInfo[] GetAssetInfos(string[] tags)
Returns
YooAsset.AssetInfo[]: 返回匹配标签的资源信息数组
Parameters
| Type | Name | Description |
|---|---|---|
System.String[] | tags | 资源标签列表 |
GetAssetInfo(string)
获取资源信息
View Source
public AssetInfo GetAssetInfo(string location)
Returns
YooAsset.AssetInfo: 返回资源信息对象
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
GetAssetInfo(string, Type)
获取资源信息
View Source
public AssetInfo GetAssetInfo(string location, Type type)
Returns
YooAsset.AssetInfo: 返回资源信息对象
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.Type | type | 资源类型 |
GetAssetInfoByGuid(string)
获取资源信息
View Source
public AssetInfo GetAssetInfoByGuid(string assetGuid)
Returns
YooAsset.AssetInfo: 返回资源信息对象
Parameters
| Type | Name | Description |
|---|---|---|
System.String | assetGuid | 资源GUID |
GetAssetInfoByGuid(string, Type)
获取资源信息
View Source
public AssetInfo GetAssetInfoByGuid(string assetGuid, Type type)
Returns
YooAsset.AssetInfo: 返回资源信息对象
Parameters
| Type | Name | Description |
|---|---|---|
System.String | assetGuid | 资源GUID |
System.Type | type | 资源类型 |
IsLocationValid(string)
资源定位地址是否有效
View Source
public bool IsLocationValid(string location)
Returns
System.Boolean: 如果地址有效返回true,否则返回false。
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
LoadRawFileSync(AssetInfo)
同步加载原生文件
View Source
public RawFileHandle LoadRawFileSync(AssetInfo assetInfo)
Returns
YooAsset.RawFileHandle: 返回原生文件操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
LoadRawFileSync(string)
同步加载原生文件
View Source
public RawFileHandle LoadRawFileSync(string location)
Returns
YooAsset.RawFileHandle: 返回原生文件操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
LoadRawFileAsync(AssetInfo, uint)
加载原生文件
View Source
public RawFileHandle LoadRawFileAsync(AssetInfo assetInfo, uint priority = 0)
Returns
YooAsset.RawFileHandle: 返回原生文件操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
System.UInt32 | priority | 加载的优先级 |
LoadRawFileAsync(string, uint)
加载原生文件
View Source
public RawFileHandle LoadRawFileAsync(string location, uint priority = 0)
Returns
YooAsset.RawFileHandle: 返回原生文件操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.UInt32 | priority | 加载的优先级 |
LoadSceneSync(string, LoadSceneMode, LocalPhysicsMode)
同步加载场景
View Source
public SceneHandle LoadSceneSync(string location, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None)
Returns
YooAsset.SceneHandle: 返回场景操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 场景的定位地址 |
UnityEngine.SceneManagement.LoadSceneMode | sceneMode | 场景加载模式 |
UnityEngine.SceneManagement.LocalPhysicsMode | physicsMode | 场景物理模式 |
LoadSceneSync(AssetInfo, LoadSceneMode, LocalPhysicsMode)
同步加载场景
View Source
public SceneHandle LoadSceneSync(AssetInfo assetInfo, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None)
Returns
YooAsset.SceneHandle: 返回场景操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 场景的资源信息 |
UnityEngine.SceneManagement.LoadSceneMode | sceneMode | 场景加载模式 |
UnityEngine.SceneManagement.LocalPhysicsMode | physicsMode | 场景物理模式 |
LoadSceneAsync(string, LoadSceneMode, LocalPhysicsMode, bool, uint)
加载场景
View Source
public SceneHandle LoadSceneAsync(string location, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None, bool allowSceneActivation = true, uint priority = 0)
Returns
YooAsset.SceneHandle: 返回场景操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 场景的定位地址 |
UnityEngine.SceneManagement.LoadSceneMode | sceneMode | 场景加载模式 |
UnityEngine.SceneManagement.LocalPhysicsMode | physicsMode | 场景物理模式 |
System.Boolean | allowSceneActivation | 是否允许场景激活 |
System.UInt32 | priority | 加载的优先级 |
LoadSceneAsync(AssetInfo, LoadSceneMode, LocalPhysicsMode, bool, uint)
加载场景
View Source
public SceneHandle LoadSceneAsync(AssetInfo assetInfo, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None, bool allowSceneActivation = true, uint priority = 0)
Returns
YooAsset.SceneHandle: 返回场景操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 场景的资源信息 |
UnityEngine.SceneManagement.LoadSceneMode | sceneMode | 场景加载模式 |
UnityEngine.SceneManagement.LocalPhysicsMode | physicsMode | 场景物理模式 |
System.Boolean | allowSceneActivation | 是否允许场景激活 |
System.UInt32 | priority | 加载的优先级 |
LoadAssetSync(AssetInfo)
同步加载资源对象
View Source
public AssetHandle LoadAssetSync(AssetInfo assetInfo)
Returns
YooAsset.AssetHandle: 返回资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
LoadAssetSync<TObject>(string)
同步加载资源对象
View Source
public AssetHandle LoadAssetSync<TObject>(string location) where TObject : Object
Returns
YooAsset.AssetHandle: 返回资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
Type Parameters
| Name | Description |
|---|---|
TObject | 资源类型 |
LoadAssetSync(string, Type)
同步加载资源对象
View Source
public AssetHandle LoadAssetSync(string location, Type type)
Returns
YooAsset.AssetHandle: 返回资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.Type | type | 资源类型 |
LoadAssetSync(string)
同步加载资源对象
View Source
public AssetHandle LoadAssetSync(string location)
Returns
YooAsset.AssetHandle: 返回资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
LoadAssetAsync(AssetInfo, uint)
加载资源对象
View Source
public AssetHandle LoadAssetAsync(AssetInfo assetInfo, uint priority = 0)
Returns
YooAsset.AssetHandle: 返回资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
System.UInt32 | priority | 加载的优先级 |
LoadAssetAsync<TObject>(string, uint)
加载资源对象
View Source
public AssetHandle LoadAssetAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns
YooAsset.AssetHandle: 返回资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.UInt32 | priority | 加载的优先级 |
Type Parameters
| Name | Description |
|---|---|
TObject | 资源类型 |
LoadAssetAsync(string, Type, uint)
加载资源对象
View Source
public AssetHandle LoadAssetAsync(string location, Type type, uint priority = 0)
Returns
YooAsset.AssetHandle: 返回资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.Type | type | 资源类型 |
System.UInt32 | priority | 加载的优先级 |
LoadAssetAsync(string, uint)
加载资源对象
View Source
public AssetHandle LoadAssetAsync(string location, uint priority = 0)
Returns
YooAsset.AssetHandle: 返回资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.UInt32 | priority | 加载的优先级 |
LoadSubAssetsSync(AssetInfo)
同步加载子资源对象
View Source
public SubAssetsHandle LoadSubAssetsSync(AssetInfo assetInfo)
Returns
YooAsset.SubAssetsHandle: 返回子资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
LoadSubAssetsSync<TObject>(string)
同步加载子资源对象
View Source
public SubAssetsHandle LoadSubAssetsSync<TObject>(string location) where TObject : Object
Returns
YooAsset.SubAssetsHandle: 返回子资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
Type Parameters
| Name | Description |
|---|---|
TObject | 资源类型 |
LoadSubAssetsSync(string, Type)
同步加载子资源对象
View Source
public SubAssetsHandle LoadSubAssetsSync(string location, Type type)
Returns
YooAsset.SubAssetsHandle: 返回子资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.Type | type | 子对象类型 |
LoadSubAssetsSync(string)
同步加载子资源对象
View Source
public SubAssetsHandle LoadSubAssetsSync(string location)
Returns
YooAsset.SubAssetsHandle: 返回子资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
LoadSubAssetsAsync(AssetInfo, uint)
加载子资源对象
View Source
public SubAssetsHandle LoadSubAssetsAsync(AssetInfo assetInfo, uint priority = 0)
Returns
YooAsset.SubAssetsHandle: 返回子资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
System.UInt32 | priority | 加载的优先级 |
LoadSubAssetsAsync<TObject>(string, uint)
加载子资源对象
View Source
public SubAssetsHandle LoadSubAssetsAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns
YooAsset.SubAssetsHandle: 返回子资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.UInt32 | priority | 加载的优先级 |
Type Parameters
| Name | Description |
|---|---|
TObject | 资源类型 |
LoadSubAssetsAsync(string, Type, uint)
加载子资源对象
View Source
public SubAssetsHandle LoadSubAssetsAsync(string location, Type type, uint priority = 0)
Returns
YooAsset.SubAssetsHandle: 返回子资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.Type | type | 子对象类型 |
System.UInt32 | priority | 加载的优先级 |
LoadSubAssetsAsync(string, uint)
加载子资源对象
View Source
public SubAssetsHandle LoadSubAssetsAsync(string location, uint priority = 0)
Returns
YooAsset.SubAssetsHandle: 返回子资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.UInt32 | priority | 加载的优先级 |
LoadAllAssetsSync(AssetInfo)
同步加载资源包内所有资源对象
View Source
public AllAssetsHandle LoadAllAssetsSync(AssetInfo assetInfo)
Returns
YooAsset.AllAssetsHandle: 返回全资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
LoadAllAssetsSync<TObject>(string)
同步加载资源包内所有资源对象
View Source
public AllAssetsHandle LoadAllAssetsSync<TObject>(string location) where TObject : Object
Returns
YooAsset.AllAssetsHandle: 返回全资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
Type Parameters
| Name | Description |
|---|---|
TObject | 资源类型 |
LoadAllAssetsSync(string, Type)
同步加载资源包内所有资源对象
View Source
public AllAssetsHandle LoadAllAssetsSync(string location, Type type)
Returns
YooAsset.AllAssetsHandle: 返回全资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.Type | type | 子对象类型 |
LoadAllAssetsSync(string)
同步加载资源包内所有资源对象
View Source
public AllAssetsHandle LoadAllAssetsSync(string location)
Returns
YooAsset.AllAssetsHandle: 返回全资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
LoadAllAssetsAsync(AssetInfo, uint)
加载资源包内所有资源对象
View Source
public AllAssetsHandle LoadAllAssetsAsync(AssetInfo assetInfo, uint priority = 0)
Returns
YooAsset.AllAssetsHandle: 返回全资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.AssetInfo | assetInfo | 资源信息 |
System.UInt32 | priority | 加载的优先级 |
LoadAllAssetsAsync<TObject>(string, uint)
加载资源包内所有资源对象
View Source
public AllAssetsHandle LoadAllAssetsAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns
YooAsset.AllAssetsHandle: 返回全资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.UInt32 | priority | 加载的优先级 |
Type Parameters
| Name | Description |
|---|---|
TObject | 资源类型 |
LoadAllAssetsAsync(string, Type, uint)
加载资源包内所有资源对象
View Source
public AllAssetsHandle LoadAllAssetsAsync(string location, Type type, uint priority = 0)
Returns
YooAsset.AllAssetsHandle: 返回全资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.Type | type | 子对象类型 |
System.UInt32 | priority | 加载的优先级 |
LoadAllAssetsAsync(string, uint)
加载资源包内所有资源对象
View Source
public AllAssetsHandle LoadAllAssetsAsync(string location, uint priority = 0)
Returns
YooAsset.AllAssetsHandle: 返回全资源操作句柄
Parameters
| Type | Name | Description |
|---|---|---|
System.String | location | 资源的定位地址 |
System.UInt32 | priority | 加载的优先级 |
CreateResourceDownloader(ResourceDownloaderOptions)
创建资源下载器,用于下载指定的资源标签关联的资源包文件。
View Source
public ResourceDownloaderOperation CreateResourceDownloader(ResourceDownloaderOptions options)
Returns
YooAsset.ResourceDownloaderOperation: 返回资源下载操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.ResourceDownloaderOptions | options | 资源下载选项 |
CreateResourceDownloader(BundleDownloaderOptions)
创建资源下载器,用于下载指定的资源信息列表依赖的资源包文件。
View Source
public ResourceDownloaderOperation CreateResourceDownloader(BundleDownloaderOptions options)
Returns
YooAsset.ResourceDownloaderOperation: 返回资源下载操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.BundleDownloaderOptions | options | 资源下载选项 |
CreateResourceUnpacker(ResourceUnpackerOptions)
创建内置资源解压器,用于解压指定的资源标签关联的资源包文件。
View Source
public ResourceUnpackerOperation CreateResourceUnpacker(ResourceUnpackerOptions options)
Returns
YooAsset.ResourceUnpackerOperation: 返回资源解压操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.ResourceUnpackerOptions | options | 资源解压选项 |
CreateResourceImporter(BundleImporterOptions)
创建资源导入器
View Source
public ResourceImporterOperation CreateResourceImporter(BundleImporterOptions options)
Returns
YooAsset.ResourceImporterOperation: 返回资源导入操作对象
Parameters
| Type | Name | Description |
|---|---|---|
| YooAsset.BundleImporterOptions | options | 资源导入选项 |