CRIWARE Unity Plugin Manual  Last Updated: 2021-05-13
CriFsWebInstallRequest クラス

インストール処理の進捗状況の確認や、インストール処理結果を取得するためのモジュールです。 [詳解]

CriFsWebInstallRequest の継承関係図
CriFsInstallRequest CriFsRequest

公開メンバ関数

override void Stop ()
 インストール処理を停止します。 [詳解]
 
YieldInstruction WaitForDone (MonoBehaviour mb)
 非同期処理の完了を待ちます。 [詳解]
 

プロパティ

string sourcePath [get, protected set]
 インストール元のファイルパスです。 [詳解]
 
string destinationPath [get, protected set]
 インストール先のファイルパスです。 [詳解]
 
float progress [get, protected set]
 インストール処理の進捗状況です。 [詳解]
 
DoneDelegate doneDelegate [get, protected set]
 処理が完了したときのデリゲート。 [詳解]
 
bool isDone [get]
 処理が完了したかどうか。 [詳解]
 
string error [get, protected set]
 エラー情報。 [詳解]
 
bool isDisposed [get, protected set]
 破棄情報。 [詳解]
 

詳解

インストール処理の進捗状況の確認や、インストール処理結果を取得するためのモジュールです。

説明:
インストール処理の進捗状況の確認や、インストール処理結果を取得するためのモジュールです。
CriFsUtility::WebInstall 関数の戻り値として返されます。

インストール処理が完了すると、isDoneの値がTrueになります。
インストール処理中にエラーが発生した場合、errorにエラー情報が格納されます。
参照
CriFsUtility::WebInstall

関数詳解

override void Stop ( )
inlinevirtual

インストール処理を停止します。

説明:
処理を停止します。

本関数は即時復帰関数です。
本関数を実行してからインストール処理が停止するまでには、最大20秒程度の時間がかかることがあります。
インストール処理が停止すると、コルーチンとして動作している CriFsWebInstallRequest::WaitForDone 関数が復帰します。

CriFsRequestを再実装しています。

YieldInstruction WaitForDone ( MonoBehaviour  mb)
inlineinherited

非同期処理の完了を待ちます。

説明:

非同期処理が完了するまで、コルーチンの実行をサスペンドします。

本関数はコルーチン内のyieldステートメントでのみ利用可能です。
具体的には、以下のような書式で使用する必要があります。
: // 非同期処理の開始 CriFsRequest request = CriFsUtility.?

// 非同期処理の完了まで待機 yield return request.WaitForDone(this); :

プロパティ詳解

string sourcePath
getprotected setinherited

インストール元のファイルパスです。

説明:
インストール元のファイルパスです。
CriFsUtility::Install 関数実行時に指定したパスが格納されています。
参照
CriFsUtility::LoadAssetBundle
string destinationPath
getprotected setinherited

インストール先のファイルパスです。

説明:
インストール先のファイルパスです。
CriFsUtility::Install 関数実行時に指定したパスが格納されています。
参照
CriFsUtility::LoadAssetBundle
float progress
getprotected setinherited

インストール処理の進捗状況です。

戻り値
進捗状況
説明:
処理の進捗状況を取得します。
進捗状況は0.0~1.0の32ビット浮動小数点数です。

CriFsInstallRequest::Stop 関数で処理を停止した場合、停止時点での進捗状況が保存されています。
インストール処理中にエラーが発生した場合、値が負値になります。
値が更新されるタイミングは、 CriWareInitializer.fileSystemConfig.installBufferSize の大きさのバッファが満たされた時です。
インストールバッファのサイズが大きすぎると、インストールが進行しているにも関わらず、 値の更新頻度が低くなります。
タイムアウト処理などを行う場合には、インストールバッファのサイズに注意してください。
DoneDelegate doneDelegate
getprotected setinherited

処理が完了したときのデリゲート。

説明:
非同期処理の完了をチェックするためのパラメータです。
非同期処理中はisDoneの値はFalseです。
非同期処理が完了すると、isDoneの値がTrueになります。
bool isDone
getinherited

処理が完了したかどうか。

説明:
非同期処理の完了をチェックするためのパラメータです。
非同期処理中はisDoneの値はFalseです。
非同期処理が完了すると、isDoneの値がTrueになります。
string error
getprotected setinherited

エラー情報。

説明:
非同期処理中のエラーが起きたかどうかをチェックするためのパラメータです。
非同期処理が正常に完了した場合、errorの値はnullです。
非同期処理中にエラーが発生すると、エラー情報が格納されます。
bool isDisposed
getprotected setinherited

破棄情報。

説明:
リクエストが破棄されたかどうかをチェックするためのパラメータです。

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