Game Framework  2021.05.31
GameFramework.Resource 命名空间参考

interface  ILoadResourceAgentHelper
 加载资源代理辅助器接口。 更多...
 
interface  IResourceGroup
 资源组接口。 更多...
 
interface  IResourceGroupCollection
 资源组集合接口。 更多...
 
interface  IResourceHelper
 资源辅助器接口。 更多...
 
interface  IResourceManager
 资源管理器接口。 更多...
 
class  LoadAssetCallbacks
 加载资源回调函数集。 更多...
 
class  LoadBinaryCallbacks
 加载二进制资源回调函数集。 更多...
 
class  LoadBytesCallbacks
 加载数据流回调函数集。 更多...
 
class  LoadResourceAgentHelperErrorEventArgs
 加载资源代理辅助器错误事件。 更多...
 
class  LoadResourceAgentHelperLoadCompleteEventArgs
 加载资源代理辅助器异步加载资源完成事件。 更多...
 
class  LoadResourceAgentHelperParseBytesCompleteEventArgs
 加载资源代理辅助器异步将资源二进制流转换为加载对象完成事件。 更多...
 
class  LoadResourceAgentHelperReadBytesCompleteEventArgs
 加载资源代理辅助器异步读取资源二进制流完成事件。 更多...
 
class  LoadResourceAgentHelperReadFileCompleteEventArgs
 加载资源代理辅助器异步将资源文件转换为加载对象完成事件。 更多...
 
class  LoadResourceAgentHelperUpdateEventArgs
 加载资源代理辅助器更新事件。 更多...
 
class  LoadSceneCallbacks
 加载场景回调函数集。 更多...
 
struct  LocalVersionList
 本地版本资源列表。 更多...
 
struct  PackageVersionList
 单机模式版本资源列表。 更多...
 
class  PackageVersionListSerializer
 单机模式版本资源列表序列化器。 更多...
 
class  ReadOnlyVersionListSerializer
 本地只读区版本资源列表序列化器。 更多...
 
class  ReadWriteVersionListSerializer
 本地读写区版本资源列表序列化器。 更多...
 
class  ResourceApplyFailureEventArgs
 资源应用失败事件。 更多...
 
class  ResourceApplySuccessEventArgs
 资源应用成功事件。 更多...
 
struct  ResourcePackVersionList
 资源包版本资源列表。 更多...
 
class  ResourcePackVersionListSerializer
 资源包版本资源列表序列化器。 更多...
 
class  ResourceUpdateAllCompleteEventArgs
 资源更新全部完成事件。 更多...
 
class  ResourceUpdateChangedEventArgs
 资源更新改变事件。 更多...
 
class  ResourceUpdateFailureEventArgs
 资源更新失败事件。 更多...
 
class  ResourceUpdateStartEventArgs
 资源更新开始事件。 更多...
 
class  ResourceUpdateSuccessEventArgs
 资源更新成功事件。 更多...
 
class  UnloadSceneCallbacks
 卸载场景回调函数集。 更多...
 
struct  UpdatableVersionList
 可更新模式版本资源列表。 更多...
 
class  UpdatableVersionListSerializer
 可更新模式版本资源列表序列化器。 更多...
 
class  UpdateVersionListCallbacks
 版本资源列表更新回调函数集。 更多...
 

枚举

enum class  CheckVersionListResult : byte { Updated = 0 , NeedUpdate }
 检查版本资源列表结果。 更多...
 
enum class  HasAssetResult : byte {
  NotExist = 0 , NotReady , AssetOnDisk , AssetOnFileSystem ,
  BinaryOnDisk , BinaryOnFileSystem
}
 检查资源是否存在的结果。 更多...
 
enum class  LoadResourceProgress : byte {
  Unknown = 0 , ReadResource , LoadResource , LoadAsset ,
  LoadScene
}
 加载资源进度类型。 更多...
 
enum class  LoadResourceStatus : byte {
  Success = 0 , NotExist , NotReady , DependencyError ,
  TypeError , AssetError
}
 加载资源状态。 更多...
 
enum class  ResourceMode : byte { Unspecified = 0 , Package , Updatable , UpdatableWhilePlaying }
 资源模式。 更多...
 

函数

delegate void ApplyResourcesCompleteCallback (string resourcePackPath, bool result)
 使用可更新模式并应用资源包资源完成时的回调函数。 更多...
 
delegate void CheckResourcesCompleteCallback (int movedCount, int removedCount, int updateCount, long updateTotalLength, long updateTotalCompressedLength)
 使用可更新模式并检查资源完成时的回调函数。 更多...
 
delegate void DecryptResourceCallback (byte[] bytes, int startIndex, int count, string name, string variant, string extension, bool storageInReadOnly, string fileSystem, byte loadType, int length, int hashCode)
 解密资源回调函数。 更多...
 
delegate void InitResourcesCompleteCallback ()
 使用单机模式并初始化资源完成时的回调函数。 更多...
 
delegate void LoadAssetDependencyAssetCallback (string assetName, string dependencyAssetName, int loadedCount, int totalCount, object userData)
 加载资源时加载依赖资源回调函数。 更多...
 
delegate void LoadAssetFailureCallback (string assetName, LoadResourceStatus status, string errorMessage, object userData)
 加载资源失败回调函数。 更多...
 
delegate void LoadAssetSuccessCallback (string assetName, object asset, float duration, object userData)
 加载资源成功回调函数。 更多...
 
delegate void LoadAssetUpdateCallback (string assetName, float progress, object userData)
 加载资源更新回调函数。 更多...
 
delegate void LoadBinaryFailureCallback (string binaryAssetName, LoadResourceStatus status, string errorMessage, object userData)
 加载二进制资源失败回调函数。 更多...
 
delegate void LoadBinarySuccessCallback (string binaryAssetName, byte[] binaryBytes, float duration, object userData)
 加载二进制资源成功回调函数。 更多...
 
delegate void LoadBytesFailureCallback (string fileUri, string errorMessage, object userData)
 加载数据流失败回调函数。 更多...
 
delegate void LoadBytesSuccessCallback (string fileUri, byte[] bytes, float duration, object userData)
 加载数据流成功回调函数。 更多...
 
delegate void LoadSceneDependencyAssetCallback (string sceneAssetName, string dependencyAssetName, int loadedCount, int totalCount, object userData)
 加载场景时加载依赖资源回调函数。 更多...
 
delegate void LoadSceneFailureCallback (string sceneAssetName, LoadResourceStatus status, string errorMessage, object userData)
 加载场景失败回调函数。 更多...
 
delegate void LoadSceneSuccessCallback (string sceneAssetName, float duration, object userData)
 加载场景成功回调函数。 更多...
 
delegate void LoadSceneUpdateCallback (string sceneAssetName, float progress, object userData)
 加载场景更新回调函数。 更多...
 
delegate void UnloadSceneFailureCallback (string sceneAssetName, object userData)
 卸载场景失败回调函数。 更多...
 
delegate void UnloadSceneSuccessCallback (string sceneAssetName, object userData)
 卸载场景成功回调函数。 更多...
 
delegate void UpdateResourcesCompleteCallback (IResourceGroup resourceGroup, bool result)
 使用可更新模式并更新指定资源组完成时的回调函数。 更多...
 
delegate void UpdateVersionListFailureCallback (string downloadUri, string errorMessage)
 版本资源列表更新失败回调函数。 更多...
 
delegate void UpdateVersionListSuccessCallback (string downloadPath, string downloadUri)
 版本资源列表更新成功回调函数。 更多...
 

枚举类型说明

◆ CheckVersionListResult

enum CheckVersionListResult : byte
strong

检查版本资源列表结果。

枚举值
Updated 

已经是最新的。

NeedUpdate 

需要更新。

◆ HasAssetResult

enum HasAssetResult : byte
strong

检查资源是否存在的结果。

枚举值
NotExist 

资源不存在。

NotReady 

资源尚未准备完毕。

AssetOnDisk 

存在资源且存储在磁盘上。

AssetOnFileSystem 

存在资源且存储在文件系统里。

BinaryOnDisk 

存在二进制资源且存储在磁盘上。

BinaryOnFileSystem 

存在二进制资源且存储在文件系统里。

◆ LoadResourceProgress

enum LoadResourceProgress : byte
strong

加载资源进度类型。

枚举值
Unknown 

未知类型。

ReadResource 

