Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetGradleSettingsFile(string, GradleSettingsFile)

Sets a new settings.gradle file.
Read time 1 minuteLast updated 10 days ago

Definition

public void SetGradleSettingsFile(string path, GradleSettingsFile gradleSettings)

Parameters

path

string
The file path to place the 
settings.gradle
file at. This path is relative to the gradle project path.

gradleSettings

GradleSettingsFile
The representation of module 
settings.gradle
file.

Remarks

To use this method, you must also declare your new file in AndroidProjectFilesModifier.Setup using the AndroidProjectFilesModifierContext.AdditionalOutputs.AddGradleSettingsFile method.

Examples

using System.IO;using Unity.Android.Gradle;using UnityEditor.Android;public class ModifyProjectScript : AndroidProjectFilesModifier{    // Define the path to the Gradle settings file    private string _myLibGradleSettings = Path.Combine("unityLibrary", "customPlugin", "settings.gradle");    // Configure the required settings/outputs to modify the Android project files    public override AndroidProjectFilesModifierContext Setup()    {        var projectFilesContext = new AndroidProjectFilesModifierContext();        projectFilesContext.Outputs.AddGradleSettingsFile(_myLibGradleSettings);        return projectFilesContext;    }    //  Modify the Android project files    public override void OnModifyAndroidProjectFiles(AndroidProjectFiles projectFiles)    {        // Create an object representing a settings.gradle and set it as contents to unityLibrary/customPlugin/settings.gradle        var gradleSettingsFile = new GradleSettingsFile();        projectFiles.SetGradleSettingsFile(_myLibGradleSettings, gradleSettingsFile);    }}