AndroidProjectFilesModifier

Description

An abstract class that contains methods to modify custom Android Gradle project files during the build process.

Note: You can use this class to modify the Gradle project files that you set up in the modules other than the default unityLibrary and launcher Android Gradle modules. If you use this class to modify the contents of Android Gradle project files in the default modules, the build will fail.

This abstract class contains two callback methods: Setup and OnModifyAndroidProjectFiles. Unity calls Setup before the build begins and this method sets prerequisites for the build system. Unity calls OnModifyAndroidProjectFiles after it creates the Gradle project, which means all modifications you make in this method are applied directly to that project.

The generated files use Groovy syntax and all string-type properties use double quotes.

If your OnModifyAndroidProjectFiles callback depends on other files in the project (or on the local machine), or if you want the callback to produce new files, you must give this information to the build system in advance using Setup. The incremental build pipeline requires this information to know what files this callback produces and which files the callback depends on. This is so the build pipeline can identify when this step needs to run and when it can be skipped. The Setup method returns AndroidProjectFilesModifierContext. For more information, refer to AndroidProjectFilesModifierContext.

For information on when Unity invokes methods in this class, refer to How Unity builds Android applications.

In the Setup method, you can specify paths to the Gradle files that you want to create in your custom Gradle module. The following example demonstrates how you can specify these paths for the custom module mycustommodule and modify the values in build.gradle and AndroidManifest.xml files.

using System.IO;
using UnityEditor.Android;
using Unity.Android.Gradle;

public class ModifyProjectScript : AndroidProjectFilesModifier
{
    public override AndroidProjectFilesModifierContext Setup()
    {
        var ctx = new AndroidProjectFilesModifierContext();
        ctx.Outputs.AddBuildGradleFile("mycustommodule/build.gradle");
        ctx.Outputs.AddManifestFile("mycustommodule/src/main/AndroidManifest.xml");
        return ctx;
    }

    public override void OnModifyAndroidProjectFiles(AndroidProjectFiles projectFiles)
    {
        var customGradleFile = new ModuleBuildGradleFile();
        customGradleFile.Android.DefaultConfig.MinSdk.Set(28);
        projectFiles.SetBuildGradleFile("mycustommodule/build.gradle", customGradleFile);

        var customManifestFile = new AndroidManifestFile();
        customManifestFile.Manifest.Application.AddActivity("MyCustomActivity"); ;
        projectFiles.SetManifestFile("mycustommodule/src/main/AndroidManifest.xml", customManifestFile);
    }
}

Properties

Public Methods