读取资源包。

LoadResource 

加载资源包。

LoadAsset 

加载资源。

LoadScene 

加载场景。

◆ LoadResourceStatus

enum LoadResourceStatus : byte
strong

加载资源状态。

枚举值
Success 

加载资源完成。

NotExist 

资源不存在。

NotReady 

资源尚未准备完毕。

DependencyError 

依赖资源错误。

TypeError 

资源类型错误。

AssetError 

加载资源错误。

◆ ResourceMode

enum ResourceMode : byte
strong

资源模式。

枚举值
Unspecified 

未指定。

Package 

单机模式。

Updatable 

预下载的可更新模式。

UpdatableWhilePlaying 

使用时下载的可更新模式。

函数说明

◆ ApplyResourcesCompleteCallback()

delegate void GameFramework.Resource.ApplyResourcesCompleteCallback ( string  resourcePackPath,
bool  result 
)

使用可更新模式并应用资源包资源完成时的回调函数。

参数
resourcePackPath应用的资源包路径。
result应用资源包资源结果,全部成功为 true,否则为 false。

◆ CheckResourcesCompleteCallback()

delegate void GameFramework.Resource.CheckResourcesCompleteCallback ( int  movedCount,
int  removedCount,
int  updateCount,
long  updateTotalLength,
long  updateTotalCompressedLength 
)

使用可更新模式并检查资源完成时的回调函数。

参数
movedCount已移动的资源数量。
removedCount已移除的资源数量。
updateCount可更新的资源数量。
updateTotalLength可更新的资源总大小。
updateTotalCompressedLength可更新的压缩后总大小。

◆ DecryptResourceCallback()

delegate void GameFramework.Resource.DecryptResourceCallback ( byte[]  bytes,
int  startIndex,
int  count,
string  name,
string  variant,
string  extension,
bool  storageInReadOnly,
string  fileSystem,
byte  loadType,
int  length,
int  hashCode 
)

解密资源回调函数。

参数
bytes要解密的资源二进制流。
startIndex解密二进制流的起始位置。
count解密二进制流的长度。
name资源名称。
variant变体名称。
extension扩展名称。
storageInReadOnly资源是否在只读区。
fileSystem文件系统名称。
loadType资源加载方式。
length资源大小。
hashCode资源哈希值。

◆ InitResourcesCompleteCallback()

delegate void GameFramework.Resource.InitResourcesCompleteCallback ( )

使用单机模式并初始化资源完成时的回调函数。

◆ LoadAssetDependencyAssetCallback()

delegate void GameFramework.Resource.LoadAssetDependencyAssetCallback ( string  assetName,
string  dependencyAssetName,
int  loadedCount,
int  totalCount,
object  userData 
)

加载资源时加载依赖资源回调函数。

参数
assetName要加载的资源名称。
dependencyAssetName被加载的依赖资源名称。
loadedCount当前已加载依赖资源数量。
totalCount总共加载依赖资源数量。
userData用户自定义数据。

◆ LoadAssetFailureCallback()

delegate void GameFramework.Resource.LoadAssetFailureCallback ( string  assetName,
LoadResourceStatus  status,
string  errorMessage,
object  userData 
)

加载资源失败回调函数。

参数
assetName要加载的资源名称。
status加载资源状态。
errorMessage错误信息。
userData用户自定义数据。

◆ LoadAssetSuccessCallback()

delegate void GameFramework.Resource.LoadAssetSuccessCallback ( string  assetName,
object  asset,
float  duration,
object  userData 
)

加载资源成功回调函数。

参数
assetName要加载的资源名称。
asset已加载的资源。
duration加载持续时间。
userData用户自定义数据。

◆ LoadAssetUpdateCallback()

delegate void GameFramework.Resource.LoadAssetUpdateCallback ( string  assetName,
float  progress,
object  userData 
)

加载资源更新回调函数。

参数
assetName要加载的资源名称。
progress加载资源进度。
userData用户自定义数据。

◆ LoadBinaryFailureCallback()

delegate void GameFramework.Resource.LoadBinaryFailureCallback ( string  binaryAssetName,
LoadResourceStatus  status,
string  errorMessage,
object  userData 
)

加载二进制资源失败回调函数。

