Unity - Scripting API: iOS.Xcode.PBXProject.AddShellScriptBuildPhase (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.
Close
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.
Close
Your name Your email Suggestion*
Cancel
Declaration
public string AddShellScriptBuildPhase(string targetGuid, string name, string shellPath, string shellScript);
Parameters
Parameter | Description |
---|---|
targetGuid | The GUID of the target, such as the one returned by TargetGuidByName. |
name | The name of the phase. |
shellPath | The shell path. |
shellScript | The shell script. |
Returns
string Returns the GUID of the new phase.
Description
Creates a new copy shell script phase for a given target.
If a shell script build phase with the same name, shellPath
, and shellScript
is already configured for the target, the function returns the existing phase. The new phase is placed at the end of the list of build phases configured for the target.
Declaration
public string AddShellScriptBuildPhase(string targetGuid, string name, string shellPath, string shellScript, List inputPaths);
Parameters
Parameter | Description |
---|---|
targetGuid | The GUID of the target, such as the one returned by TargetGuidByName. |
name | The name of the phase. |
shellPath | The shell path. |
shellScript | The shell script. |
inputPaths | The shell script input dependencies. |
Returns
string Returns the GUID of the new phase.
Description
Creates a new copy shell script phase for a given target.
If a shell script build phase with the same name, shellPath
, shellScript
, and inputPaths
is already configured for the target, the function returns the existing phase. The new phase is placed at the end of the list of build phases configured for the target.
using UnityEditor; using System.Collections.Generic; using System.IO; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode;
public class Sample_AddShellScriptBuildPhase
{
[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 of the target you want to add the Shell Script Phase to
string mainTargetGuid = pbxProject.GetUnityMainTargetGuid();
// Add the Shell Script Phase to that target
pbxProject.AddShellScriptBuildPhase(mainTargetGuid, "exampleScript1", "", "echo exampleCommand1");
// Optionally, add the Phase with [Input](Input.html) Files listed
pbxProject.AddShellScriptBuildPhase(mainTargetGuid, "exampleScript2", "", "echo exampleCommand2", new List<string>() { "InputFile1" });
// Apply changes to the pbxproj file
pbxProject.WriteToFile(projectPath);
}
}