Class WebBuildReport

Manages all files and build settings of a web build.

Inheritance

object

WebBuildReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Web.Stripping.Editor

Assembly: Unity.Web.Stripping.Editor.dll

Syntax

[Serializable]
public class WebBuildReport

Remarks

All path properties use absolute paths.

Constructors

WebBuildReport()

Default constructor.

Declaration

public WebBuildReport()

Fields

AdditionalFiles

Additional files are files that, for example, submodule stripping or submodule profiling instrumentation might add to to the build folder. Files that are prerequisites for these operations are not considered additional files.

Declaration

public List<string> AdditionalFiles

Field Value

Type	Description
List<string>

FrameworkBackupFilePath

Optional: Path to the backup JavaScript framework file. This file is created when a build is instrumented for profiling.

Declaration

public string FrameworkBackupFilePath

Field Value

Type	Description
string

FrameworkFilePath

Path to the JavaScript framework file.

Declaration

public string FrameworkFilePath

Field Value

Type	Description
string

HasSubmoduleProfiling

Is true when the build was instrumented for submodule profiling.

Declaration

public bool HasSubmoduleProfiling

Field Value

Type	Description
bool

LastModifiedAtUniversal

Timestamp when build was last modified as string in universal time format DateTime.ToUniversalTime().ToString().

Declaration

public string LastModifiedAtUniversal

Field Value

Type	Description
string

MethodMapFileName

The file name of our copy of the method map.

Declaration

public const string MethodMapFileName = "MethodMap.tsv"

Field Value

Type	Description
string

MethodMapFilePath

Path to the IL2CPP method map of this build.

Declaration

public string MethodMapFilePath

Field Value

Type	Description
string

Name

Display name of the build.

Declaration

public string Name

Field Value

Type	Description
string

OriginalPlayerSettingsFilePath

If SubmoduleStrippingBuildProcessor modified settings, the originals are here.

Declaration

public string OriginalPlayerSettingsFilePath

Field Value

Type	Description
string

OriginalWasmSize

Size of the original wasm file in bytes.

Declaration

public long OriginalWasmSize

Field Value

Type	Description
long

OutputPath

Root folder of build. for example, "D:/MyProject/Builds/MyBuild"

Declaration

public string OutputPath

Field Value

Type	Description
string

PlayerSettingFileName

The file name used to store the actual Player and build settings for the build.

Declaration

public const string PlayerSettingFileName = "player_settings.json"

Field Value

Type	Description
string

PlayerSettingsFilePath

Path to the Player settings file used for this build.

Declaration

public string PlayerSettingsFilePath

Field Value

Type	Description
string

StrippedWasmSize

Optional: Size of the stripped wasm file in bytes.

Declaration

public long StrippedWasmSize

Field Value

Type	Description
long

StrippingInfoFilePath

Optional: Path to the stripping_info.json file.

Declaration

public string StrippingInfoFilePath

Field Value

Type	Description
string

SymbolFilePath

Optional: Path to the external debug symbols file.

Declaration

public string SymbolFilePath

Field Value

Type	Description
string

WasmBackupFilePath

Optional: Path to the backup WebAssembly file. This file is created when a build is stripped or instrumented for profiling.

Declaration

public string WasmBackupFilePath

Field Value

Type	Description
string

WasmFilePath

Path to the WebAssembly file.

Declaration

public string WasmFilePath

Field Value

Type	Description
string

Properties

BuildPath

Path to build data inside build for example, "D:/MyProject/Builds/MyBuild/Build"

Declaration

public string BuildPath { get; }

Property Value

Type	Description
string

HasStrippingInfo

Is true when the build has a stripping info file.

Declaration

public bool HasStrippingInfo { get; }

Property Value

Type	Description
bool

IsValid

Returns true if the build at Path is a valid web build.

Declaration

public bool IsValid { get; }

Property Value

Type	Description
bool

LastModifiedAt

Timestamp when build was last modified.

Declaration

public DateTimeOffset LastModifiedAt { get; }

Property Value

Type	Description
DateTimeOffset

TemplateDataPath

Path to template data inside build for example, "D:/MyProject/Builds/MyBuild/TemplateData"

Declaration

public string TemplateDataPath { get; }

Property Value

Type	Description
string

Methods

CreateFromPath(string)

Create a web build report for a given path. Automatically updates all paths of a build. If the path is a relative path, it will be automatically converted to an absolute path.

Declaration

public static WebBuildReport CreateFromPath(string outputPath)

Parameters

Type	Name	Description
string	outputPath	For example, "D:/MyProject/Builds/MyBuild", "Builds/MyBuild"

Returns

Type	Description
WebBuildReport	The build report

GetBackupFolderPath()

Returns the folder path where this build's back-up files are stored.

Declaration

public string GetBackupFolderPath()

Returns

Type	Description
string	Absolute path to the back-up folder.

Remarks

Valid if OutputPath is valid and Update() has been called.

GetWebPlayerSettings()

Get the stored WebPlayerSettings for this build.

Declaration

public WebPlayerSettings GetWebPlayerSettings()

Returns

Type	Description
WebPlayerSettings	A WebPlayerSettings object with all settings that were used to create this build.

IsValidBuildPath(string)

Checks whether the "/Build" folder of a build contains the expected files.

Declaration

public static bool IsValidBuildPath(string buildPath)

Parameters

Type	Name	Description
string	buildPath	E.g. "Path/To/MyBuild/Build"

Returns

Type	Description
bool	True if build path is valid.

Restore()

Restores the build from its back-up files and removes any additional files we might have.

Declaration

public void Restore()

Update()

Reads the files from the build path and updates the fields accordingly.

Declaration

public void Update()