5.0 KiB
Start a build from a script
To start a build from another script, call the AddressableAssetSettings.BuildPlayerContent method.
Before starting the build, set the active Profile and the active build script. You can also set a different AddressableAssetSettings object than the default.
BuildPlayerContent takes into consideration the following information when performing the build:
AddressableAssetSettingsDefaultObjectActivePlayerDataBuilder- The
addressables_content_state.binfile.
Set the AddressableAssetSettings
The settings defined by AddressableAssetSettings include the list of groups and the profile to use.
To access the settings displayed in the Unity Editor (menu: Window > Asset Management > Addressables > Settings), use the static AddressableAssetSettingsDefaultObject.Settings property. However, if desired, you can use a different settings object for a build.
To load a custom settings object in a build:
[!code-cssample]
Set the active profile
A build started with BuildContent uses the variable settings of the active profile. To set the active profile as part of your customized build script, assign the ID of the desired profile to the activeProfileId field of the AddressableAssetSettingsDefaultObject.Settings object.
The AddressableAssetSettings object contains the list of profiles. Use the name of the desired profile to look up its ID value and then assign the ID to the activeProfileId variable:
[!code-cssample]
Set the active build script
The BuildContent method launches the build based on the current ActivePlayerDataBuilder setting. To use a specific build script, assign the index of the IDataBuilder object in the AddressableAssetSetting.DataBuilders list to the ActivePlayerDataBuilderIndex property.
The build script must be a ScriptableObject that implements IDataBuilder and you must add it to the DataBuilders list in the AddressableAssetSettings instance. Once added to the list, use the standard List.IndexOf method to get the index of the object.
[!code-cssample]
Launch a build
After setting the profile and builder to use, you can launch the build:
[!code-cssample]
To check for success, use BuildPlayerContent(out AddressablesPlayerBuildResult result). result.Error contains any error message returned if the Addressables build failed. If string.IsNullOrEmpty(result.Error) is true, the build was successful.
Example script to launch build
The following example adds two menu commands to the Window > Asset Management > Addressables menu in the Editor. The first command builds the Addressable content using the preset profile and build script. The second command builds the Addressable content, and if it succeeds, builds the Player.
[!code-cssample]
If your build script makes setting changes that require a domain reload, you should run the build script using Unity command line options, instead of running it interactively in the Editor. Refer to Handle domain reloads for more information.