CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
Common类 参考

提供CRIWARE插件相关辅助功能的类。 更多...

struct  CpuUsage
 CRIWARE插件的CPU使用情况 更多...
 

静态 Public 成员函数

static bool IsStreamingAssetsPath (string path)
 判断是否作为从StreamingAssets文件夹的相对路径来使用。 更多...
 
static string GetScriptVersionString ()
 获取脚本版本字符串 更多...
 
static int GetBinaryVersionNumber ()
 获取二进制版本编号 更多...
 
static int GetRequiredBinaryVersionNumber ()
 获取脚本所需二进制版本 更多...
 
static bool CheckBinaryVersionCompatibility ()
 二进制版本和脚本版本的整合性检查 更多...
 
static uint GetFsMemoryUsage ()
 获取CRI FileSystem的内存使用量 更多...
 
static uint GetAtomMemoryUsage ()
 获取CRI Atom的内存使用量 更多...
 
static uint GetManaMemoryUsage ()
 获取CRI Mana的内存使用量 更多...
 
static CpuUsage GetAtomCpuUsage ()
 获取CRIWARE插件的CPU使用情况 更多...
 

Public 属性

const bool supportsCriFsInstaller
 是否支持CriFsInstaller API 更多...
 
const bool supportsCriFsWebInstaller
 是否支持CriFsWebInstaller API 更多...
 

属性

static string streamingAssetsPath [get]
 StreamingAssets文件夹的路径。 更多...
 
static string installTargetPath [get]
 是数据文件夹的路径。 更多...
 
static string installCachePath [get]
 缓存的数据文件夹的路径。 更多...
 

详细描述

提供CRIWARE插件相关辅助功能的类。

说明:
提供可以在各平台共通的辅助方法。
通过使用本类的属性和方法,可以获取特殊数据文件夹的路径或者 通过CRIWARE插件来确认CPU/内存的使用情况。

成员函数说明

static bool IsStreamingAssetsPath ( string  path)
inlinestatic

判断是否作为从StreamingAssets文件夹的相对路径来使用。

参数
path文件路径
返回
是否作为从StreamingAssets文件夹的相对路径来使用
说明:
path通过CRIWARE插件判断是否作为从StreamingAssets文件夹的相对路径来使用。
CRIWARE插件可以从StreamingAssets文件夹的相对路径使用所有满足以下条件的内容。
  • 不是绝对路径
  • 不包含 ':'
注意:
关于实际上是否作为StreamingAssets文件夹的相对路径来使用,请参照各API的参照。
static string GetScriptVersionString ( )
inlinestatic

获取脚本版本字符串

说明:
本方法会返回CRIWARE的脚本版本字符串。
static int GetBinaryVersionNumber ( )
inlinestatic

获取二进制版本编号

说明:
本方法会返回CRIWARE的二进制版本编号。 此处的二进制是指CRIWARE插件中包含的程序库文件(.dll等)。
static int GetRequiredBinaryVersionNumber ( )
inlinestatic

获取脚本所需二进制版本

说明:
本方法会返回CRIWARE脚本所需的运行时版本编号。
static bool CheckBinaryVersionCompatibility ( )
inlinestatic

二进制版本和脚本版本的整合性检查

说明:
本方法是用来检查当前的二进制是否与脚本所需的版本编号保持一致。
如果一致,则将视为整合性检查成功,返回True。
如果不一致,则将视为失败,在控制台输出错误消息后,返回False。
static uint GetFsMemoryUsage ( )
inlinestatic

获取CRI FileSystem的内存使用量

说明:
本方法会返回CRI FileSystem的内存使用量。
static uint GetAtomMemoryUsage ( )
inlinestatic

获取CRI Atom的内存使用量

说明:
本方法会返回CRI Atom的内存使用量。
static uint GetManaMemoryUsage ( )
inlinestatic

获取CRI Mana的内存使用量

说明:
本方法会返回CRI Mana的内存使用量。
static CpuUsage GetAtomCpuUsage ( )
inlinestatic

获取CRIWARE插件的CPU使用情况

说明:
本方法会返回CRIWARE插件的本机程序库的 CPU使用情况。返回值是CpuUsage结构体。

类成员变量说明

const bool supportsCriFsInstaller
初始值:
=
#if UNITY_EDITOR || UNITY_STANDALONE_OSX || UNITY_STANDALONE_WIN || UNITY_IOS || UNITY_TVOS || UNITY_ANDROID || UNITY_WINRT
true

是否支持CriFsInstaller API

说明:
CriFsInstaller API用于判断是否可以在执行环境中使用。
const bool supportsCriFsWebInstaller
初始值:
=
#if UNITY_EDITOR_WIN || UNITY_STANDALONE_WIN || UNITY_EDITOR_OSX || UNITY_STANDALONE_OSX || UNITY_IOS || UNITY_ANDROID
true

是否支持CriFsWebInstaller API

说明:
CriFsWebInstaller API用于判断是否可以在执行环境中使用。

属性说明

string streamingAssetsPath
staticget

StreamingAssets文件夹的路径。

说明:
本属性会返回StreamingAssets文件夹的路径。无法进行值的set。
注意:
为Android环境时,本属性将会返回空字符串。 通过CRIWARE插件的功能来存取StreamingAssets内的文件时 仅限在Android环境下,请直接指定StreamingAssets以下的相对路径。 此时,请注意路径的开头没有"/"。
string installTargetPath
staticget

是数据文件夹的路径。

说明:
本属性会返回数据文件夹的路径。无法进行值的set。
注意:
iOS环境时,对本文件夹的文件写入可能会 因AppStore的审查而出现问题。
string installCachePath
staticget

缓存的数据文件夹的路径。

说明:
返回缓存数据文件夹的路径。
该属性返回的目录内容可被应用程序写入。
注意:
在某些平台上返回非持久路径。
此属性返回的路径是否持久取决于各平台是否启用或禁用了 AssetBundle 缓存。

该类的文档由以下文件生成: