CRI File System Integration

Classes
class	CriFsPlugin
	Global class in the CRIFs library. More...

Functions
virtual void	Stop ()
	Stops the asynchronous process. More...
YieldInstruction	WaitForDone (MonoBehaviour mb)
	Waits for the completion of asynchronous process. More...
override void	Stop ()
	Stops the asynchronous process. More...
override void	Stop ()
	Stops the installation process. More...
override void	Stop ()
	Stops the installation process. More...
override void	Stop ()
	Stops the asynchronous process. More...
static CriFsLoadFileRequest	LoadFile (string path, int readUnitSize=DefaultReadUnitSize)
	Starts loading the file. More...
static CriFsLoadFileRequest	LoadFile (CriFsBinder binder, string path, int readUnitSize=DefaultReadUnitSize)
	Starts loading the file. More...
static CriFsLoadAssetBundleRequest	LoadAssetBundle (string path, int readUnitSize=DefaultReadUnitSize)
	Starts loading the Asset Bundle file. More...
static CriFsLoadAssetBundleRequest	LoadAssetBundle (CriFsBinder binder, string path, int readUnitSize=DefaultReadUnitSize)
	Starts loading the Asset Bundle file. More...
static CriFsInstallRequest	Install (string srcPath, string dstPath)
	Starts installing files. More...
static CriFsInstallRequest	Install (CriFsBinder srcBinder, string srcPath, string dstPath)
	Starts installing files. More...
static CriFsInstallRequest	WebInstall (string srcPath, string dstPath, CriFsRequest.DoneDelegate doneDeleagate)
	Starts installing files. More...
static CriFsBindRequest	BindCpk (CriFsBinder targetBinder, string srcPath)
	Start binding the CPK file. More...
static CriFsBindRequest	BindCpk (CriFsBinder targetBinder, CriFsBinder srcBinder, string srcPath)
	Start binding the CPK file. More...
static CriFsBindRequest	BindDirectory (CriFsBinder targetBinder, string srcPath)
	Starts binding the directory path. More...
static CriFsBindRequest	BindDirectory (CriFsBinder targetBinder, CriFsBinder srcBinder, string srcPath)
	Starts binding the directory path. More...
static CriFsBindRequest	BindFile (CriFsBinder targetBinder, string srcPath)
	Binds the file. More...
static CriFsBindRequest	BindFile (CriFsBinder targetBinder, CriFsBinder srcBinder, string srcPath)
	Starts binding files. More...
static void	SetUserAgentString (string userAgentString)
	Specifies the User-Agent string used in HTTP requests. More...
static void	SetProxyServer (string proxyPath, UInt16 proxyPort)
	Specifies the proxy server used for HTTP requests. More...
static void	SetPathSeparator (string filter)
	Specifies the path separator More...

Variables
const int	DefaultReadUnitSize = (1024 * 1024)
	The default read unit size for each loading request. More...

Properties
DoneDelegate	doneDelegate [get, protected set]
	Delegate when processing is complete. More...
bool	isDone [get]
	Whether the processing is complete. More...
string	error [get, protected set]
	Error information. More...
bool	isDisposed [get, protected set]
	Discard information. More...
string	path [get]
	The path to the file to be loaded. More...
byte[]	bytes [get]
	A buffer that stores load result. More...
string	path [get]
	The path to the Asset Bundle file to be loaded. More...
AssetBundle	assetBundle [get]
	The Asset Bundle that is the result of loading. More...
string	sourcePath [get, protected set]
	Installation source file path. More...
string	destinationPath [get, protected set]
	Installation destination file path. More...
float	progress [get, protected set]
	The progress of the installation process. More...
string	path [get]
	The path of the file to be bound. More...
uint	bindId [get]
	The ID which identifies the binding process. More...

Detailed Description

This is an extension of CRI File System that can be called from C# .

Function Documentation

virtual void Stop ( )

inlinevirtual

