Interface IFormaBuildCallbackReceiver

Interface to listen to build events.

Namespace: Unity.Industrial.Forma.Editor.Build

Syntax

public interface IFormaBuildCallbackReceiver

Properties

CallbackOrder

The first one executed is the one where CallbackOrder is returning the smallest number.

Declaration

int CallbackOrder { get; }

Property Value

Type	Description
Int32

Methods

OnEarlyPreBuildProcess(BuildProfile)

Called at the very beginning of the build process.

Declaration

void OnEarlyPreBuildProcess(BuildProfile buildProfile)

Parameters

Type	Name	Description
BuildProfile	buildProfile	BuildProfile

OnPostAddressableBuildProcess(AddressableAssetSettings, BuildProfile)

Called when the Addressable build process is done.

Declaration

void OnPostAddressableBuildProcess(AddressableAssetSettings settings, BuildProfile buildProfile)

Parameters

Type	Name	Description
AddressableAssetSettings	settings	Addressable Settings
BuildProfile	buildProfile	Build Profile

OnPostAddressableDefaultDataCatalogBuildProcess(AddressableAssetSettings, BuildProfile, CatalogMetadata)

Called after the Default Catalog Build process (this is typically the 'Default Local Group').

Declaration

void OnPostAddressableDefaultDataCatalogBuildProcess(AddressableAssetSettings settings, BuildProfile buildProfile, CatalogMetadata catalogMetadata)

Parameters

Type	Name	Description
AddressableAssetSettings	settings	Addressable Settings
BuildProfile	buildProfile	Build Profile
CatalogMetadata	catalogMetadata	Catalog Metadata

OnPostAddressableProductCatalogBuildProcess(AddressableAssetSettings, BuildProfile, ExportableProductCatalog, CatalogMetadata)

Called after every Product Catalog Build process.

Declaration

void OnPostAddressableProductCatalogBuildProcess(AddressableAssetSettings settings, BuildProfile buildProfile, ExportableProductCatalog productCatalog, CatalogMetadata catalogMetadata)

Parameters

Type	Name	Description
AddressableAssetSettings	settings	Addressable Settings
BuildProfile	buildProfile	Build Profile
ExportableProductCatalog	productCatalog	Catalog Product List
CatalogMetadata	catalogMetadata	Catalog Metadata

OnPostBuildProcess(BuildProfile, BuildReport)

Called when the build process is done.

Declaration

void OnPostBuildProcess(BuildProfile buildProfile, BuildReport buildReport)

Parameters

Type	Name	Description
BuildProfile	buildProfile	Build Profile
BuildReport	buildReport	Unity Build Report

OnPreAddressableBuildProcess(AddressableAssetSettings, BuildProfile, ref List<AnalyzeRule>)

Called when the Addressable build process is launched (before the Player build).

Declaration

void OnPreAddressableBuildProcess(AddressableAssetSettings settings, BuildProfile buildProfile, ref List<AnalyzeRule> aaRulesToRun)

Parameters

Type	Name	Description
AddressableAssetSettings	settings	Addressable Settings
BuildProfile	buildProfile	Build Profile
List<AnalyzeRule>	aaRulesToRun	Addressable Analyze Rules to run before doing the build.

OnPreAddressableDefaultDataCatalogBuildProcess(AddressableAssetSettings, BuildProfile, ref CatalogMetadata)

Called before the Default Catalog Build process (this is typically the 'Default Local Group').

Declaration

void OnPreAddressableDefaultDataCatalogBuildProcess(AddressableAssetSettings settings, BuildProfile buildProfile, ref CatalogMetadata catalogMetadata)

Parameters

Type	Name	Description
AddressableAssetSettings	settings	Addressable Settings
BuildProfile	buildProfile	Build Profile
CatalogMetadata	catalogMetadata	Catalog Metadata

OnPreAddressableProductCatalogBuildProcess(AddressableAssetSettings, BuildProfile, ref ExportableProductCatalog, ref CatalogMetadata)

Called before every Product Catalog Build process.

Declaration

void OnPreAddressableProductCatalogBuildProcess(AddressableAssetSettings settings, BuildProfile buildProfile, ref ExportableProductCatalog productCatalog, ref CatalogMetadata catalogMetadata)

Parameters

Type	Name	Description
AddressableAssetSettings	settings	Addressable Settings
BuildProfile	buildProfile	Build Profile
ExportableProductCatalog	productCatalog	Catalog Product List
CatalogMetadata	catalogMetadata	Catalog Metadata

OnPreBuildProcess(BuildProfile)

Called when the build process is launched.

Declaration

void OnPreBuildProcess(BuildProfile buildProfile)

Parameters

Type	Name	Description
BuildProfile	buildProfile	BuildProfile