Unity - Scripting API: iOS.Xcode.PBXProject.AddRemotePackageFrameworkToProject (original) (raw)

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Submission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Your name Your email Suggestion*

Cancel

Declaration

public void AddRemotePackageFrameworkToProject(string targetGuid, string name, string packageGuid, bool weak);

Parameters

Parameter	Description
targetGuid	The GUID of the target, such asthe one returned by TargetGuidByName.
name	The name of the remote package.
packageGuid	The GUID of the remote package reference.
weak	Whether to set the framework as optional (i.e. weakly linked). When this is true, it means the framework is optional. When this is false, it means the framework is required.

Description

Adds a remote package framework dependency for the specified target.

using UnityEditor; using System.IO; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode;

public class Sample_AddRemotePackageFrameworkToProject
{ [PostProcessBuild] public static void OnPostprocessBuild(BuildTarget buildTarget, string pathToBuiltProject) {

    // Stop processing if build target is not [iOS](PlayerSettings.iOS.html)
    if (buildTarget != [BuildTarget.iOS](BuildTarget.iOS.html))
        return;

    // Initialize [PBXProject](iOS.Xcode.PBXProject.html)
    string projectPath = [PBXProject.GetPBXProjectPath](iOS.Xcode.PBXProject.GetPBXProjectPath.html)(pathToBuiltProject);
    [PBXProject](iOS.Xcode.PBXProject.html) pbxProject = new [PBXProject](iOS.Xcode.PBXProject.html)();
    pbxProject.ReadFromFile(projectPath);

    // Get the GUID you want to add the package to
    string mainTargetGuid = pbxProject.GetUnityMainTargetGuid();

    // Get the remote package GUID
    string packageGuid = pbxProject.AddRemotePackageReferenceAtVersionUpToNextMinor("https://github.com/apple/swift-system.git", "1.1.0");

    // Add the [Remote](tvOS.Remote.html) [Package](Unity.Android.Gradle.Manifest.Package.html) to the Xcode project
    pbxProject.AddRemotePackageFrameworkToProject(pbxProject.GetUnityMainTargetGuid(), "SystemPackage", packageGuid, false);
  
    // Apply changes to the pbxproj file
    pbxProject.WriteToFile(projectPath);
}

}