Stops the asynchronous process.

Description:

Stops the asynchronous process.

Reimplemented in CriFsBindRequest, CriFsWebInstallRequest, and CriFsLoadFileRequest.

YieldInstruction WaitForDone ( MonoBehaviour  mb )

inline

Waits for the completion of asynchronous process.

Description:

Suspend the execution of coroutine until asynchronous process is complete.

This function can be used only in the yield statement in the coroutine.
Specifically, it should be used in the following format.
： // 非同期処理の開始 CriFsRequest request = CriFsUtility.?

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

override void Stop ( )

inlinevirtual

Stops the asynchronous process.

Description:

Stops the asynchronous process.

Reimplemented from CriFsRequest.

override void Stop ( )

inline

Stops the installation process.

Description:

Stops the processing.

This function returns immediately.
It may take up to 20 seconds until the installation process stops after calling this function.
When the installation process stops, the CriWare.CriFsInstallRequest::WaitForDone function running as a coroutine returns.

override void Stop ( )

inlinevirtual

Stops the installation process.

Description:

Stops the processing.

This function returns immediately.
It may take up to 20 seconds until the installation process stops after calling this function.
When the installation process stops, the CriWare.CriFsWebInstallRequest::WaitForDone function running as a coroutine returns.

Reimplemented from CriFsRequest.

override void Stop ( )

inlinevirtual

Stops the asynchronous process.

Description:

Stops the asynchronous process.

Reimplemented from CriFsRequest.

static CriFsLoadFileRequest LoadFile ( string  path, int  readUnitSize = DefaultReadUnitSize  )

inlinestatic

Starts loading the file.

Parameters

path	File path
readUnitSize	Read unit size of the CriFsLoader used internal

Returns

CriFsLoadFileRequest

Description:

Starts reading the specified file.

This function returns immediately.
You should check CriWare.CriFsLoadFileRequest::isDone to check the completion of the loading.
If an error occurs during the loading process, the error information is stored in CriWare.CriFsLoadFileRequest::error .

Note:

When loading the data in the CPK file, it is necessary to use CriWare.CriFsUtility::LoadFile instead of this function to specify the binder from which to load the data.

You can also load the file from network by specifying a URL in the path.

// crimot.comからFMPRO_Intro_e.txtをダウンロード
CriFsLoadFileRequest request = CriFsUtility.LoadFile(
 "http://crimot.com/sdk/sampledata/crifilesystem/FMPRO_Intro_e.txt");

Example:

The code to load a file using the CriWare.CriFsUtility::LoadFile function is as follows.

IEnumerator UserLoadFile(string path)
{
 // ファイルの読み込みを開始
 CriFsLoadFileRequest request = CriFsUtility.LoadFile(path);

 // 読み込み完了を待つ
 yield return request.WaitForDone(this);

 // エラーチェック
 if (request.error != null) {
     // エラー発生時の処理
     …
     yield break;
 }

 // 備考）ロードされたファイルの内容は request.bytes 内に格納されています。
}

To load data under the StreamingAssets folder, concatenate CriWare::Common::streamingAssetsPath with the file path.

string path = Path.Combine(CriWare.Common.streamingAssetsPath, "sample_text.txt");
CriFsLoadFileRequest request = CriFsUtility.LoadFile(path);

See also

CriFsLoadFileRequest, CriFsUtility::LoadFile(CriFsBinder, string)

static CriFsLoadFileRequest LoadFile ( CriFsBinder  binder, string  path, int  readUnitSize = DefaultReadUnitSize  )

inlinestatic

Starts loading the file.

Parameters

binder	Binder
path	File path
readUnitSize	Read unit size of the CriFsLoader used internal

Returns

CriFsLoadFileRequest

Description:

Begins loading the bound file.

This function returns immediately.
You should check CriWare.CriFsLoadFileRequest::isDone to check the completion of the loading.
If an error occurs during the loading process, the error information is stored in CriWare.CriFsLoadFileRequest::error .