参数
binaryAssetName要加载的二进制资源名称。
status加载二进制资源状态。
errorMessage错误信息。
userData用户自定义数据。

◆ LoadBinarySuccessCallback()

delegate void GameFramework.Resource.LoadBinarySuccessCallback ( string  binaryAssetName,
byte[]  binaryBytes,
float  duration,
object  userData 
)

加载二进制资源成功回调函数。

参数
binaryAssetName要加载的二进制资源名称。
binaryBytes已加载的二进制资源。
duration加载持续时间。
userData用户自定义数据。

◆ LoadBytesFailureCallback()

delegate void GameFramework.Resource.LoadBytesFailureCallback ( string  fileUri,
string  errorMessage,
object  userData 
)

加载数据流失败回调函数。

参数
fileUri文件路径。
errorMessage错误信息。
userData用户自定义数据。

◆ LoadBytesSuccessCallback()

delegate void GameFramework.Resource.LoadBytesSuccessCallback ( string  fileUri,
byte[]  bytes,
float  duration,
object  userData 
)

加载数据流成功回调函数。

参数
fileUri文件路径。
bytes数据流。
duration加载持续时间。
userData用户自定义数据。

◆ LoadSceneDependencyAssetCallback()

delegate void GameFramework.Resource.LoadSceneDependencyAssetCallback ( string  sceneAssetName,
string  dependencyAssetName,
int  loadedCount,
int  totalCount,
object  userData 
)

加载场景时加载依赖资源回调函数。

参数
sceneAssetName要加载的场景资源名称。
dependencyAssetName被加载的依赖资源名称。
loadedCount当前已加载依赖资源数量。
totalCount总共加载依赖资源数量。
userData用户自定义数据。

◆ LoadSceneFailureCallback()

delegate void GameFramework.Resource.LoadSceneFailureCallback ( string  sceneAssetName,
LoadResourceStatus  status,
string  errorMessage,
object  userData 
)

加载场景失败回调函数。

参数
sceneAssetName要加载的场景资源名称。
status加载场景状态。
errorMessage错误信息。
userData用户自定义数据。

◆ LoadSceneSuccessCallback()

delegate void GameFramework.Resource.LoadSceneSuccessCallback ( string  sceneAssetName,
float  duration,
object  userData 
)

加载场景成功回调函数。

参数
sceneAssetName要加载的场景资源名称。
duration加载持续时间。
userData用户自定义数据。

◆ LoadSceneUpdateCallback()

delegate void GameFramework.Resource.LoadSceneUpdateCallback ( string  sceneAssetName,
float  progress,
object  userData 
)

加载场景更新回调函数。

参数
sceneAssetName要加载的场景资源名称。
progress加载场景进度。
userData用户自定义数据。

◆ UnloadSceneFailureCallback()

delegate void GameFramework.Resource.UnloadSceneFailureCallback ( string  sceneAssetName,
object  userData 
)

卸载场景失败回调函数。

参数
sceneAssetName要卸载的场景资源名称。
userData用户自定义数据。

◆ UnloadSceneSuccessCallback()

delegate void GameFramework.Resource.UnloadSceneSuccessCallback ( string  sceneAssetName,
object  userData 
)

卸载场景成功回调函数。

参数
sceneAssetName要卸载的场景资源名称。
userData用户自定义数据。

◆ UpdateResourcesCompleteCallback()

delegate void GameFramework.Resource.UpdateResourcesCompleteCallback ( IResourceGroup  resourceGroup,
bool  result 
)

使用可更新模式并更新指定资源组完成时的回调函数。

参数
resourceGroup更新的资源组。
result更新资源结果,全部成功为 true,否则为 false。

◆ UpdateVersionListFailureCallback()

delegate void GameFramework.Resource.UpdateVersionListFailureCallback ( string  downloadUri,
string  errorMessage 
)

版本资源列表更新失败回调函数。

参数
downloadUri版本资源列表更新地址。
errorMessage错误信息。

◆ UpdateVersionListSuccessCallback()

delegate void GameFramework.Resource.UpdateVersionListSuccessCallback ( string  downloadPath,
string  downloadUri 
)

版本资源列表更新成功回调函数。

参数
downloadPath版本资源列表更新后存放路径。
downloadUri版本资源列表更新地址。