Class SubmoduleStrippingSettings

An asset for configuring submodule stripping settings.

Inheritance

object

Object

ScriptableObject

SubmoduleStrippingSettings

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.Web.Stripping.Editor

Assembly: Unity.Web.Stripping.Editor.dll

Syntax

[CreateAssetMenu(fileName = "SubmoduleStrippingSettings", menuName = "Web Optimization/Submodule Stripping Settings")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.web.stripping-tool@1.0/manual/submodule-reference.html")]
public class SubmoduleStrippingSettings : ScriptableObject

Fields

MissingSubmoduleErrorHandling

The error handling behavior when a stripped submodule is used.

Declaration

[Tooltip("The error handling behavior when a stripped submodule is used. The usage of a stripped submodule can be ignored, logged to the browser console, or thrown as an exception.")]
public MissingSubmoduleErrorHandlingType MissingSubmoduleErrorHandling

Field Value

Type	Description
MissingSubmoduleErrorHandlingType

OptimizeCodeAfterStripping

Run code optimization to reduce final build size and improve performance. Increases the stripping time significantly. Use on release builds.

Declaration

[Tooltip("Run code optimization to reduce final build size and improve performance. Increases the stripping time significantly. Use on release builds.")]
public bool OptimizeCodeAfterStripping

Field Value

Type	Description
bool

RemoveEmbeddedDebugSymbols

Remove embedded debug symbols after stripping. Debug symbols are required to identify functions during stripping but they increase the size of WebAssembly files. Use on release builds if debug symbols are not required for other use cases.

Declaration

[Tooltip("Remove embedded debug symbols after stripping. Debug symbols are required to identify functions during stripping, but they increase the size of WebAssembly files. Use on release builds if debug symbols are not required for other uses cases.")]
public bool RemoveEmbeddedDebugSymbols

Field Value

Type	Description
bool

RootMenuName

The root menu name used for various menu items.

Declaration

public const string RootMenuName = "Web Optimization"

Field Value

Type	Description
string

SubmodulesToStrip

The list of submodules to strip from a build.

Declaration

[Tooltip("The list of submodules to strip from a build.")]
public List<string> SubmodulesToStrip

Field Value

Type	Description
List<string>

Methods

Create(string)

Creates a settings asset.

Declaration

public static SubmoduleStrippingSettings Create(string assetPath)

Parameters

Type	Name	Description
string	assetPath	Note that the final name can be different if an asset with the same name already exists.

Returns

Type	Description
SubmoduleStrippingSettings	The created asset.

Save()

Save changes to the settings to disk.

Declaration

public void Save()

Events

ValuesChanged

Raised when the values of the settings are changed.

Declaration

public event Action ValuesChanged

Event Type

Type	Description
Action