Note:

Same as the CriWare.CriFsUtility::LoadFile function, except that the binder is specified as the first argument.

See also

CriFsLoadFileRequest, CriFsUtility::LoadFile(string)

static CriFsLoadAssetBundleRequest LoadAssetBundle ( string  path, int  readUnitSize = DefaultReadUnitSize  )

inlinestatic

Starts loading the Asset Bundle file.

Parameters

path	File path
readUnitSize	Read unit size of the CriFsLoader used internal

Returns

CriFsLoadAssetBundleRequest

Description:

Starts loading the specified Asset Bundle file.

This function returns immediately.
You should check CriWare.CriFsLoadAssetBundleRequest::isDone to check the completion of the loading.
If an error occurs during the loading process, the error information is stored in CriWare.CriFsLoadFileRequest::error .

Note:

When loading the asset data in the CPK file, it is necessary to use CriWare.CriFsUtility::LoadAssetBundle instead of this function to specify the binder from which to load the data.

You can also load the file from network by specifying a URL in the path.

// crimot.comからCharaMomo.unity3dをダウンロード
CriFsLoadFileRequest request = CriFsUtility.LoadAssetBundle(
 "http://crimot.com/sdk/sampledata/crifilesystem/CharaMomo.unity3d");

Example:

The code to load an asset bundle using the CriWare.CriFsUtility::LoadAssetBundle function is as follows.

IEnumerator UserLoadAssetBundle(string path)
{
 // アセットバンドルの読み込みを開始
 CriFsLoadAssetBundleRequest request = CriFsUtility.LoadAssetBundle(path);

 // 読み込み完了を待つ
 yield return request.WaitForDone(this);

 // エラーチェック
 if (request.error != null) {
     // エラー発生時の処理
     …
     yield break;
 }

 // インスタンスの作成
 var obj = GameObject.Instantiate(request.assetBundle.mainAsset,
         new Vector3(0.0f, 0.0f, 0.0f), Quaternion.identity);
     ：
}

To load data under the StreamingAssets folder, concatenate CriWare::Common::streamingAssetsPath with the file path.

string path = Path.Combine(CriWare.Common.streamingAssetsPath, "sample.assetbundle");
CriFsLoadAssetBundleRequest request = CriFsUtility.LoadAssetBundle(path);

See also

CriFsLoadAssetBundleRequest, CriFsUtility::LoadAssetBundle(CriFsBinder, string)

static CriFsLoadAssetBundleRequest LoadAssetBundle ( CriFsBinder  binder, string  path, int  readUnitSize = DefaultReadUnitSize  )

inlinestatic

Starts loading the Asset Bundle file.

Parameters

binder	Binder
path	File path
readUnitSize	Read unit size of the CriFsLoader used internal

Returns

CriFsLoadAssetBundleRequest

Description:

Begins loading the bound Asset Bundle file.

This function returns immediately.
You should check CriWare.CriFsLoadAssetBundleRequest::isDone to check the completion of the loading.
If an error occurs during the loading process, the error information is stored in CriWare.CriFsLoadFileRequest::error .

Note:

Same as the CriWare.CriFsUtility::LoadAssetBundle function, except that the binder is specified as the first argument.

See also

CriFsLoadAssetBundleRequest, CriFsUtility::LoadAssetBundle(string)

static CriFsInstallRequest Install ( string  srcPath, string  dstPath  )

inlinestatic

Starts installing files.

Parameters

srcPath	Installation source file path
dstPath	Installation destination file path

Returns

CriFsInstallRequest

Description:

Starts the installation of the specified file.
Specify the installation source file path in srcPath and the installation destination file path in dstPath.

This function returns immediately.
You should use CriWare.CriFsInstallRequest::isDone to check the completion of the installation.
If an error occurs during the installation process, the error information is stored in CriWare.CriFsInstallRequest::error .

