ES3File Constructor

public ES3File ES3File(string filePath, ES3Settings settings, bool syncWithFile)

Description

Creates a new ES3File object and loads a file from storage into it, unless syncWithFile is set to false.

If the file does not exist in storage, or syncWithFile is false, an empty ES3File will be returned.

Parameters

filePath [Optional] The relative or absolute path of the file this ES3File represents in storage.

settings

[Optional] The settings we want to use to override the default settings.

syncWithFile

[Optional] Whether we should sync this ES3File with the one in storage immediately after creating it. Default is true."

Returns

An ES3File object containing the data of a file in storage, or an empty ES3File if no file was found in storage or syncWithFile is set to false.

Examples

C#

JS