Game Framework  2019.11.26
ResourceComponent类 参考

资源组件。 更多...

类 ResourceComponent 继承关系图:
GameFrameworkComponent

Public 成员函数

void SetResourceMode (ResourceMode resourceMode)
 设置资源模式。 更多...
 
void SetCurrentVariant (string currentVariant)
 设置当前变体。 更多...
 
void SetDecryptResourceCallback (DecryptResourceCallback decryptResourceCallback)
 设置解密资源回调函数。 更多...
 
void UnloadUnusedAssets (bool performGCCollect)
 预订执行释放未被使用的资源。 更多...
 
void ForceUnloadUnusedAssets (bool performGCCollect)
 强制执行释放未被使用的资源。 更多...
 
void InitResources (InitResourcesCompleteCallback initResourcesCompleteCallback)
 使用单机模式并初始化资源。 更多...
 
CheckVersionListResult CheckVersionList (int latestInternalResourceVersion)
 使用可更新模式并检查版本资源列表。 更多...
 
void UpdateVersionList (int versionListLength, int versionListHashCode, int versionListZipLength, int versionListZipHashCode, UpdateVersionListCallbacks updateVersionListCallbacks)
 使用可更新模式并更新版本资源列表。 更多...
 
void CheckResources (CheckResourcesCompleteCallback checkResourcesCompleteCallback)
 使用可更新模式并检查资源。 更多...
 
void UpdateResources (UpdateResourcesCompleteCallback updateResourcesCompleteCallback)
 使用可更新模式并更新全部资源。 更多...
 
void UpdateResources (string resourceGroupName, UpdateResourcesCompleteCallback updateResourcesCompleteCallback)
 使用可更新模式并更新指定资源组的资源。 更多...
 
bool HasAsset (string assetName)
 检查资源是否存在。 更多...
 
void LoadAsset (string assetName, LoadAssetCallbacks loadAssetCallbacks)
 异步加载资源。 更多...
 
void LoadAsset (string assetName, Type assetType, LoadAssetCallbacks loadAssetCallbacks)
 异步加载资源。 更多...
 
void LoadAsset (string assetName, int priority, LoadAssetCallbacks loadAssetCallbacks)
 异步加载资源。 更多...
 
void LoadAsset (string assetName, LoadAssetCallbacks loadAssetCallbacks, object userData)
 异步加载资源。 更多...
 
void LoadAsset (string assetName, Type assetType, int priority, LoadAssetCallbacks loadAssetCallbacks)
 异步加载资源。 更多...
 
void LoadAsset (string assetName, Type assetType, LoadAssetCallbacks loadAssetCallbacks, object userData)
 异步加载资源。 更多...
 
void LoadAsset (string assetName, int priority, LoadAssetCallbacks loadAssetCallbacks, object userData)
 异步加载资源。 更多...
 
void LoadAsset (string assetName, Type assetType, int priority, LoadAssetCallbacks loadAssetCallbacks, object userData)
 异步加载资源。 更多...
 
void UnloadAsset (object asset)
 卸载资源。 更多...
 
bool HasResourceGroup (string resourceGroupName)
 检查资源组是否存在。 更多...
 
IResourceGroup GetResourceGroup ()
 获取默认资源组。 更多...
 
IResourceGroup GetResourceGroup (string resourceGroupName)
 获取资源组。 更多...
 
TaskInfo[] GetAllLoadAssetInfos ()
 获取所有加载资源任务的信息。 更多...
 

Protected 成员函数

override void Awake ()
 游戏框架组件初始化。 更多...
 

属性

string ReadOnlyPath [get]
 获取资源只读路径。 更多...
 
string ReadWritePath [get]
 获取资源读写路径。 更多...
 
ResourceMode ResourceMode [get]
 获取资源模式。 更多...
 
ReadWritePathType ReadWritePathType [get]
 获取资源读写路径类型。 更多...
 
string CurrentVariant [get]
 设置当前变体。 更多...
 
float UnloadUnusedAssetsInterval [get, set]
 获取或设置无用资源释放间隔时间。 更多...
 
string ApplicableGameVersion [get]
 获取当前资源适用的游戏版本号。 更多...
 
int InternalResourceVersion [get]
 获取当前内部资源版本号。 更多...
 
int AssetCount [get]
 获取已准备完毕资源数量。 更多...
 
int ResourceCount [get]
 获取已准备完毕资源数量。 更多...
 
int ResourceGroupCount [get]
 获取资源组数量。 更多...
 
string UpdatePrefixUri [get, set]
 获取或设置资源更新下载地址。 更多...
 
int GenerateReadWriteListLength [get, set]
 获取或设置每下载多少字节的资源,刷新一次资源列表。 更多...
 
int UpdateRetryCount [get, set]
 获取或设置资源更新重试次数。 更多...
 
IResourceGroup UpdatingResourceGroup [get]
 获取正在更新的资源组。 更多...
 
int UpdateWaitingCount [get]
 获取等待更新资源数量。 更多...
 
int UpdateCandidateCount [get]
 获取候选更新资源数量。 更多...
 
int UpdatingCount [get]
 获取正在更新资源数量。 更多...
 
int LoadTotalAgentCount [get]
 获取加载资源代理总数量。 更多...
 
int LoadFreeAgentCount [get]
 获取可用加载资源代理数量。 更多...
 
int LoadWorkingAgentCount [get]
 获取工作中加载资源代理数量。 更多...
 
int LoadWaitingTaskCount [get]
 获取等待加载资源任务数量。 更多...
 
float AssetAutoReleaseInterval [get, set]
 获取或设置资源对象池自动释放可释放对象的间隔秒数。 更多...
 
int AssetCapacity [get, set]
 获取或设置资源对象池的容量。 更多...
 
float AssetExpireTime [get, set]
 获取或设置资源对象池对象过期秒数。 更多...
 
int AssetPriority [get, set]
 获取或设置资源对象池的优先级。 更多...
 
float ResourceAutoReleaseInterval [get, set]
 获取或设置资源对象池自动释放可释放对象的间隔秒数。 更多...
 
int ResourceCapacity [get, set]
 获取或设置资源对象池的容量。 更多...
 
float ResourceExpireTime [get, set]
 获取或设置资源对象池对象过期秒数。 更多...
 
int ResourcePriority [get, set]
 获取或设置资源对象池的优先级。 更多...
 

详细描述

资源组件。

成员函数说明

◆ Awake()

override void Awake ( )
protectedvirtual

游戏框架组件初始化。

重载 GameFrameworkComponent .

◆ CheckResources()

void CheckResources ( CheckResourcesCompleteCallback  checkResourcesCompleteCallback)

使用可更新模式并检查资源。

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

◆ CheckVersionList()

CheckVersionListResult CheckVersionList ( int  latestInternalResourceVersion)

使用可更新模式并检查版本资源列表。

参数
latestInternalResourceVersion最新的内部资源版本号。
返回
检查版本资源列表结果。

◆ ForceUnloadUnusedAssets()

void ForceUnloadUnusedAssets ( bool  performGCCollect)

强制执行释放未被使用的资源。

参数
performGCCollect是否使用垃圾回收。

◆ GetAllLoadAssetInfos()

TaskInfo [] GetAllLoadAssetInfos ( )

获取所有加载资源任务的信息。

返回
所有加载资源任务的信息。

◆ GetResourceGroup() [1/2]

IResourceGroup GetResourceGroup ( )

获取默认资源组。

返回
默认资源组。

◆ GetResourceGroup() [2/2]

IResourceGroup GetResourceGroup ( string  resourceGroupName)

获取资源组。

参数
resourceGroupName要获取的资源组名称。
返回
要获取的资源组。

◆ HasAsset()

bool HasAsset ( string  assetName)

检查资源是否存在。

参数
assetName要检查资源的名称。
返回
资源是否存在。

◆ HasResourceGroup()

bool HasResourceGroup ( string  resourceGroupName)

检查资源组是否存在。

参数
resourceGroupName要检查资源组的名称。
返回
资源组是否存在。

◆ InitResources()

void InitResources ( InitResourcesCompleteCallback  initResourcesCompleteCallback)

使用单机模式并初始化资源。

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

◆ LoadAsset() [1/8]

void LoadAsset ( string  assetName,
int  priority,
LoadAssetCallbacks  loadAssetCallbacks 
)

异步加载资源。

参数
assetName要加载资源的名称。
priority加载资源的优先级。
loadAssetCallbacks加载资源回调函数集。

◆ LoadAsset() [2/8]

void LoadAsset ( string  assetName,
int  priority,
LoadAssetCallbacks  loadAssetCallbacks,
object  userData 
)

异步加载资源。

参数
assetName要加载资源的名称。
priority加载资源的优先级。
loadAssetCallbacks加载资源回调函数集。
userData用户自定义数据。

◆ LoadAsset() [3/8]

void LoadAsset ( string  assetName,
LoadAssetCallbacks  loadAssetCallbacks 
)

异步加载资源。

参数
assetName要加载资源的名称。
loadAssetCallbacks加载资源回调函数集。

◆ LoadAsset() [4/8]

void LoadAsset ( string  assetName,
LoadAssetCallbacks  loadAssetCallbacks,
object  userData 
)

异步加载资源。

参数
assetName要加载资源的名称。
loadAssetCallbacks加载资源回调函数集。
userData用户自定义数据。

◆ LoadAsset() [5/8]

void LoadAsset ( string  assetName,
Type  assetType,
int  priority,
LoadAssetCallbacks  loadAssetCallbacks 
)

异步加载资源。

参数
assetName要加载资源的名称。
assetType要加载资源的类型。
priority加载资源的优先级。
loadAssetCallbacks加载资源回调函数集。

◆ LoadAsset() [6/8]

void LoadAsset ( string  assetName,
Type  assetType,
int  priority,
LoadAssetCallbacks  loadAssetCallbacks,
object  userData 
)

异步加载资源。

参数
assetName要加载资源的名称。
assetType要加载资源的类型。
priority加载资源的优先级。
loadAssetCallbacks加载资源回调函数集。
userData用户自定义数据。

◆ LoadAsset() [7/8]

void LoadAsset ( string  assetName,
Type  assetType,
LoadAssetCallbacks  loadAssetCallbacks 
)

异步加载资源。

参数
assetName要加载资源的名称。
assetType要加载资源的类型。
loadAssetCallbacks加载资源回调函数集。

◆ LoadAsset() [8/8]

void LoadAsset ( string  assetName,
Type  assetType,
LoadAssetCallbacks  loadAssetCallbacks,
object  userData 
)

异步加载资源。

参数
assetName要加载资源的名称。
assetType要加载资源的类型。
loadAssetCallbacks加载资源回调函数集。
userData用户自定义数据。

◆ SetCurrentVariant()

void SetCurrentVariant ( string  currentVariant)

设置当前变体。

参数
currentVariant当前变体。

◆ SetDecryptResourceCallback()

void SetDecryptResourceCallback ( DecryptResourceCallback  decryptResourceCallback)

设置解密资源回调函数。

参数
decryptResourceCallback要设置的解密资源回调函数。

如果不设置,将使用默认的解密资源回调函数。

◆ SetResourceMode()

void SetResourceMode ( ResourceMode  resourceMode)

设置资源模式。

参数
resourceMode资源模式。

◆ UnloadAsset()

void UnloadAsset ( object  asset)

卸载资源。

参数
asset要卸载的资源。

◆ UnloadUnusedAssets()

void UnloadUnusedAssets ( bool  performGCCollect)

预订执行释放未被使用的资源。

参数
performGCCollect是否使用垃圾回收。

◆ UpdateResources() [1/2]

void UpdateResources ( string  resourceGroupName,
UpdateResourcesCompleteCallback  updateResourcesCompleteCallback 
)

使用可更新模式并更新指定资源组的资源。

参数
resourceGroupName要更新的资源组名称。
updateResourcesCompleteCallback使用可更新模式并更新指定资源组完成时的回调函数。