When specifying data under the StreamingAssets folder as the installation source, prepend CriWare::Common::streamingAssetsPath to the file path.

Note:

You can also load the file from network by specifying a URL in the path.

Note:

Create a folder in advance and call this API since an error occurs if the installation destination does not exist.

Example:

The code to install files using the CriWare.CriFsUtility::Install function is as follows.

private IEnumerator UserInstallFile(string url, string path)
{
 // インストールの開始
 CriFsInstallRequest request = CriFsUtility.Install(url, path);

 // インストール完了待ち
 yield return request.WaitForDone(this);

 // エラーチェック
 if (request.error != null) {
     // エラー発生時の処理
     …
     yield break;
 }
     ：
}

See also

CriFsInstallRequest

static CriFsInstallRequest Install ( CriFsBinder  srcBinder, string  srcPath, string  dstPath  )

inlinestatic

Starts installing files.

Parameters

srcBinder	Installation source binder
srcPath	Installation source file path
dstPath	Installation destination file path

Returns

CriFsInstallRequest

Description:

Start the installation of bound files.
Specify the installation source file path in srcPath and the installation destination file path in dstPath.

This function returns immediately.
You should check CriWare.CriFsInstallRequest::isDone to check the completion of the installation.
If an error occurs during the installation process, the error information is stored in CriWare.CriFsInstallRequest::error .

Note:

Same as the CriWare.CriFsUtility::Install(string, string) function, except that the binder is specified as the first argument.
(This function is used only when writing the contents in the CPK file as a file.)

See also

CriFsInstallRequest, CriFsUtility::Install(string, string)

static CriFsInstallRequest WebInstall ( string  srcPath, string  dstPath, CriFsRequest.DoneDelegate  doneDeleagate  )

inlinestatic

Starts installing files.

Parameters

srcPath	Installation source file path (URL)
dstPath	Installation destination file path
doneDeleagate	Asynchronous process completion callback

Returns

CriFsWebInstallRequest

Description:

Begin installing the files.
Specify the source file path (URL) in srcPath and the destination file path in dstPath.

This function is asynchronous.
Check CriWare.CriFsWebInstallRequest::isDone to confirm whether the installation is completed or not.
If an error occurs during the installation process, the error information will be stored in CriWare.CriFsWebInstallRequest::error .

This method may cause an exception when accessing files internally.
We recommend encapsulating the call in a try-catch statement to handle request failures.

Note:

On iOS, this function works on iOS7 or later.

See also

CriFsWebInstallRequest

static CriFsBindRequest BindCpk ( CriFsBinder  targetBinder, string  srcPath  )

inlinestatic

Start binding the CPK file.

Parameters

targetBinder	Binder to be bound
srcPath	CPK file path

Returns

CriFsBindRequest

Description:

Start binding the CPK file.

This function returns immediately.
You should check CriWare.CriFsBindRequest::isDone to check the completion of the binding.
If an error occurs during the binding process, the error information is stored in CriWare.CriFsBindRequest::error .

When binding the data under the StreamingAssets folder, prepend CriWare::Common::streamingAssetsPath to the file path.

Note:

If you want to use the multi-bind function or bind the CPK data in the CPK file, you must call CriWare.CriFsUtility::BindCpk(CriFsBinder, CriFsBinder, string) instead of this function.

It is also possible to bind the CPK file on the network by specifying a URL in the path.

// crimot.comのsample.cpkをバインド
CriFsLoadFileRequest request = CriFsUtility.LoadFile(
 "http://crimot.com/sdk/sampledata/crifilesystem/sample.cpk");

Note:

CPK content information is acquired only at the time of binding.
Therefore, when you bind a CPK file on the network, even if the file is updated on the server side, the update cannot be detected on the client side.
(There may be an unintended access to the updated CPK file.)

Example:

This sample code shows how to load the content in the CPK file using the CriWare.CriFsUtility::BindCpk and CriWare.CriFsUtility::LoadFile functions.

private CriFsBinder binder = null;   // バインダ
private uint bindId = 0;             // バインドID

void OnEnable()
{
 // バインダの作成
 this.binder = new CriFsBinder();
}

void OnDisable()
{
 // アンバインド処理の実行
 if (this.bindId > 0) {
     CriFsBinder.Unbind(this.bindId);
     this.bindId = 0;
 }

 // バインダの破棄
 this.binder.Dispose();
 this.binder = null;
}

IEnumerator UserLoadFileFromCpk(string cpk_path, string content_path)
{
 // CPKファイルのバインドを開始
 CriFsBindRequest bind_request = CriFsUtility.BindCpk(this.binder, cpk_path);

 // バインドの完了を待つ
 yield return bind_request.WaitForDone(this);

 // エラーチェック
 if (bind_request.error != null) {
     // エラー発生時の処理
     …
     yield break;
 }

 // CPK内のコンテンツの読み込みを開始
 CriFsLoadFileRequest load_request = CriFsUtility.LoadFile(this.binder, content_path);

 // 読み込み完了を待つ
 yield return load_request.WaitForDone(this);

 // エラーチェック
 if (load_request.error != null) {
     // エラー発生時の処理
     …
     yield break;
 }

 // 備考）ロードされたファイルの内容は request.bytes 内に格納されています。
}

See also

CriFsBindRequest, CriFsUtility::BindCpk(CriFsBinder, CriFsBinder, string)

static CriFsBindRequest BindCpk ( CriFsBinder  targetBinder, CriFsBinder  srcBinder, string  srcPath  )

inlinestatic

Start binding the CPK file.

Parameters

targetBinder	Binder to be bound
srcBinder	A binder to access the CPK file to bind
srcPath	CPK file path

Returns

CriFsBindRequest

Description:

Start binding the CPK file.
In addition to CriWare.CriFsUtility::BindCpk(CriFsBinder, string) , you can specify the binder to access to the sub CPK in the CPK file.

This function returns immediately.
You should check CriWare.CriFsBindRequest::isDone to check the completion of the binding.
If an error occurs during the binding process, the error information is stored in CriWare.CriFsBindRequest::error .

See also

CriFsBindRequest, CriFsUtility::BindCpk(CriFsBinder, string)

static CriFsBindRequest BindDirectory ( CriFsBinder  targetBinder, string  srcPath  )

inlinestatic

Starts binding the directory path.

Parameters

targetBinder	Binder to be bound
srcPath	Path name of the directory to be bound

Description:

Binds the directory pathname.

This function returns immediately.
You should check CriWare.CriFsBindRequest::isDone to check the completion of the binding.
If an error occurs during the binding process, the error information is stored in CriWare.CriFsBindRequest::error .

When binding the directory under the StreamingAssets folder, prepend CriWare::Common::streamingAssetsPath to the file path.

Note:

The system does not check whether the directory exists at the time of binding.
Only the directory path is retained in the binder; it does not open the files in the specified directory.

Note:

This function is a debug function for development support.
If you use this function, the following problems may occur.

• Functions CriWare.CriFsLoader::Load or CriWare.CriFsBinder::GetFileSize may block for a long time.
  
• When accessing files in the bound directory, stream playback of sound or movie is interrupted.
  

Note:

Be careful not to use this function in the application when final release.
(Convert the data in the directory to a CPK file and bind it using the CriWare.CriFsUtility::BindCpk function, or bind all the files in the directory using the CriWare.CriFsUtility::BindFile function.)

See also

CriFsBindRequest, CriFsUtility::BindCpk, CriFsUtility::BindFile

static CriFsBindRequest BindDirectory ( CriFsBinder  targetBinder, CriFsBinder  srcBinder, string  srcPath  )

inlinestatic

Starts binding the directory path.

Parameters

targetBinder	Binder to be bound
srcBinder	The binder to access the directory to be bound
srcPath	CPK file path

Returns

CriFsBindRequest

Description:

Begins binding the directory path.
In addition to CriWare.CriFsUtility::BindDirectory(CriFsBinder, string), you can specify the binder to access the directory in the CPK file.

This function returns immediately.
You should check CriWare.CriFsBindRequest::isDone to check the completion of the binding.
If an error occurs during the binding process, the error information is stored in CriWare.CriFsBindRequest::error .

See also

CriFsBindRequest, CriFsUtility::BindDirectory(CriFsBinder, string)

static CriFsBindRequest BindFile ( CriFsBinder  targetBinder, string  srcPath  )

inlinestatic

Binds the file.

Parameters

targetBinder	Binder to be bound
srcPath	The path name of the file to be bound

Returns

Bind ID

Description:

Starts binding the file.

This function returns immediately.
You should check CriWare.CriFsBindRequest::isDone to check the completion of the binding.
If an error occurs during the binding process, the error information is stored in CriWare.CriFsBindRequest::error .

When binding the files under the StreamingAssets folder, prepend CriWare::Common::streamingAssetsPath to the file path.

Note:

This function is used when you want to get only the file size without loading the file.
It is possible to get the file size asynchronously by calling the CriWare.CriFsBinder::GetFileSize function after binding the file.

Example:

This sample code shows how to get the file size using the CriWare.CriFsUtility::BindFile and CriWare.CriFsBinder::GetFileSize functions.

IEnumerator UserGetFileSize(string path, out long fileSize)
{
 // ファイルのバインドを開始
 CriFsBindRequest bind_request = CriFsUtility.BindFile(path);

 // バインドの完了を待つ
 yield return bind_request.WaitForDone(this);

 // エラーチェック
 if (bind_request.error != null) {
     // エラー発生時の処理
     …
     yield break;
 }

 // ファイルサイズの取得
 fileSize = bind_request.binder.GetFileSize();
}

See also

CriFsBindRequest, CriFsBinder::GetFileSize

static CriFsBindRequest BindFile ( CriFsBinder  targetBinder, CriFsBinder  srcBinder, string  srcPath  )

inlinestatic

Starts binding files.

Parameters

targetBinder	Binder to be bound
srcBinder	The binder to access the file to be bound
srcPath	File path

Returns

CriFsBindRequest

Description:

Starts binding files.
In addition to CriWare.CriFsUtility::BindFile(CriFsBinder, string), you can specify the binder to access to the files in the CPK file.

This function returns immediately.
You should check CriWare.CriFsBindRequest::isDone to check the completion of the binding.
If an error occurs during the binding process, the error information is stored in CriWare.CriFsBindRequest::error .

See also

CriFsBindRequest, CriFsUtility::BindFile(CriFsBinder, string)

static void SetUserAgentString ( string  userAgentString )

inlinestatic

Specifies the User-Agent string used in HTTP requests.

Parameters

userAgentString

User-Agent character

Description:

