CRIWARE Unity Plugin Manual  Last Updated: 2024-04-24
Common クラス

CRIWAREプラグインに関する補助的な機能を提供するクラスです。 [詳解]

クラス

struct  CpuUsage
 CRIWAREプラグインのCPU使用状況 [詳解]
 

静的公開メンバ関数

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使用状況の取得 [詳解]
 

公開変数類

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 キャッシングの有効/無効に従います。

このクラス詳解は次のファイルから抽出されました: