124 KiB
YooAsset 2.3.x API Reference
Auto-generated from https://www.yooasset.com/docs/2.3.x/api/YooAsset/ Generated on 2026-06-09 16:49:39
Class AllAssetsHandle
Assembly: YooAsset.dll
Declaration
public sealed class AllAssetsHandle : HandleBase, IEnumerator, IDisposable
Properties
AllAssetObjects
子资源对象集合
Declaration
public IReadOnlyList<Object> AllAssetObjects { get; }
Methods
WaitForAsyncComplete()
等待异步执行完毕
Declaration
public void WaitForAsyncComplete()
Events
Completed
完成委托
Declaration
public event Action<AllAssetsHandle> Completed
Event Type
System.Action<YooAsset.AllAssetsHandle>
Implements
-
System.Collections.IEnumerator -
System.IDisposable
Class AssetHandle
Assembly: YooAsset.dll
Declaration
public sealed class AssetHandle : HandleBase, IEnumerator, IDisposable
Properties
AssetObject
资源对象
Declaration
public Object AssetObject { get; }
Methods
WaitForAsyncComplete()
等待异步执行完毕
Declaration
public void WaitForAsyncComplete()
GetAssetObject()
获取资源对象
Declaration
public TAsset GetAssetObject<TAsset>() where TAsset : Object
Returns
<TAsset>
Type Parameters
NameDescriptionTAsset资源类型
InstantiateSync()
同步初始化游戏对象
Declaration
public GameObject InstantiateSync()
Returns
UnityEngine.GameObject
InstantiateSync(Transform)
Declaration
public GameObject InstantiateSync(Transform parent)
Returns
UnityEngine.GameObject
Parameters
TypeNameUnityEngine.Transformparent
InstantiateSync(Transform, bool)
Declaration
public GameObject InstantiateSync(Transform parent, bool worldPositionStays)
Returns
UnityEngine.GameObject
Parameters
TypeNameUnityEngine.TransformparentSystem.BooleanworldPositionStays
InstantiateSync(Vector3, Quaternion)
Declaration
public GameObject InstantiateSync(Vector3 position, Quaternion rotation)
Returns
UnityEngine.GameObject
Parameters
TypeNameUnityEngine.Vector3positionUnityEngine.Quaternionrotation
InstantiateSync(Vector3, Quaternion, Transform)
Declaration
public GameObject InstantiateSync(Vector3 position, Quaternion rotation, Transform parent)
Returns
UnityEngine.GameObject
Parameters
TypeNameUnityEngine.Vector3positionUnityEngine.QuaternionrotationUnityEngine.Transformparent
InstantiateAsync(bool)
异步初始化游戏对象
Declaration
public InstantiateOperation InstantiateAsync(bool actived = true)
Returns
Parameters
TypeNameSystem.Booleanactived
InstantiateAsync(Transform, bool)
Declaration
public InstantiateOperation InstantiateAsync(Transform parent, bool actived = true)
Returns
Parameters
TypeNameUnityEngine.TransformparentSystem.Booleanactived
InstantiateAsync(Transform, bool, bool)
Declaration
public InstantiateOperation InstantiateAsync(Transform parent, bool worldPositionStays, bool actived = true)
Returns
Parameters
TypeNameUnityEngine.TransformparentSystem.BooleanworldPositionStaysSystem.Booleanactived
InstantiateAsync(Vector3, Quaternion, bool)
Declaration
public InstantiateOperation InstantiateAsync(Vector3 position, Quaternion rotation, bool actived = true)
Returns
Parameters
TypeNameUnityEngine.Vector3positionUnityEngine.QuaternionrotationSystem.Booleanactived
InstantiateAsync(Vector3, Quaternion, Transform, bool)
Declaration
public InstantiateOperation InstantiateAsync(Vector3 position, Quaternion rotation, Transform parent, bool actived = true)
Returns
Parameters
TypeNameUnityEngine.Vector3positionUnityEngine.QuaternionrotationUnityEngine.TransformparentSystem.Booleanactived
Events
Completed
完成委托
Declaration
public event Action<AssetHandle> Completed
Event Type
System.Action<YooAsset.AssetHandle>
Implements
-
System.Collections.IEnumerator -
System.IDisposable
Class AssetInfo
Assembly: YooAsset.dll
Declaration
public class AssetInfo
Properties
PackageName
所属包裹
Declaration
public string PackageName { get; }
AssetType
资源类型
Declaration
public Type AssetType { get; }
Error
错误信息
Declaration
public string Error { get; }
IsInvalid
身份是否无效
Declaration
public bool IsInvalid { get; }
Address
可寻址地址
Declaration
public string Address { get; }
AssetPath
资源路径
Declaration
public string AssetPath { get; }
Class AsyncOperationBase
Assembly: YooAsset.dll
Declaration
public abstract class AsyncOperationBase : IEnumerator, IComparable<AsyncOperationBase>
Properties
Priority
任务优先级
Declaration
public uint Priority { get; set; }
Status
任务状态
Declaration
public EOperationStatus Status { get; protected set; }
Error
错误信息
Declaration
public string Error { get; protected set; }
Progress
处理进度
Declaration
public float Progress { get; protected set; }
PackageName
所属包裹名称
Declaration
public string PackageName { get; }
IsDone
是否已经完成
Declaration
public bool IsDone { get; }
Task
异步操作任务
Declaration
public Task Task { get; }
ProcessTime
处理耗时(单位:毫秒)
Declaration
public long ProcessTime { get; protected set; }
Fields
BeginTime
开始的时间
Declaration
public string BeginTime
Methods
ExecuteWhileDone()
执行While循环
Declaration
protected bool ExecuteWhileDone()
Returns
System.Boolean
ClearCompletedCallback()
清空完成回调
Declaration
protected void ClearCompletedCallback()
WaitForAsyncComplete()
等待异步执行完毕
Declaration
public void WaitForAsyncComplete()
CompareTo(AsyncOperationBase)
Declaration
public int CompareTo(AsyncOperationBase other)
Returns
System.Int32
Parameters
TypeNameYooAsset.AsyncOperationBaseother
Events
Completed
完成事件
Declaration
public event Action<AsyncOperationBase> Completed
Event Type
System.Action<YooAsset.AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class ClearCacheFilesOperation
Assembly: YooAsset.dll
Declaration
public sealed class ClearCacheFilesOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class CustomPlayModeParameters
自定义运行模式的初始化参数
Assembly: YooAsset.dll
Declaration
public class CustomPlayModeParameters : InitializeParameters
Fields
FileSystemParameterList
文件系统初始化参数列表 注意:列表最后一个元素作为主文件系统!
Declaration
public readonly List<FileSystemParameters> FileSystemParameterList
Struct DecryptFileInfo
Assembly: YooAsset.dll
Declaration
public struct DecryptFileInfo
Fields
BundleName
资源包名称
Declaration
public string BundleName
FileLoadPath
文件加载路径
Declaration
public string FileLoadPath
FileLoadCRC
Unity引擎用于内容校验的CRC
Declaration
public uint FileLoadCRC
Struct DecryptResult
Assembly: YooAsset.dll
Declaration
public struct DecryptResult
Fields
Result
资源包对象
Declaration
public AssetBundle Result
CreateRequest
异步请求句柄
Declaration
public AssetBundleCreateRequest CreateRequest
ManagedStream
托管流对象 注意:流对象在资源包对象释放的时候会自动释放
Declaration
public Stream ManagedStream
Class DestroyOperation
Assembly: YooAsset.dll
Declaration
public class DestroyOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Struct DownloaderFinishData
下载器结束
Assembly: YooAsset.dll
Declaration
public struct DownloaderFinishData
Fields
PackageName
所属包裹名称
Declaration
public string PackageName
Succeed
是否成功
Declaration
public bool Succeed
Class DownloaderOperation
Assembly: YooAsset.dll
Declaration
public abstract class DownloaderOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Properties
TotalDownloadCount
统计的下载文件总数量
Declaration
public int TotalDownloadCount { get; }
TotalDownloadBytes
统计的下载文件的总大小
Declaration
public long TotalDownloadBytes { get; }
CurrentDownloadCount
当前已经完成的下载总数量
Declaration
public int CurrentDownloadCount { get; }
CurrentDownloadBytes
当前已经完成的下载总大小
Declaration
public long CurrentDownloadBytes { get; }
DownloadFinishCallback
当下载器结束(无论成功或失败)
Declaration
public DownloaderOperation.DownloaderFinish DownloadFinishCallback { get; set; }
DownloadUpdateCallback
当下载进度发生变化
Declaration
public DownloaderOperation.DownloadUpdate DownloadUpdateCallback { get; set; }
DownloadErrorCallback
当下载器发生错误
Declaration
public DownloaderOperation.DownloadError DownloadErrorCallback { get; set; }
DownloadFileBeginCallback
当开始下载某个文件
Declaration
public DownloaderOperation.DownloadFileBegin DownloadFileBeginCallback { get; set; }
Methods
Combine(DownloaderOperation)
合并其它下载器
Declaration
public void Combine(DownloaderOperation downloader)
Parameters
TypeNameDescriptionYooAsset.DownloaderOperationdownloader合并的下载器
BeginDownload()
开始下载
Declaration
public void BeginDownload()
PauseDownload()
暂停下载
Declaration
public void PauseDownload()
ResumeDownload()
恢复下载
Declaration
public void ResumeDownload()
CancelDownload()
取消下载
Declaration
public void CancelDownload()
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Delegate DownloaderOperation.DownloaderFinish
下载器结束
Assembly: YooAsset.dll
Declaration
public delegate void DownloaderOperation.DownloaderFinish(DownloaderFinishData data)
Delegate DownloaderOperation.DownloadError
下载发生错误
Assembly: YooAsset.dll
Declaration
public delegate void DownloaderOperation.DownloadError(DownloadErrorData data)
Delegate DownloaderOperation.DownloadFileBegin
开始下载某个文件
Assembly: YooAsset.dll
Declaration
public delegate void DownloaderOperation.DownloadFileBegin(DownloadFileData data)
Delegate DownloaderOperation.DownloadUpdate
下载进度更新
Assembly: YooAsset.dll
Declaration
public delegate void DownloaderOperation.DownloadUpdate(DownloadUpdateData data)
Struct DownloadErrorData
下载器相关的错误数据
Assembly: YooAsset.dll
Declaration
public struct DownloadErrorData
Fields
PackageName
所属包裹名称
Declaration
public string PackageName
FileName
下载失败的文件名称
Declaration
public string FileName
ErrorInfo
错误信息
Declaration
public string ErrorInfo
Struct DownloadFileData
下载器相关的文件数据
Assembly: YooAsset.dll
Declaration
public struct DownloadFileData
Fields
PackageName
所属包裹名称
Declaration
public string PackageName
FileName
下载的文件名称
Declaration
public string FileName
FileSize
下载的文件大小
Declaration
public long FileSize
Struct DownloadStatus
Assembly: YooAsset.dll
Declaration
public struct DownloadStatus
Fields
IsDone
下载是否已经完成
Declaration
public bool IsDone
Progress
下载进度(0-1f)
Declaration
public float Progress
TotalBytes
下载文件的总大小
Declaration
public long TotalBytes
DownloadedBytes
已经下载的文件大小
Declaration
public long DownloadedBytes
Methods
CreateDefaultStatus()
Declaration
public static DownloadStatus CreateDefaultStatus()
Returns
YooAsset.DownloadStatus
Struct DownloadUpdateData
下载器相关的更新数据
Assembly: YooAsset.dll
Declaration
public struct DownloadUpdateData
Fields
PackageName
所属包裹名称
Declaration
public string PackageName
Progress
下载进度 (0-1f)
Declaration
public float Progress
TotalDownloadCount
下载文件总数
Declaration
public int TotalDownloadCount
CurrentDownloadCount
当前完成的下载文件数量
Declaration
public int CurrentDownloadCount
TotalDownloadBytes
下载数据总大小(单位:字节)
Declaration
public long TotalDownloadBytes
CurrentDownloadBytes
当前完成的下载数据大小(单位:字节)
Declaration
public long CurrentDownloadBytes
Enum EBuildBundleType
Assembly: YooAsset.dll
Declaration
public enum EBuildBundleType
Fields
Unknown
未知类型
Declaration
Unknown = 0
VirtualBundle
虚拟资源包
Declaration
VirtualBundle = 1
AssetBundle
AssetBundle
Declaration
AssetBundle = 2
RawBundle
原生文件
Declaration
RawBundle = 3
Class EditorSimulateModeHelper
Assembly: YooAsset.dll
Declaration
public class EditorSimulateModeHelper
Methods
SimulateBuild(string)
Declaration
public static PackageInvokeBuildResult SimulateBuild(string packageName)
Returns
YooAsset.PackageInvokeBuildResult
Parameters
TypeNameSystem.StringpackageName
Class EditorSimulateModeParameters
编辑器下模拟运行模式的初始化参数
Assembly: YooAsset.dll
Declaration
public class EditorSimulateModeParameters : InitializeParameters
Fields
EditorFileSystemParameters
Declaration
public FileSystemParameters EditorFileSystemParameters
Enum EFileClearMode
文件清理方式
Assembly: YooAsset.dll
Declaration
public enum EFileClearMode
Fields
ClearAllBundleFiles
清理所有文件
Declaration
ClearAllBundleFiles = 0
ClearUnusedBundleFiles
清理未在使用的文件
Declaration
ClearUnusedBundleFiles = 1
ClearBundleFilesByTags
Declaration
ClearBundleFilesByTags = 2
ClearAllManifestFiles
清理所有清单
Declaration
ClearAllManifestFiles = 3
ClearUnusedManifestFiles
清理未在使用的清单
Declaration
ClearUnusedManifestFiles = 4
Enum EFileNameStyle
Assembly: YooAsset.dll
Declaration
public enum EFileNameStyle
Fields
HashName
哈希值名称
Declaration
HashName = 0
BundleName
资源包名称(不推荐)
Declaration
BundleName = 1
BundleName_HashName
资源包名称 + 哈希值名称
Declaration
BundleName_HashName = 2
Enum EFileVerifyLevel
文件校验等级
Assembly: YooAsset.dll
Declaration
public enum EFileVerifyLevel
Fields
Low
验证文件存在
Declaration
Low = 1
Middle
验证文件大小
Declaration
Middle = 2
High
验证文件大小和CRC
Declaration
High = 3
Struct EncryptFileInfo
Assembly: YooAsset.dll
Declaration
public struct EncryptFileInfo
Fields
BundleName
资源包名称
Declaration
public string BundleName
FileLoadPath
文件路径
Declaration
public string FileLoadPath
Struct EncryptResult
Assembly: YooAsset.dll
Declaration
public struct EncryptResult
Fields
Encrypted
文件是否加密
Declaration
public bool Encrypted
EncryptedData
加密后的文件数据
Declaration
public byte[] EncryptedData
Enum EOperationStatus
Assembly: YooAsset.dll
Declaration
public enum EOperationStatus
Fields
None
Declaration
None = 0
Processing
Declaration
Processing = 1
Succeed
Declaration
Succeed = 2
Failed
Declaration
Failed = 3
Enum EOverwriteInstallClearMode
覆盖安装清理模式
Assembly: YooAsset.dll
Declaration
public enum EOverwriteInstallClearMode
Fields
None
不做任何处理
Declaration
None = 0
ClearAllCacheFiles
清理所有缓存文件(包含资源文件和清单文件)
Declaration
ClearAllCacheFiles = 1
ClearAllBundleFiles
清理所有缓存的资源文件
Declaration
ClearAllBundleFiles = 2
ClearAllManifestFiles
清理所有缓存的清单文件
Declaration
ClearAllManifestFiles = 3
Enum EPlayMode
运行模式
Assembly: YooAsset.dll
Declaration
public enum EPlayMode
Fields
EditorSimulateMode
编辑器下的模拟模式
Declaration
EditorSimulateMode = 0
OfflinePlayMode
离线运行模式
Declaration
OfflinePlayMode = 1
HostPlayMode
联机运行模式
Declaration
HostPlayMode = 2
WebPlayMode
WebGL运行模式
Declaration
WebPlayMode = 3
CustomPlayMode
自定义运行模式
Declaration
CustomPlayMode = 4
Class FileSystemParameters
文件系统参数
Assembly: YooAsset.dll
Declaration
public class FileSystemParameters
Properties
FileSystemClass
文件系统类 格式: "namespace.class,assembly" 格式: "命名空间.类型名,程序集"
Declaration
public string FileSystemClass { get; }
PackageRoot
文件系统的根目录
Declaration
public string PackageRoot { get; }
Methods
AddParameter(string, object)
添加自定义参数
Declaration
public void AddParameter(string name, object value)
Parameters
TypeNameSystem.StringnameSystem.Objectvalue
CreateDefaultEditorFileSystemParameters(string)
创建默认的编辑器文件系统参数
文件系统的根目录Declaration
public static FileSystemParameters CreateDefaultEditorFileSystemParameters(string packageRoot)
Returns
Parameters
TypeNameSystem.StringpackageRoot
CreateDefaultBuildinFileSystemParameters(IDecryptionServices, string)
创建默认的内置文件系统参数
Declaration
public static FileSystemParameters CreateDefaultBuildinFileSystemParameters(IDecryptionServices decryptionServices = null, string packageRoot = null)
Returns
Parameters
TypeNameDescriptionYooAsset.IDecryptionServicesdecryptionServices加密文件解密服务类System.StringpackageRoot文件系统的根目录
CreateDefaultCacheFileSystemParameters(IRemoteServices, IDecryptionServices, string)
创建默认的缓存文件系统参数
Declaration
public static FileSystemParameters CreateDefaultCacheFileSystemParameters(IRemoteServices remoteServices, IDecryptionServices decryptionServices = null, string packageRoot = null)
Returns
Parameters
TypeNameDescriptionYooAsset.IRemoteServicesremoteServices远端资源地址查询服务类YooAsset.IDecryptionServicesdecryptionServices加密文件解密服务类System.StringpackageRoot文件系统的根目录
CreateDefaultWebServerFileSystemParameters(IWebDecryptionServices, bool)
创建默认的WebServer文件系统参数
Declaration
public static FileSystemParameters CreateDefaultWebServerFileSystemParameters(IWebDecryptionServices decryptionServices = null, bool disableUnityWebCache = false)
Returns
Parameters
TypeNameDescriptionYooAsset.IWebDecryptionServicesdecryptionServices加密文件解密服务类System.BooleandisableUnityWebCache禁用Unity的网络缓存
CreateDefaultWebRemoteFileSystemParameters(IRemoteServices, IWebDecryptionServices, bool)
创建默认的WebRemote文件系统参数
Declaration
public static FileSystemParameters CreateDefaultWebRemoteFileSystemParameters(IRemoteServices remoteServices, IWebDecryptionServices decryptionServices = null, bool disableUnityWebCache = false)
Returns
Parameters
TypeNameDescriptionYooAsset.IRemoteServicesremoteServices远端资源地址查询服务类YooAsset.IWebDecryptionServicesdecryptionServices加密文件解密服务类System.BooleandisableUnityWebCache禁用Unity的网络缓存
Class FileSystemParametersDefine
Assembly: YooAsset.dll
Declaration
public class FileSystemParametersDefine
Fields
FILE_VERIFY_LEVEL
Declaration
public const string FILE_VERIFY_LEVEL = "FILE_VERIFY_LEVEL"
FILE_VERIFY_MAX_CONCURRENCY
Declaration
public const string FILE_VERIFY_MAX_CONCURRENCY = "FILE_VERIFY_MAX_CONCURRENCY"
INSTALL_CLEAR_MODE
Declaration
public const string INSTALL_CLEAR_MODE = "INSTALL_CLEAR_MODE"
REMOTE_SERVICES
Declaration
public const string REMOTE_SERVICES = "REMOTE_SERVICES"
DECRYPTION_SERVICES
Declaration
public const string DECRYPTION_SERVICES = "DECRYPTION_SERVICES"
MANIFEST_SERVICES
Declaration
public const string MANIFEST_SERVICES = "MANIFEST_SERVICES"
APPEND_FILE_EXTENSION
Declaration
public const string APPEND_FILE_EXTENSION = "APPEND_FILE_EXTENSION"
DISABLE_CATALOG_FILE
Declaration
public const string DISABLE_CATALOG_FILE = "DISABLE_CATALOG_FILE"
DISABLE_UNITY_WEB_CACHE
Declaration
public const string DISABLE_UNITY_WEB_CACHE = "DISABLE_UNITY_WEB_CACHE"
DISABLE_ONDEMAND_DOWNLOAD
Declaration
public const string DISABLE_ONDEMAND_DOWNLOAD = "DISABLE_ONDEMAND_DOWNLOAD"
DOWNLOAD_MAX_CONCURRENCY
Declaration
public const string DOWNLOAD_MAX_CONCURRENCY = "DOWNLOAD_MAX_CONCURRENCY"
DOWNLOAD_MAX_REQUEST_PER_FRAME
Declaration
public const string DOWNLOAD_MAX_REQUEST_PER_FRAME = "DOWNLOAD_MAX_REQUEST_PER_FRAME"
DOWNLOAD_WATCH_DOG_TIME
Declaration
public const string DOWNLOAD_WATCH_DOG_TIME = "DOWNLOAD_WATCH_DOG_TIME"
RESUME_DOWNLOAD_MINMUM_SIZE
Declaration
public const string RESUME_DOWNLOAD_MINMUM_SIZE = "RESUME_DOWNLOAD_MINMUM_SIZE"
RESUME_DOWNLOAD_RESPONSE_CODES
Declaration
public const string RESUME_DOWNLOAD_RESPONSE_CODES = "RESUME_DOWNLOAD_RESPONSE_CODES"
VIRTUAL_WEBGL_MODE
Declaration
public const string VIRTUAL_WEBGL_MODE = "VIRTUAL_WEBGL_MODE"
VIRTUAL_DOWNLOAD_MODE
Declaration
public const string VIRTUAL_DOWNLOAD_MODE = "VIRTUAL_DOWNLOAD_MODE"
VIRTUAL_DOWNLOAD_SPEED
Declaration
public const string VIRTUAL_DOWNLOAD_SPEED = "VIRTUAL_DOWNLOAD_SPEED"
ASYNC_SIMULATE_MIN_FRAME
Declaration
public const string ASYNC_SIMULATE_MIN_FRAME = "ASYNC_SIMULATE_MIN_FRAME"
ASYNC_SIMULATE_MAX_FRAME
Declaration
public const string ASYNC_SIMULATE_MAX_FRAME = "ASYNC_SIMULATE_MAX_FRAME"
COPY_BUILDIN_PACKAGE_MANIFEST
Declaration
public const string COPY_BUILDIN_PACKAGE_MANIFEST = "COPY_BUILDIN_PACKAGE_MANIFEST"
COPY_BUILDIN_PACKAGE_MANIFEST_DEST_ROOT
Declaration
public const string COPY_BUILDIN_PACKAGE_MANIFEST_DEST_ROOT = "COPY_BUILDIN_PACKAGE_MANIFEST_DEST_ROOT"
COPY_LOCAL_FILE_SERVICES
Declaration
public const string COPY_LOCAL_FILE_SERVICES = "COPY_LOCAL_FILE_SERVICES"
Class GameAsyncOperation
Assembly: YooAsset.dll
Declaration
public abstract class GameAsyncOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Methods
OnStart()
异步操作开始
Declaration
protected abstract void OnStart()
OnUpdate()
异步操作更新
Declaration
protected abstract void OnUpdate()
OnAbort()
异步操作终止
Declaration
protected abstract void OnAbort()
OnWaitForAsyncComplete()
异步等待完成
Declaration
protected virtual void OnWaitForAsyncComplete()
IsBusy()
异步操作系统是否繁忙
Declaration
protected bool IsBusy()
Returns
System.Boolean
Abort()
终止异步操作
Declaration
protected void Abort()
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class HandleBase
Assembly: YooAsset.dll
Declaration
public abstract class HandleBase : IEnumerator, IDisposable
Properties
Status
当前状态
Declaration
public EOperationStatus Status { get; }
LastError
最近的错误信息
Declaration
public string LastError { get; }
Progress
加载进度
Declaration
public float Progress { get; }
IsDone
是否加载完毕
Declaration
public bool IsDone { get; }
IsValid
句柄是否有效
Declaration
public bool IsValid { get; }
Task
异步操作任务
Declaration
public Task Task { get; }
Methods
Release()
释放资源句柄
Declaration
public void Release()
Dispose()
释放资源句柄
Declaration
public void Dispose()
GetAssetInfo()
获取资源信息
Declaration
public AssetInfo GetAssetInfo()
Returns
GetDownloadStatus()
获取下载报告
Declaration
public DownloadStatus GetDownloadStatus()
Returns
Implements
-
System.Collections.IEnumerator -
System.IDisposable
Class HashUtility
哈希工具类
Assembly: YooAsset.dll
Declaration
public static class HashUtility
Methods
StringSHA1(string)
获取字符串的Hash值
Declaration
public static string StringSHA1(string str)
Returns
System.String
Parameters
TypeNameSystem.Stringstr
FileSHA1(string)
获取文件的Hash值
Declaration
public static string FileSHA1(string filePath)
Returns
System.String
Parameters
TypeNameSystem.StringfilePath
FileSHA1Safely(string)
获取文件的Hash值
Declaration
public static string FileSHA1Safely(string filePath)
Returns
System.String
Parameters
TypeNameSystem.StringfilePath
StreamSHA1(Stream)
获取数据流的Hash值
Declaration
public static string StreamSHA1(Stream stream)
Returns
System.String
Parameters
TypeNameSystem.IO.Streamstream
BytesSHA1(byte[])
获取字节数组的Hash值
Declaration
public static string BytesSHA1(byte[] buffer)
Returns
System.String
Parameters
TypeNameSystem.Byte[]buffer
StringMD5(string)
获取字符串的MD5
Declaration
public static string StringMD5(string str)
Returns
System.String
Parameters
TypeNameSystem.Stringstr
FileMD5(string)
获取文件的MD5
Declaration
public static string FileMD5(string filePath)
Returns
System.String
Parameters
TypeNameSystem.StringfilePath
FileMD5Safely(string)
获取文件的MD5
Declaration
public static string FileMD5Safely(string filePath)
Returns
System.String
Parameters
TypeNameSystem.StringfilePath
StreamMD5(Stream)
获取数据流的MD5
Declaration
public static string StreamMD5(Stream stream)
Returns
System.String
Parameters
TypeNameSystem.IO.Streamstream
BytesMD5(byte[])
获取字节数组的MD5
Declaration
public static string BytesMD5(byte[] buffer)
Returns
System.String
Parameters
TypeNameSystem.Byte[]buffer
StringCRC32(string)
获取字符串的CRC32
Declaration
public static string StringCRC32(string str)
Returns
System.String
Parameters
TypeNameSystem.Stringstr
StringCRC32Value(string)
Declaration
public static uint StringCRC32Value(string str)
Returns
System.UInt32
Parameters
TypeNameSystem.Stringstr
FileCRC32(string)
获取文件的CRC32
Declaration
public static string FileCRC32(string filePath)
Returns
System.String
Parameters
TypeNameSystem.StringfilePath
FileCRC32Value(string)
Declaration
public static uint FileCRC32Value(string filePath)
Returns
System.UInt32
Parameters
TypeNameSystem.StringfilePath
FileCRC32Safely(string)
获取文件的CRC32
Declaration
public static string FileCRC32Safely(string filePath)
Returns
System.String
Parameters
TypeNameSystem.StringfilePath
FileCRC32ValueSafely(string)
Declaration
public static uint FileCRC32ValueSafely(string filePath)
Returns
System.UInt32
Parameters
TypeNameSystem.StringfilePath
StreamCRC32(Stream)
获取数据流的CRC32
Declaration
public static string StreamCRC32(Stream stream)
Returns
System.String
Parameters
TypeNameSystem.IO.Streamstream
StreamCRC32Value(Stream)
Declaration
public static uint StreamCRC32Value(Stream stream)
Returns
System.UInt32
Parameters
TypeNameSystem.IO.Streamstream
BytesCRC32(byte[])
获取字节数组的CRC32
Declaration
public static string BytesCRC32(byte[] buffer)
Returns
System.String
Parameters
TypeNameSystem.Byte[]buffer
BytesCRC32Value(byte[])
Declaration
public static uint BytesCRC32Value(byte[] buffer)
Returns
System.UInt32
Parameters
TypeNameSystem.Byte[]buffer
Class HostPlayModeParameters
联机运行模式的初始化参数
Assembly: YooAsset.dll
Declaration
public class HostPlayModeParameters : InitializeParameters
Fields
BuildinFileSystemParameters
Declaration
public FileSystemParameters BuildinFileSystemParameters
CacheFileSystemParameters
Declaration
public FileSystemParameters CacheFileSystemParameters
Interface ICopyLocalFileServices
本地文件拷贝服务类 备注:包体内文件拷贝,沙盒内文件导入都会触发该服务!
Assembly: YooAsset.dll
Declaration
public interface ICopyLocalFileServices
Methods
CopyFile(LocalFileInfo, string)
Declaration
void CopyFile(LocalFileInfo sourceFileInfo, string destFilePath)
Parameters
TypeNameYooAsset.LocalFileInfosourceFileInfoSystem.StringdestFilePath
Interface IDecryptionServices
Assembly: YooAsset.dll
Declaration
public interface IDecryptionServices
Methods
LoadAssetBundle(DecryptFileInfo)
同步方式获取解密的资源包
Declaration
DecryptResult LoadAssetBundle(DecryptFileInfo fileInfo)
Returns
Parameters
TypeNameYooAsset.DecryptFileInfofileInfo
LoadAssetBundleAsync(DecryptFileInfo)
异步方式获取解密的资源包
Declaration
DecryptResult LoadAssetBundleAsync(DecryptFileInfo fileInfo)
Returns
Parameters
TypeNameYooAsset.DecryptFileInfofileInfo
LoadAssetBundleFallback(DecryptFileInfo)
后备方式获取解密的资源包 注意:当正常解密方法失败后,会触发后备加载! 说明:建议通过LoadFromMemory()方法加载资源包作为保底机制。 issues : https://github.com/tuyoogame/YooAsset/issues/562
Declaration
DecryptResult LoadAssetBundleFallback(DecryptFileInfo fileInfo)
Returns
Parameters
TypeNameYooAsset.DecryptFileInfofileInfo
ReadFileData(DecryptFileInfo)
获取解密的字节数据
Declaration
byte[] ReadFileData(DecryptFileInfo fileInfo)
Returns
System.Byte[]
Parameters
TypeNameYooAsset.DecryptFileInfofileInfo
ReadFileText(DecryptFileInfo)
获取解密的文本数据
Declaration
string ReadFileText(DecryptFileInfo fileInfo)
Returns
System.String
Parameters
TypeNameYooAsset.DecryptFileInfofileInfo
Interface IEncryptionServices
Assembly: YooAsset.dll
Declaration
public interface IEncryptionServices
Methods
Encrypt(EncryptFileInfo)
Declaration
EncryptResult Encrypt(EncryptFileInfo fileInfo)
Returns
Parameters
TypeNameYooAsset.EncryptFileInfofileInfo
Interface ILogger
自定义日志处理
Assembly: YooAsset.dll
Declaration
public interface ILogger
Methods
Log(string)
Declaration
void Log(string message)
Parameters
TypeNameSystem.Stringmessage
Warning(string)
Declaration
void Warning(string message)
Parameters
TypeNameSystem.Stringmessage
Error(string)
Declaration
void Error(string message)
Parameters
TypeNameSystem.Stringmessage
Exception(Exception)
Declaration
void Exception(Exception exception)
Parameters
TypeNameSystem.Exceptionexception
Interface IManifestProcessServices
资源清单文件处理服务接口
Assembly: YooAsset.dll
Declaration
public interface IManifestProcessServices
Methods
ProcessManifest(byte[])
处理资源清单(压缩或加密)
Declaration
byte[] ProcessManifest(byte[] fileData)
Returns
System.Byte[]
Parameters
TypeNameSystem.Byte[]fileData
Interface IManifestRestoreServices
资源清单文件处理服务接口
Assembly: YooAsset.dll
Declaration
public interface IManifestRestoreServices
Methods
RestoreManifest(byte[])
还原资源清单(解压或解密)
Declaration
byte[] RestoreManifest(byte[] fileData)
Returns
System.Byte[]
Parameters
TypeNameSystem.Byte[]fileData
Struct ImportFileInfo
导入文件的信息
Assembly: YooAsset.dll
Declaration
public struct ImportFileInfo
Fields
FilePath
本地文件路径
Declaration
public string FilePath
BundleName
资源包名称
Declaration
public string BundleName
BundleGUID
资源包GUID
Declaration
public string BundleGUID
Class InitializationOperation
Assembly: YooAsset.dll
Declaration
public class InitializationOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class InitializeParameters
初始化参数
Assembly: YooAsset.dll
Declaration
public abstract class InitializeParameters
Fields
BundleLoadingMaxConcurrency
同时加载Bundle文件的最大并发数
Declaration
public int BundleLoadingMaxConcurrency
WebGLForceSyncLoadAsset
WebGL平台强制同步加载资源对象
Declaration
public bool WebGLForceSyncLoadAsset
Class InstantiateOperation
Assembly: YooAsset.dll
Declaration
public sealed class InstantiateOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Fields
Result
实例化的游戏对象
Declaration
public GameObject Result
Methods
Cancel()
取消实例化对象操作
Declaration
public void Cancel()
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Interface IRemoteServices
Assembly: YooAsset.dll
Declaration
public interface IRemoteServices
Methods
GetRemoteMainURL(string)
获取主资源站的资源地址
Declaration
string GetRemoteMainURL(string fileName)
Returns
System.String
Parameters
TypeNameDescriptionSystem.StringfileName请求的文件名称
GetRemoteFallbackURL(string)
获取备用资源站的资源地址
Declaration
string GetRemoteFallbackURL(string fileName)
Returns
System.String
Parameters
TypeNameDescriptionSystem.StringfileName请求的文件名称
Interface IWebDecryptionServices
Assembly: YooAsset.dll
Declaration
public interface IWebDecryptionServices
Methods
LoadAssetBundle(WebDecryptFileInfo)
Declaration
WebDecryptResult LoadAssetBundle(WebDecryptFileInfo fileInfo)
Returns
Parameters
TypeNameYooAsset.WebDecryptFileInfofileInfo
Struct LocalFileInfo
Assembly: YooAsset.dll
Declaration
public struct LocalFileInfo
Fields
PackageName
包裹名称
Declaration
public string PackageName
BundleName
资源包名称
Declaration
public string BundleName
SourceFileURL
源文件请求地址
Declaration
public string SourceFileURL
Class ManifestDefine
Assembly: YooAsset.dll
Declaration
public class ManifestDefine
Fields
FileMaxSize
文件极限大小(100MB)
Declaration
public const int FileMaxSize = 104857600
FileSign
文件头标记
Declaration
public const uint FileSign = 5853007
FileVersion
文件格式版本
Declaration
public const string FileVersion = "2025.8.28"
Class OfflinePlayModeParameters
离线运行模式的初始化参数
Assembly: YooAsset.dll
Declaration
public class OfflinePlayModeParameters : InitializeParameters
Fields
BuildinFileSystemParameters
Declaration
public FileSystemParameters BuildinFileSystemParameters
Class PackageDetails
Assembly: YooAsset.dll
Declaration
public class PackageDetails
Fields
FileVersion
文件版本
Declaration
public string FileVersion
EnableAddressable
启用可寻址资源定位
Declaration
public bool EnableAddressable
SupportExtensionless
支持无后缀名的资源定位地址
Declaration
public bool SupportExtensionless
LocationToLower
资源定位地址大小写不敏感
Declaration
public bool LocationToLower
IncludeAssetGUID
包含资源GUID数据
Declaration
public bool IncludeAssetGUID
OutputNameStyle
文件名称样式
Declaration
public int OutputNameStyle
BuildBundleType
构建资源包类型
Declaration
public int BuildBundleType
BuildPipeline
构建管线名称
Declaration
public string BuildPipeline
PackageName
资源包裹名称
Declaration
public string PackageName
PackageVersion
资源包裹的版本信息
Declaration
public string PackageVersion
PackageNote
资源包裹的备注信息
Declaration
public string PackageNote
AssetTotalCount
主资源文件总数
Declaration
public int AssetTotalCount
BundleTotalCount
资源包文件总数
Declaration
public int BundleTotalCount
Class PackageInvokeBuilder
Assembly: YooAsset.dll
Declaration
public static class PackageInvokeBuilder
Methods
InvokeBuilder(PackageInvokeBuildParam)
Declaration
public static PackageInvokeBuildResult InvokeBuilder(PackageInvokeBuildParam buildParam)
Returns
YooAsset.PackageInvokeBuildResult
Parameters
TypeNameYooAsset.PackageInvokeBuildParambuildParam
Class PackageInvokeBuildParam
Assembly: YooAsset.dll
Declaration
public class PackageInvokeBuildParam
Fields
PackageName
包裹名称
Declaration
public readonly string PackageName
BuildPipelineName
构建管线名称
Declaration
public string BuildPipelineName
BuildUserData
用户数据
Declaration
public object BuildUserData
InvokeAssmeblyName
构建类所属程序集名称
Declaration
public string InvokeAssmeblyName
InvokeClassFullName
构建执行的类名全称 注意:类名必须包含命名空间!
Declaration
public string InvokeClassFullName
InvokeMethodName
构建执行的方法名称 注意:执行方法必须满足 BindingFlags.Public | BindingFlags.Static
Declaration
public string InvokeMethodName
Class PackageInvokeBuildResult
Assembly: YooAsset.dll
Declaration
public class PackageInvokeBuildResult
Fields
PackageRootDirectory
Declaration
public string PackageRootDirectory
Class PakcageInvokeBuilder
Assembly: YooAsset.dll
Declaration
public static class PakcageInvokeBuilder
Methods
InvokeBuilder(PackageInvokeBuildParam)
Declaration
public static PackageInvokeBuildResult InvokeBuilder(PackageInvokeBuildParam buildParam)
Returns
YooAsset.PackageInvokeBuildResult
Parameters
TypeNameYooAsset.PackageInvokeBuildParambuildParam
Class PreDownloadContentOperation
Assembly: YooAsset.dll
Declaration
public sealed class PreDownloadContentOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Methods
CreateResourceDownloader(int, int)
创建资源下载器,用于下载当前资源版本所有的资源包文件
Declaration
public ResourceDownloaderOperation CreateResourceDownloader(int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateResourceDownloader(string, int, int)
创建资源下载器,用于下载指定的资源标签关联的资源包文件
Declaration
public ResourceDownloaderOperation CreateResourceDownloader(string tag, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.Stringtag资源标签System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateResourceDownloader(string[], int, int)
创建资源下载器,用于下载指定的资源标签列表关联的资源包文件
Declaration
public ResourceDownloaderOperation CreateResourceDownloader(string[] tags, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.String[]tags资源标签列表System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(string, bool, int, int)
创建资源下载器,用于下载指定的资源依赖的资源包文件
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(string location, bool recursiveDownload, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.Stringlocation资源定位地址System.BooleanrecursiveDownloadSystem.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(string[], bool, int, int)
创建资源下载器,用于下载指定的资源列表依赖的资源包文件
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(string[] locations, bool recursiveDownload, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.String[]locations资源定位地址列表System.BooleanrecursiveDownloadSystem.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class RawFileHandle
Assembly: YooAsset.dll
Declaration
public class RawFileHandle : HandleBase, IEnumerator, IDisposable
Methods
WaitForAsyncComplete()
等待异步执行完毕
Declaration
public void WaitForAsyncComplete()
GetRawFileData()
获取原生文件的二进制数据
Declaration
public byte[] GetRawFileData()
Returns
System.Byte[]
GetRawFileText()
获取原生文件的文本数据
Declaration
public string GetRawFileText()
Returns
System.String
GetRawFilePath()
获取原生文件的路径
Declaration
public string GetRawFilePath()
Returns
System.String
Events
Completed
完成委托
Declaration
public event Action<RawFileHandle> Completed
Event Type
System.Action<YooAsset.RawFileHandle>
Implements
-
System.Collections.IEnumerator -
System.IDisposable
Class RequestPackageVersionOperation
Assembly: YooAsset.dll
Declaration
public abstract class RequestPackageVersionOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Properties
PackageVersion
当前最新的包裹版本
Declaration
public string PackageVersion { get; protected set; }
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class ResourceDownloaderOperation
Assembly: YooAsset.dll
Declaration
public sealed class ResourceDownloaderOperation : DownloaderOperation, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class ResourceImporterOperation
Assembly: YooAsset.dll
Declaration
public sealed class ResourceImporterOperation : DownloaderOperation, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class ResourcePackage
Assembly: YooAsset.dll
Declaration
public class ResourcePackage
Properties
InitializeStatus
初始化状态
Declaration
public EOperationStatus InitializeStatus { get; }
PackageValid
包裹是否有效
Declaration
public bool PackageValid { get; }
Fields
PackageName
包裹名
Declaration
public readonly string PackageName
Methods
InitializeAsync(InitializeParameters)
异步初始化
Declaration
public InitializationOperation InitializeAsync(InitializeParameters parameters)
Returns
YooAsset.InitializationOperation
Parameters
TypeNameYooAsset.InitializeParametersparameters
DestroyAsync()
异步销毁
Declaration
public DestroyOperation DestroyAsync()
Returns
RequestPackageVersionAsync(bool, int)
请求最新的资源版本
Declaration
public RequestPackageVersionOperation RequestPackageVersionAsync(bool appendTimeTicks = true, int timeout = 60)
Returns
YooAsset.RequestPackageVersionOperation
Parameters
TypeNameDescriptionSystem.BooleanappendTimeTicks在URL末尾添加时间戳System.Int32timeout超时时间(默认值:60秒)
UpdatePackageManifestAsync(string, int)
更新并加载指定版本的资源清单
Declaration
public UpdatePackageManifestOperation UpdatePackageManifestAsync(string packageVersion, int timeout = 60)
Returns
YooAsset.UpdatePackageManifestOperation
Parameters
TypeNameDescriptionSystem.StringpackageVersion包裹版本System.Int32timeout超时时间(默认值:60秒)
PreDownloadContentAsync(string, int)
预下载指定版本的包裹资源
Declaration
public PreDownloadContentOperation PreDownloadContentAsync(string packageVersion, int timeout = 60)
Returns
YooAsset.PreDownloadContentOperation
Parameters
TypeNameDescriptionSystem.StringpackageVersion包裹版本System.Int32timeout资源清单下载的超时时间(默认值:60秒)
ClearCacheFilesAsync(EFileClearMode, object)
清理缓存文件
Declaration
public ClearCacheFilesOperation ClearCacheFilesAsync(EFileClearMode clearMode, object clearParam = null)
Returns
YooAsset.ClearCacheFilesOperation
Parameters
TypeNameDescriptionYooAsset.EFileClearModeclearMode清理方式System.ObjectclearParam执行参数
ClearCacheFilesAsync(string, object)
清理缓存文件
Declaration
public ClearCacheFilesOperation ClearCacheFilesAsync(string clearMode, object clearParam = null)
Returns
YooAsset.ClearCacheFilesOperation
Parameters
TypeNameDescriptionSystem.StringclearMode清理方式System.ObjectclearParam执行参数
GetPackageVersion()
获取当前加载包裹的版本信息
Declaration
public string GetPackageVersion()
Returns
System.String
GetPackageNote()
获取当前加载包裹的备注信息
Declaration
public string GetPackageNote()
Returns
System.String
GetPackageDetails()
获取当前加载包裹的详细信息
Declaration
public PackageDetails GetPackageDetails()
Returns
UnloadAllAssetsAsync()
强制回收所有资源
Declaration
public UnloadAllAssetsOperation UnloadAllAssetsAsync()
Returns
YooAsset.UnloadAllAssetsOperation
UnloadAllAssetsAsync(UnloadAllAssetsOptions)
强制回收所有资源
Declaration
public UnloadAllAssetsOperation UnloadAllAssetsAsync(UnloadAllAssetsOptions options)
Returns
YooAsset.UnloadAllAssetsOperation
Parameters
TypeNameDescriptionYooAsset.UnloadAllAssetsOptionsoptions卸载选项
UnloadUnusedAssetsAsync(int)
回收不再使用的资源 说明:卸载引用计数为零的资源
Declaration
public UnloadUnusedAssetsOperation UnloadUnusedAssetsAsync(int loopCount = 10)
Returns
YooAsset.UnloadUnusedAssetsOperation
Parameters
TypeNameDescriptionSystem.Int32loopCount循环迭代次数
TryUnloadUnusedAsset(string, int)
资源回收 说明:尝试卸载指定的资源
Declaration
public void TryUnloadUnusedAsset(string location, int loopCount = 10)
Parameters
TypeNameSystem.StringlocationSystem.Int32loopCount
TryUnloadUnusedAsset(AssetInfo, int)
资源回收 说明:尝试卸载指定的资源
Declaration
public void TryUnloadUnusedAsset(AssetInfo assetInfo, int loopCount = 10)
Parameters
TypeNameYooAsset.AssetInfoassetInfoSystem.Int32loopCount
IsNeedDownloadFromRemote(string)
是否需要从远端更新下载
Declaration
public bool IsNeedDownloadFromRemote(string location)
Returns
System.Boolean
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
IsNeedDownloadFromRemote(AssetInfo)
是否需要从远端更新下载
Declaration
public bool IsNeedDownloadFromRemote(AssetInfo assetInfo)
Returns
System.Boolean
Parameters
TypeNameYooAsset.AssetInfoassetInfo
GetAllAssetInfos()
获取所有的资源信息
Declaration
public AssetInfo[] GetAllAssetInfos()
Returns
YooAsset.AssetInfo[]
GetAssetInfos(string)
获取资源信息列表
Declaration
public AssetInfo[] GetAssetInfos(string tag)
Returns
YooAsset.AssetInfo[]
Parameters
TypeNameDescriptionSystem.Stringtag资源标签
GetAssetInfos(string[])
获取资源信息列表
Declaration
public AssetInfo[] GetAssetInfos(string[] tags)
Returns
YooAsset.AssetInfo[]
Parameters
TypeNameDescriptionSystem.String[]tags资源标签列表
GetAssetInfo(string)
获取资源信息
Declaration
public AssetInfo GetAssetInfo(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
GetAssetInfo(string, Type)
获取资源信息
Declaration
public AssetInfo GetAssetInfo(string location, Type type)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype资源类型
GetAssetInfoByGUID(string)
获取资源信息
Declaration
public AssetInfo GetAssetInfoByGUID(string assetGUID)
Returns
Parameters
TypeNameDescriptionSystem.StringassetGUID资源GUID
GetAssetInfoByGUID(string, Type)
获取资源信息
Declaration
public AssetInfo GetAssetInfoByGUID(string assetGUID, Type type)
Returns
Parameters
TypeNameDescriptionSystem.StringassetGUID资源GUIDSystem.Typetype资源类型
CheckLocationValid(string)
检查资源定位地址是否有效
Declaration
public bool CheckLocationValid(string location)
Returns
System.Boolean
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadRawFileSync(AssetInfo)
同步加载原生文件
Declaration
public RawFileHandle LoadRawFileSync(AssetInfo assetInfo)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息
LoadRawFileSync(string)
同步加载原生文件
Declaration
public RawFileHandle LoadRawFileSync(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadRawFileAsync(AssetInfo, uint)
异步加载原生文件
Declaration
public RawFileHandle LoadRawFileAsync(AssetInfo assetInfo, uint priority = 0)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.UInt32priority加载的优先级
LoadRawFileAsync(string, uint)
异步加载原生文件
Declaration
public RawFileHandle LoadRawFileAsync(string location, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority加载的优先级
LoadSceneSync(string, LoadSceneMode, LocalPhysicsMode)
同步加载场景
Declaration
public SceneHandle LoadSceneSync(string location, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation场景的定位地址UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式
LoadSceneSync(AssetInfo, LoadSceneMode, LocalPhysicsMode)
同步加载场景
Declaration
public SceneHandle LoadSceneSync(AssetInfo assetInfo, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo场景的资源信息UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式
LoadSceneAsync(string, LoadSceneMode, LocalPhysicsMode, bool, uint)
异步加载场景
Declaration
public SceneHandle LoadSceneAsync(string location, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None, bool suspendLoad = false, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation场景的定位地址UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式System.BooleansuspendLoad场景加载到90%自动挂起System.UInt32priority加载的优先级
LoadSceneAsync(AssetInfo, LoadSceneMode, LocalPhysicsMode, bool, uint)
异步加载场景
Declaration
public SceneHandle LoadSceneAsync(AssetInfo assetInfo, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None, bool suspendLoad = false, uint priority = 0)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo场景的资源信息UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式System.BooleansuspendLoad场景加载到90%自动挂起System.UInt32priority加载的优先级
LoadAssetSync(AssetInfo)
同步加载资源对象
Declaration
public AssetHandle LoadAssetSync(AssetInfo assetInfo)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息
LoadAssetSync(string)
同步加载资源对象
Declaration
public AssetHandle LoadAssetSync<TObject>(string location) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
Type Parameters
NameDescriptionTObject资源类型
LoadAssetSync(string, Type)
同步加载资源对象
Declaration
public AssetHandle LoadAssetSync(string location, Type type)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype资源类型
LoadAssetSync(string)
同步加载资源对象
Declaration
public AssetHandle LoadAssetSync(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadAssetAsync(AssetInfo, uint)
异步加载资源对象
Declaration
public AssetHandle LoadAssetAsync(AssetInfo assetInfo, uint priority = 0)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.UInt32priority加载的优先级
LoadAssetAsync(string, uint)
异步加载资源对象
Declaration
public AssetHandle LoadAssetAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority加载的优先级
Type Parameters
NameDescriptionTObject资源类型
LoadAssetAsync(string, Type, uint)
异步加载资源对象
Declaration
public AssetHandle LoadAssetAsync(string location, Type type, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype资源类型System.UInt32priority加载的优先级
LoadAssetAsync(string, uint)
异步加载资源对象
Declaration
public AssetHandle LoadAssetAsync(string location, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority加载的优先级
LoadSubAssetsSync(AssetInfo)
同步加载子资源对象
Declaration
public SubAssetsHandle LoadSubAssetsSync(AssetInfo assetInfo)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息
LoadSubAssetsSync(string)
同步加载子资源对象
Declaration
public SubAssetsHandle LoadSubAssetsSync<TObject>(string location) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
Type Parameters
NameDescriptionTObject资源类型
LoadSubAssetsSync(string, Type)
同步加载子资源对象
Declaration
public SubAssetsHandle LoadSubAssetsSync(string location, Type type)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype子对象类型
LoadSubAssetsSync(string)
同步加载子资源对象
Declaration
public SubAssetsHandle LoadSubAssetsSync(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadSubAssetsAsync(AssetInfo, uint)
异步加载子资源对象
Declaration
public SubAssetsHandle LoadSubAssetsAsync(AssetInfo assetInfo, uint priority = 0)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.UInt32priority加载的优先级
LoadSubAssetsAsync(string, uint)
异步加载子资源对象
Declaration
public SubAssetsHandle LoadSubAssetsAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority加载的优先级
Type Parameters
NameDescriptionTObject资源类型
LoadSubAssetsAsync(string, Type, uint)
异步加载子资源对象
Declaration
public SubAssetsHandle LoadSubAssetsAsync(string location, Type type, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype子对象类型System.UInt32priority加载的优先级
LoadSubAssetsAsync(string, uint)
异步加载子资源对象
Declaration
public SubAssetsHandle LoadSubAssetsAsync(string location, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority加载的优先级
LoadAllAssetsSync(AssetInfo)
同步加载资源包内所有资源对象
Declaration
public AllAssetsHandle LoadAllAssetsSync(AssetInfo assetInfo)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息
LoadAllAssetsSync(string)
同步加载资源包内所有资源对象
Declaration
public AllAssetsHandle LoadAllAssetsSync<TObject>(string location) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
Type Parameters
NameDescriptionTObject资源类型
LoadAllAssetsSync(string, Type)
同步加载资源包内所有资源对象
Declaration
public AllAssetsHandle LoadAllAssetsSync(string location, Type type)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype子对象类型
LoadAllAssetsSync(string)
同步加载资源包内所有资源对象
Declaration
public AllAssetsHandle LoadAllAssetsSync(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadAllAssetsAsync(AssetInfo, uint)
异步加载资源包内所有资源对象
Declaration
public AllAssetsHandle LoadAllAssetsAsync(AssetInfo assetInfo, uint priority = 0)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.UInt32priority加载的优先级
LoadAllAssetsAsync(string, uint)
异步加载资源包内所有资源对象
Declaration
public AllAssetsHandle LoadAllAssetsAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority加载的优先级
Type Parameters
NameDescriptionTObject资源类型
LoadAllAssetsAsync(string, Type, uint)
异步加载资源包内所有资源对象
Declaration
public AllAssetsHandle LoadAllAssetsAsync(string location, Type type, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype子对象类型System.UInt32priority加载的优先级
LoadAllAssetsAsync(string, uint)
异步加载资源包内所有资源对象
Declaration
public AllAssetsHandle LoadAllAssetsAsync(string location, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority加载的优先级
CreateResourceDownloader(int, int)
创建资源下载器,用于下载当前资源版本所有的资源包文件
Declaration
public ResourceDownloaderOperation CreateResourceDownloader(int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateResourceDownloader(string, int, int)
创建资源下载器,用于下载指定的资源标签关联的资源包文件
Declaration
public ResourceDownloaderOperation CreateResourceDownloader(string tag, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.Stringtag资源标签System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateResourceDownloader(string[], int, int)
创建资源下载器,用于下载指定的资源标签列表关联的资源包文件
Declaration
public ResourceDownloaderOperation CreateResourceDownloader(string[] tags, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.String[]tags资源标签列表System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(string, bool, int, int)
创建资源下载器,用于下载指定的资源依赖的资源包文件
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(string location, bool recursiveDownload, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.BooleanrecursiveDownload下载资源对象所属资源包内所有资源对象依赖的资源包System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(string, int, int)
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(string location, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameSystem.StringlocationSystem.Int32downloadingMaxNumberSystem.Int32failedTryAgain
CreateBundleDownloader(string[], bool, int, int)
创建资源下载器,用于下载指定的资源列表依赖的资源包文件
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(string[] locations, bool recursiveDownload, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.String[]locations资源的定位地址列表System.BooleanrecursiveDownload下载资源对象所属资源包内所有资源对象依赖的资源包System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(string[], int, int)
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(string[] locations, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameSystem.String[]locationsSystem.Int32downloadingMaxNumberSystem.Int32failedTryAgain
CreateBundleDownloader(AssetInfo, bool, int, int)
创建资源下载器,用于下载指定的资源依赖的资源包文件
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(AssetInfo assetInfo, bool recursiveDownload, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.BooleanrecursiveDownload下载资源对象所属资源包内所有资源对象依赖的资源包System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(AssetInfo, int, int)
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(AssetInfo assetInfo, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameYooAsset.AssetInfoassetInfoSystem.Int32downloadingMaxNumberSystem.Int32failedTryAgain
CreateBundleDownloader(AssetInfo[], bool, int, int)
创建资源下载器,用于下载指定的资源列表依赖的资源包文件
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(AssetInfo[] assetInfos, bool recursiveDownload, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionYooAsset.AssetInfo[]assetInfos资源信息列表System.BooleanrecursiveDownload下载资源对象所属资源包内所有资源对象依赖的资源包System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(AssetInfo[], int, int)
Declaration
public ResourceDownloaderOperation CreateBundleDownloader(AssetInfo[] assetInfos, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameYooAsset.AssetInfo[]assetInfosSystem.Int32downloadingMaxNumberSystem.Int32failedTryAgain
CreateResourceUnpacker(int, int)
创建内置资源解压器,用于解压当前资源版本所有的资源包文件
Declaration
public ResourceUnpackerOperation CreateResourceUnpacker(int unpackingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceUnpackerOperation
Parameters
TypeNameDescriptionSystem.Int32unpackingMaxNumber同时解压的最大文件数System.Int32failedTryAgain解压失败的重试次数
CreateResourceUnpacker(string, int, int)
创建内置资源解压器,用于解压指定的资源标签关联的资源包文件
Declaration
public ResourceUnpackerOperation CreateResourceUnpacker(string tag, int unpackingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceUnpackerOperation
Parameters
TypeNameDescriptionSystem.Stringtag资源标签System.Int32unpackingMaxNumber同时解压的最大文件数System.Int32failedTryAgain解压失败的重试次数
CreateResourceUnpacker(string[], int, int)
创建内置资源解压器,用于解压指定的资源标签列表关联的资源包文件
Declaration
public ResourceUnpackerOperation CreateResourceUnpacker(string[] tags, int unpackingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceUnpackerOperation
Parameters
TypeNameDescriptionSystem.String[]tags资源标签列表System.Int32unpackingMaxNumber同时解压的最大文件数System.Int32failedTryAgain解压失败的重试次数
CreateResourceImporter(string[], int, int)
创建资源导入器 注意:资源文件名称必须和资源服务器部署的文件名称一致!
Declaration
public ResourceImporterOperation CreateResourceImporter(string[] filePaths, int importerMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceImporterOperation
Parameters
TypeNameDescriptionSystem.String[]filePaths资源路径列表System.Int32importerMaxNumber同时导入的最大文件数System.Int32failedTryAgain导入失败的重试次数
CreateResourceImporter(ImportFileInfo[], int, int)
创建资源导入器 注意:资源信息里需要指定BundleName或BundleGUID!
Declaration
public ResourceImporterOperation CreateResourceImporter(ImportFileInfo[] fileInfos, int importerMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceImporterOperation
Parameters
TypeNameDescriptionYooAsset.ImportFileInfo[]fileInfos资源信息列表System.Int32importerMaxNumber同时导入的最大文件数System.Int32failedTryAgain导入失败的重试次数
Class ResourceUnpackerOperation
Assembly: YooAsset.dll
Declaration
public sealed class ResourceUnpackerOperation : DownloaderOperation, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class SceneHandle
Assembly: YooAsset.dll
Declaration
public class SceneHandle : HandleBase, IEnumerator, IDisposable
Properties
SceneName
场景名称
Declaration
public string SceneName { get; }
SceneObject
场景对象
Declaration
public Scene SceneObject { get; }
Methods
ActivateScene()
激活场景(当同时存在多个场景时用于切换激活场景)
Declaration
public bool ActivateScene()
Returns
System.Boolean
UnSuspend()
解除场景加载挂起操作
Declaration
public bool UnSuspend()
Returns
System.Boolean
UnloadAsync()
异步卸载场景对象 注意:场景卸载成功后,会自动释放该handle的引用计数!
Declaration
public UnloadSceneOperation UnloadAsync()
Returns
Events
Completed
完成委托
Declaration
public event Action<SceneHandle> Completed
Event Type
System.Action<YooAsset.SceneHandle>
Implements
-
System.Collections.IEnumerator -
System.IDisposable
Class SubAssetsHandle
Assembly: YooAsset.dll
Declaration
public sealed class SubAssetsHandle : HandleBase, IEnumerator, IDisposable
Properties
SubAssetObjects
子资源对象集合
Declaration
public IReadOnlyList<Object> SubAssetObjects { get; }
Methods
WaitForAsyncComplete()
等待异步执行完毕
Declaration
public void WaitForAsyncComplete()
GetSubAssetObject(string)
获取子资源对象
Declaration
public TObject GetSubAssetObject<TObject>(string assetName) where TObject : Object
Returns
<TObject>
Parameters
TypeNameDescriptionSystem.StringassetName子资源对象名称
Type Parameters
NameDescriptionTObject子资源对象类型
GetSubAssetObjects()
获取所有的子资源对象集合
Declaration
public TObject[] GetSubAssetObjects<TObject>() where TObject : Object
Returns
<TObject>[]
Type Parameters
NameDescriptionTObject子资源对象类型
Events
Completed
完成委托
Declaration
public event Action<SubAssetsHandle> Completed
Event Type
System.Action<YooAsset.SubAssetsHandle>
Implements
-
System.Collections.IEnumerator -
System.IDisposable
Delegate UnityWebRequestDelegate
自定义下载器的请求委托
Assembly: YooAsset.dll
Declaration
public delegate UnityWebRequest UnityWebRequestDelegate(string url)
Class UnloadAllAssetsOperation
Assembly: YooAsset.dll
Declaration
public sealed class UnloadAllAssetsOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class UnloadAllAssetsOptions
Assembly: YooAsset.dll
Declaration
public sealed class UnloadAllAssetsOptions
Fields
ReleaseAllHandles
释放所有资源句柄,防止卸载过程中触发完成回调!
Declaration
public bool ReleaseAllHandles
LockLoadOperation
卸载过程中锁定加载操作,防止新的任务请求!
Declaration
public bool LockLoadOperation
Class UnloadSceneOperation
场景卸载异步操作类
Assembly: YooAsset.dll
Declaration
public sealed class UnloadSceneOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class UnloadUnusedAssetsOperation
Assembly: YooAsset.dll
Declaration
public sealed class UnloadUnusedAssetsOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Class UpdatePackageManifestOperation
Assembly: YooAsset.dll
Declaration
public sealed class UpdatePackageManifestOperation : AsyncOperationBase, IEnumerator, IComparable<AsyncOperationBase>
Implements
-
System.Collections.IEnumerator -
System.IComparable<YooAsset.AsyncOperationBase>
Struct WebDecryptFileInfo
Assembly: YooAsset.dll
Declaration
public struct WebDecryptFileInfo
Fields
BundleName
资源包名称
Declaration
public string BundleName
FileLoadCRC
Unity引擎用于内容校验的CRC
Declaration
public uint FileLoadCRC
FileData
文件字节数据
Declaration
public byte[] FileData
Struct WebDecryptResult
Assembly: YooAsset.dll
Declaration
public struct WebDecryptResult
Fields
Result
资源包对象
Declaration
public AssetBundle Result
Class WebPlayModeParameters
WebGL运行模式的初始化参数
Assembly: YooAsset.dll
Declaration
public class WebPlayModeParameters : InitializeParameters
Fields
WebServerFileSystemParameters
Declaration
public FileSystemParameters WebServerFileSystemParameters
WebRemoteFileSystemParameters
Declaration
public FileSystemParameters WebRemoteFileSystemParameters
Class YooAssets
Assembly: YooAsset.dll
Declaration
public static class YooAssets
Properties
Initialized
是否已经初始化
Declaration
public static bool Initialized { get; }
Methods
Initialize(ILogger)
初始化资源系统
Declaration
public static void Initialize(ILogger logger = null)
Parameters
TypeNameDescriptionYooAsset.ILoggerlogger自定义日志处理
Destroy()
销毁资源系统
Declaration
public static void Destroy()
CreatePackage(string)
创建资源包裹
Declaration
public static ResourcePackage CreatePackage(string packageName)
Returns
Parameters
TypeNameDescriptionSystem.StringpackageName包裹名称
GetPackage(string)
获取资源包裹
Declaration
public static ResourcePackage GetPackage(string packageName)
Returns
Parameters
TypeNameDescriptionSystem.StringpackageName包裹名称
TryGetPackage(string)
尝试获取资源包裹
Declaration
public static ResourcePackage TryGetPackage(string packageName)
Returns
Parameters
TypeNameDescriptionSystem.StringpackageName包裹名称
GetAllPackages()
获取所有资源包裹
Declaration
public static List<ResourcePackage> GetAllPackages()
Returns
System.Collections.Generic.List<YooAsset.ResourcePackage>
RemovePackage(string)
移除资源包裹
Declaration
public static bool RemovePackage(string packageName)
Returns
System.Boolean
Parameters
TypeNameDescriptionSystem.StringpackageName包裹名称
RemovePackage(ResourcePackage)
移除资源包裹
Declaration
public static bool RemovePackage(ResourcePackage package)
Returns
System.Boolean
Parameters
TypeNameDescriptionYooAsset.ResourcePackagepackage包裹实例对象
ContainsPackage(string)
检测资源包裹是否存在
Declaration
public static bool ContainsPackage(string packageName)
Returns
System.Boolean
Parameters
TypeNameDescriptionSystem.StringpackageName包裹名称
StartOperation(GameAsyncOperation)
开启一个异步操作
Declaration
public static void StartOperation(GameAsyncOperation operation)
Parameters
TypeNameDescriptionYooAsset.GameAsyncOperationoperation异步操作对象
SetDownloadSystemUnityWebRequest(UnityWebRequestDelegate)
设置下载系统参数,自定义下载请求
Declaration
public static void SetDownloadSystemUnityWebRequest(UnityWebRequestDelegate createDelegate)
Parameters
TypeNameYooAsset.UnityWebRequestDelegatecreateDelegate
SetOperationSystemMaxTimeSlice(long)
设置异步系统参数,每帧执行消耗的最大时间切片(单位:毫秒)
Declaration
public static void SetOperationSystemMaxTimeSlice(long milliseconds)
Parameters
TypeNameSystem.Int64milliseconds
SetDefaultPackage(ResourcePackage)
设置默认的资源包
Declaration
public static void SetDefaultPackage(ResourcePackage package)
Parameters
TypeNameYooAsset.ResourcePackagepackage
IsNeedDownloadFromRemote(string)
是否需要从远端更新下载
Declaration
public static bool IsNeedDownloadFromRemote(string location)
Returns
System.Boolean
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
IsNeedDownloadFromRemote(AssetInfo)
是否需要从远端更新下载
Declaration
public static bool IsNeedDownloadFromRemote(AssetInfo assetInfo)
Returns
System.Boolean
Parameters
TypeNameYooAsset.AssetInfoassetInfo
GetAssetInfos(string)
获取资源信息列表
Declaration
public static AssetInfo[] GetAssetInfos(string tag)
Returns
YooAsset.AssetInfo[]
Parameters
TypeNameDescriptionSystem.Stringtag资源标签
GetAssetInfos(string[])
获取资源信息列表
Declaration
public static AssetInfo[] GetAssetInfos(string[] tags)
Returns
YooAsset.AssetInfo[]
Parameters
TypeNameDescriptionSystem.String[]tags资源标签列表
GetAssetInfo(string)
获取资源信息
Declaration
public static AssetInfo GetAssetInfo(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
GetAssetInfo(string, Type)
获取资源信息
Declaration
public static AssetInfo GetAssetInfo(string location, Type type)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype资源类型
GetAssetInfoByGUID(string)
获取资源信息
Declaration
public static AssetInfo GetAssetInfoByGUID(string assetGUID)
Returns
Parameters
TypeNameDescriptionSystem.StringassetGUID资源GUID
GetAssetInfoByGUID(string, Type)
获取资源信息
Declaration
public static AssetInfo GetAssetInfoByGUID(string assetGUID, Type type)
Returns
Parameters
TypeNameDescriptionSystem.StringassetGUID资源GUIDSystem.Typetype资源类型
CheckLocationValid(string)
检查资源定位地址是否有效
Declaration
public static bool CheckLocationValid(string location)
Returns
System.Boolean
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadRawFileSync(AssetInfo)
同步加载原生文件
Declaration
public static RawFileHandle LoadRawFileSync(AssetInfo assetInfo)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息
LoadRawFileSync(string)
同步加载原生文件
Declaration
public static RawFileHandle LoadRawFileSync(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadRawFileAsync(AssetInfo, uint)
异步加载原生文件
Declaration
public static RawFileHandle LoadRawFileAsync(AssetInfo assetInfo, uint priority = 0)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.UInt32priority
LoadRawFileAsync(string, uint)
异步加载原生文件
Declaration
public static RawFileHandle LoadRawFileAsync(string location, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority
LoadSceneSync(string, LoadSceneMode, LocalPhysicsMode)
同步加载场景
Declaration
public static SceneHandle LoadSceneSync(string location, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation场景的定位地址UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式
LoadSceneSync(AssetInfo, LoadSceneMode, LocalPhysicsMode)
同步加载场景
Declaration
public static SceneHandle LoadSceneSync(AssetInfo assetInfo, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo场景的资源信息UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式
LoadSceneAsync(string, LoadSceneMode, LocalPhysicsMode, bool, uint)
异步加载场景
Declaration
public static SceneHandle LoadSceneAsync(string location, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None, bool suspendLoad = false, uint priority = 100)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation场景的定位地址UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式System.BooleansuspendLoad场景加载到90%自动挂起System.UInt32priority优先级
LoadSceneAsync(AssetInfo, LoadSceneMode, LocalPhysicsMode, bool, uint)
异步加载场景
Declaration
public static SceneHandle LoadSceneAsync(AssetInfo assetInfo, LoadSceneMode sceneMode = LoadSceneMode.Single, LocalPhysicsMode physicsMode = LocalPhysicsMode.None, bool suspendLoad = false, uint priority = 100)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo场景的资源信息UnityEngine.SceneManagement.LoadSceneModesceneMode场景加载模式UnityEngine.SceneManagement.LocalPhysicsModephysicsMode场景物理模式System.BooleansuspendLoad场景加载到90%自动挂起System.UInt32priority优先级
LoadAssetSync(AssetInfo)
同步加载资源对象
Declaration
public static AssetHandle LoadAssetSync(AssetInfo assetInfo)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息
LoadAssetSync(string)
同步加载资源对象
Declaration
public static AssetHandle LoadAssetSync<TObject>(string location) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
Type Parameters
NameDescriptionTObject资源类型
LoadAssetSync(string, Type)
同步加载资源对象
Declaration
public static AssetHandle LoadAssetSync(string location, Type type)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype资源类型
LoadAssetSync(string)
同步加载资源对象
Declaration
public static AssetHandle LoadAssetSync(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadAssetAsync(AssetInfo, uint)
异步加载资源对象
Declaration
public static AssetHandle LoadAssetAsync(AssetInfo assetInfo, uint priority = 0)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.UInt32priority
LoadAssetAsync(string, uint)
异步加载资源对象
Declaration
public static AssetHandle LoadAssetAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority
Type Parameters
NameDescriptionTObject资源类型
LoadAssetAsync(string, Type, uint)
异步加载资源对象
Declaration
public static AssetHandle LoadAssetAsync(string location, Type type, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype资源类型System.UInt32priority
LoadAssetAsync(string, uint)
异步加载资源对象
Declaration
public static AssetHandle LoadAssetAsync(string location, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority
LoadSubAssetsSync(AssetInfo)
同步加载子资源对象
Declaration
public static SubAssetsHandle LoadSubAssetsSync(AssetInfo assetInfo)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息
LoadSubAssetsSync(string)
同步加载子资源对象
Declaration
public static SubAssetsHandle LoadSubAssetsSync<TObject>(string location) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
Type Parameters
NameDescriptionTObject资源类型
LoadSubAssetsSync(string, Type)
同步加载子资源对象
Declaration
public static SubAssetsHandle LoadSubAssetsSync(string location, Type type)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype子对象类型
LoadSubAssetsSync(string)
同步加载子资源对象
Declaration
public static SubAssetsHandle LoadSubAssetsSync(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadSubAssetsAsync(AssetInfo, uint)
异步加载子资源对象
Declaration
public static SubAssetsHandle LoadSubAssetsAsync(AssetInfo assetInfo, uint priority = 0)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.UInt32priority
LoadSubAssetsAsync(string, uint)
异步加载子资源对象
Declaration
public static SubAssetsHandle LoadSubAssetsAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority
Type Parameters
NameDescriptionTObject资源类型
LoadSubAssetsAsync(string, Type, uint)
异步加载子资源对象
Declaration
public static SubAssetsHandle LoadSubAssetsAsync(string location, Type type, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype子对象类型System.UInt32priority
LoadSubAssetsAsync(string, uint)
异步加载子资源对象
Declaration
public static SubAssetsHandle LoadSubAssetsAsync(string location, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority
LoadAllAssetsSync(AssetInfo)
同步加载资源包内所有资源对象
Declaration
public static AllAssetsHandle LoadAllAssetsSync(AssetInfo assetInfo)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息
LoadAllAssetsSync(string)
同步加载资源包内所有资源对象
Declaration
public static AllAssetsHandle LoadAllAssetsSync<TObject>(string location) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
Type Parameters
NameDescriptionTObject资源类型
LoadAllAssetsSync(string, Type)
同步加载资源包内所有资源对象
Declaration
public static AllAssetsHandle LoadAllAssetsSync(string location, Type type)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype子对象类型
LoadAllAssetsSync(string)
同步加载资源包内所有资源对象
Declaration
public static AllAssetsHandle LoadAllAssetsSync(string location)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址
LoadAllAssetsAsync(AssetInfo, uint)
异步加载资源包内所有资源对象
Declaration
public static AllAssetsHandle LoadAllAssetsAsync(AssetInfo assetInfo, uint priority = 0)
Returns
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.UInt32priority
LoadAllAssetsAsync(string, uint)
异步加载资源包内所有资源对象
Declaration
public static AllAssetsHandle LoadAllAssetsAsync<TObject>(string location, uint priority = 0) where TObject : Object
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority
Type Parameters
NameDescriptionTObject资源类型
LoadAllAssetsAsync(string, Type, uint)
异步加载资源包内所有资源对象
Declaration
public static AllAssetsHandle LoadAllAssetsAsync(string location, Type type, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.Typetype子对象类型System.UInt32priority
LoadAllAssetsAsync(string, uint)
异步加载资源包内所有资源对象
Declaration
public static AllAssetsHandle LoadAllAssetsAsync(string location, uint priority = 0)
Returns
Parameters
TypeNameDescriptionSystem.Stringlocation资源的定位地址System.UInt32priority
CreateResourceDownloader(int, int)
创建资源下载器,用于下载当前资源版本所有的资源包文件
Declaration
public static ResourceDownloaderOperation CreateResourceDownloader(int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateResourceDownloader(string, int, int)
创建资源下载器,用于下载指定的资源标签关联的资源包文件
Declaration
public static ResourceDownloaderOperation CreateResourceDownloader(string tag, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.Stringtag资源标签System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateResourceDownloader(string[], int, int)
创建资源下载器,用于下载指定的资源标签列表关联的资源包文件
Declaration
public static ResourceDownloaderOperation CreateResourceDownloader(string[] tags, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.String[]tags资源标签列表System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(string, int, int)
创建资源下载器,用于下载指定的资源依赖的资源包文件
Declaration
public static ResourceDownloaderOperation CreateBundleDownloader(string location, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.Stringlocation资源定位地址System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(string[], int, int)
创建资源下载器,用于下载指定的资源列表依赖的资源包文件
Declaration
public static ResourceDownloaderOperation CreateBundleDownloader(string[] locations, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionSystem.String[]locations资源定位地址列表System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(AssetInfo, int, int)
创建资源下载器,用于下载指定的资源依赖的资源包文件
Declaration
public static ResourceDownloaderOperation CreateBundleDownloader(AssetInfo assetInfo, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionYooAsset.AssetInfoassetInfo资源信息System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateBundleDownloader(AssetInfo[], int, int)
创建资源下载器,用于下载指定的资源列表依赖的资源包文件
Declaration
public static ResourceDownloaderOperation CreateBundleDownloader(AssetInfo[] assetInfos, int downloadingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceDownloaderOperation
Parameters
TypeNameDescriptionYooAsset.AssetInfo[]assetInfos资源信息列表System.Int32downloadingMaxNumber同时下载的最大文件数System.Int32failedTryAgain下载失败的重试次数
CreateResourceUnpacker(int, int)
创建内置资源解压器,用于解压当前资源版本所有的资源包文件
Declaration
public static ResourceUnpackerOperation CreateResourceUnpacker(int unpackingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceUnpackerOperation
Parameters
TypeNameDescriptionSystem.Int32unpackingMaxNumber同时解压的最大文件数System.Int32failedTryAgain解压失败的重试次数
CreateResourceUnpacker(string, int, int)
创建内置资源解压器,用于解压指定的资源标签关联的资源包文件
Declaration
public static ResourceUnpackerOperation CreateResourceUnpacker(string tag, int unpackingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceUnpackerOperation
Parameters
TypeNameDescriptionSystem.Stringtag资源标签System.Int32unpackingMaxNumber同时解压的最大文件数System.Int32failedTryAgain解压失败的重试次数
CreateResourceUnpacker(string[], int, int)
创建内置资源解压器,用于解压指定的资源标签列表关联的资源包文件
Declaration
public static ResourceUnpackerOperation CreateResourceUnpacker(string[] tags, int unpackingMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceUnpackerOperation
Parameters
TypeNameDescriptionSystem.String[]tags资源标签列表System.Int32unpackingMaxNumber同时解压的最大文件数System.Int32failedTryAgain解压失败的重试次数
CreateResourceImporter(string[], int, int)
创建资源导入器 注意:资源文件名称必须和资源服务器部署的文件名称一致!
Declaration
public static ResourceImporterOperation CreateResourceImporter(string[] filePaths, int importerMaxNumber, int failedTryAgain)
Returns
YooAsset.ResourceImporterOperation
Parameters
TypeNameDescriptionSystem.String[]filePaths资源路径列表System.Int32importerMaxNumber同时导入的最大文件数System.Int32failedTryAgain导入失败的重试次数
Class YooAssetSettingsData
Assembly: YooAsset.dll
Declaration
public static class YooAssetSettingsData
Methods
GetDefaultYooFolderName()
获取YooAsset文件夹名称
Declaration
public static string GetDefaultYooFolderName()
Returns
System.String
GetBuildReportFileName(string, string)
获取构建报告文件名
Declaration
public static string GetBuildReportFileName(string packageName, string packageVersion)
Returns
System.String
Parameters
TypeNameSystem.StringpackageNameSystem.StringpackageVersion
GetManifestBinaryFileName(string, string)
获取清单文件完整名称
Declaration
public static string GetManifestBinaryFileName(string packageName, string packageVersion)
Returns
System.String
Parameters
TypeNameSystem.StringpackageNameSystem.StringpackageVersion
GetManifestJsonFileName(string, string)
获取清单文件完整名称
Declaration
public static string GetManifestJsonFileName(string packageName, string packageVersion)
Returns
System.String
Parameters
TypeNameSystem.StringpackageNameSystem.StringpackageVersion
GetPackageHashFileName(string, string)
获取包裹的哈希文件完整名称
Declaration
public static string GetPackageHashFileName(string packageName, string packageVersion)
Returns
System.String
Parameters
TypeNameSystem.StringpackageNameSystem.StringpackageVersion
GetPackageVersionFileName(string)
获取包裹的版本文件完整名称
Declaration
public static string GetPackageVersionFileName(string packageName)
Returns
System.String
Parameters
TypeNameSystem.StringpackageName