Specifies the User-Agent string used in HTTP requests.
If not specified, the version character of the lower file system module is specified.
Specify the User-Agent string using up to 255 characters ((255 bytes).

static void SetProxyServer ( string  proxyPath, UInt16  proxyPort  )

inlinestatic

Specifies the proxy server used for HTTP requests.

Parameters

proxyPath	Proxy server address
proxyPort	Proxy server port number

Description:

Specifies the proxy server address to be used for HTTP request of HTTP I/O.
Specify proxyPath using up to 256 characters.

static void SetPathSeparator ( string  filter )

inlinestatic

Specifies the path separator

Parameters

filter

A list of characters used as a separator

Description:

Changes the character that the CRI File System library interprets as a separator.
By default, the three characters ",", "\\t", and "\\n" are treated as a separator.
For filter, specify a string that contains a list of characters to be used as a separator.
For example, if you specify "@+-*", four types of characters "@", "+", "-", and "*" are treated as a separator.
If you specify an empty string ("") for filter, the separator will be disabled. If you specify null, the setting returns to the default.

Note:

If you pass the path including the separator specified in this function to the plug-in function, it is treated as an invalid path internally and the path after the separator is invalid.
When handling the path including ",", "\\t" or "\\n" in the application, it is necessary to change it to a separator in advance using this function.

Variable Documentation

const int DefaultReadUnitSize = (1024 * 1024)

The default read unit size for each loading request.

Description:

The default for the last argument of each load request.

See also

CriWare.CriFsUtility::LoadFile, CriWare.CriFsUtility::LoadAssetBundle, CriWare.CriFsUtility::LoadAssetBundle

Properties

DoneDelegate doneDelegate

getprotected set

Delegate when processing is complete.

Description:

This parameter is used to determine whether asynchronous processing has completed.
During asynchronous processing, the value of isDone is false.
Once asynchronous processing is complete, the value of isDone is true.

bool isDone

get

Whether the processing is complete.

Description:

This parameter is used to determine whether asynchronous processing has completed.
During asynchronous processing, the value of isDone is false.
Once asynchronous processing is complete, the value of isDone is true.

string error

getprotected set

Error information.

Description:

A parameter to check whether an error occurred during asynchronous process.
If the asynchronous process completes successfully, the value of error is null.
If an error occurs during asynchronous process, the error information is stored.

bool isDisposed

getprotected set

Discard information.

Description:

A parameter to check if the request was discarded.

string path

get

The path to the file to be loaded.

Description:

The path to the file to be loaded.
The path specified when calling the CriWare.CriFsUtility::LoadFile function is stored.

See also

CriFsUtility::LoadFile

byte [] bytes

get

A buffer that stores load result.

Description:

A buffer that stores the load result.
If the loading process is stopped using the CriWare.CriFsLoadFileRequest::Stop function or if an error occurs during loading, the value is null.

string path

get

The path to the Asset Bundle file to be loaded.

Description:

The path to the Asset Bundle file to be loaded.
The path specified when calling the CriWare.CriFsUtility::LoadAssetBundle function is stored.

See also

CriFsUtility::LoadAssetBundle

AssetBundle assetBundle

get

The Asset Bundle that is the result of loading.

Description:

An instance of Asset Bundle that stores the loading result.
If the loading process is stopped using the CriWare.CriFsLoadFileRequest::Stop function or if an error occurs during loading, the value is null.

string sourcePath

getprotected set

Installation source file path.

Description:

The file path of the installation source.
The path specified when calling the CriWare.CriFsUtility::Install function is stored.

See also

CriFsUtility::LoadAssetBundle

string destinationPath

getprotected set

Installation destination file path.

Description:

The file path of the installation destination.
The path specified when calling the CriWare.CriFsUtility::Install function is stored.

See also

CriFsUtility::LoadAssetBundle

float progress

getprotected set

The progress of the installation process.

Returns

Progress status

Description:

Gets the progress of the process.
Progress is a 32 bit floating point number in the range of 0.0 to 1.0.

When the process is stopped using the CriWare.CriFsInstallRequest::Stop function, the progress at the time of the stop is saved.
If an error occurs during the installation process, the value is negative.
The value is updated when the buffer of size CriWareInitializer.fileSystemConfig.installBufferSize is filled.
If the size of the installation buffer is too large, the value is updated less frequently, even though the installation is advancing.
Be careful about the size of the installation buffer when performing timeout processing etc.

string path

get

The path of the file to be bound.

Description:

The path of the file to bind.
The path specified when calling the CriWare.CriFsUtility::BindCpk function etc. is stored.

See also

CriFsUtility::BindCp, CriFsUtility::BindFile, CriFsUtility::BindDirectory

uint bindId

get

The ID which identifies the binding process.

Description:

The ID which identifies the binding process.
It is used to release only a specific binding after multi-binding.

See also

CriFsBinder::Unbind