◆ UpdateResources() [2/2]

void UpdateResources ( UpdateResourcesCompleteCallback  updateResourcesCompleteCallback)

使用可更新模式并更新全部资源。

参数
updateResourcesCompleteCallback使用可更新模式并更新默认资源组完成时的回调函数。

◆ UpdateVersionList()

void UpdateVersionList ( int  versionListLength,
int  versionListHashCode,
int  versionListZipLength,
int  versionListZipHashCode,
UpdateVersionListCallbacks  updateVersionListCallbacks 
)

使用可更新模式并更新版本资源列表。

参数
versionListLength版本资源列表大小。
versionListHashCode版本资源列表哈希值。
versionListZipLength版本资源列表压缩后大小。
versionListZipHashCode版本资源列表压缩后哈希值。
updateVersionListCallbacks版本资源列表更新回调函数集。

属性说明

◆ ApplicableGameVersion

string ApplicableGameVersion
get

获取当前资源适用的游戏版本号。

◆ AssetAutoReleaseInterval

float AssetAutoReleaseInterval
getset

获取或设置资源对象池自动释放可释放对象的间隔秒数。

◆ AssetCapacity

int AssetCapacity
getset

获取或设置资源对象池的容量。

◆ AssetCount

int AssetCount
get

获取已准备完毕资源数量。

◆ AssetExpireTime

float AssetExpireTime
getset

获取或设置资源对象池对象过期秒数。

◆ AssetPriority

int AssetPriority
getset

获取或设置资源对象池的优先级。

◆ CurrentVariant

string CurrentVariant
get

设置当前变体。

◆ GenerateReadWriteListLength

int GenerateReadWriteListLength
getset

获取或设置每下载多少字节的资源,刷新一次资源列表。

◆ InternalResourceVersion

int InternalResourceVersion
get

获取当前内部资源版本号。

◆ LoadFreeAgentCount

int LoadFreeAgentCount
get

获取可用加载资源代理数量。

◆ LoadTotalAgentCount

int LoadTotalAgentCount
get

获取加载资源代理总数量。

◆ LoadWaitingTaskCount

int LoadWaitingTaskCount
get

获取等待加载资源任务数量。

◆ LoadWorkingAgentCount

int LoadWorkingAgentCount
get

获取工作中加载资源代理数量。

◆ ReadOnlyPath

string ReadOnlyPath
get

获取资源只读路径。

◆ ReadWritePath

string ReadWritePath
get

获取资源读写路径。

◆ ReadWritePathType

获取资源读写路径类型。

◆ ResourceAutoReleaseInterval

float ResourceAutoReleaseInterval
getset

获取或设置资源对象池自动释放可释放对象的间隔秒数。

◆ ResourceCapacity

int ResourceCapacity
getset

获取或设置资源对象池的容量。

◆ ResourceCount

int ResourceCount
get

获取已准备完毕资源数量。

◆ ResourceExpireTime

float ResourceExpireTime
getset

获取或设置资源对象池对象过期秒数。

◆ ResourceGroupCount

int ResourceGroupCount
get

获取资源组数量。

◆ ResourceMode

获取资源模式。

◆ ResourcePriority

int ResourcePriority
getset

获取或设置资源对象池的优先级。

◆ UnloadUnusedAssetsInterval

float UnloadUnusedAssetsInterval
getset

获取或设置无用资源释放间隔时间。

◆ UpdateCandidateCount

int UpdateCandidateCount
get

获取候选更新资源数量。

◆ UpdatePrefixUri

string UpdatePrefixUri
getset

获取或设置资源更新下载地址。

◆ UpdateRetryCount

int UpdateRetryCount
getset

获取或设置资源更新重试次数。

◆ UpdateWaitingCount

int UpdateWaitingCount
get

获取等待更新资源数量。

◆ UpdatingCount

int UpdatingCount
get

获取正在更新资源数量。

◆ UpdatingResourceGroup

IResourceGroup UpdatingResourceGroup
get

获取正在更新的资源组。