class in UnityEditor.iOS.Xcode
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.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseRepresents an Xcode project (pbxproj file).
using System.Collections; using System.Collections.Generic; using System.IO; using UnityEngine; using UnityEditor; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode;
public class Sample_PBXProject { [PostProcessBuild] public static void OnPostprocessBuild(BuildTarget buildTarget, string pathToBuiltProject) { // Stop processing if build target is not iOS if (buildTarget != BuildTarget.iOS) return;
// Initialize PBXProject string projectPath = PBXProject.GetPBXProjectPath(pathToBuiltProject); PBXProject pbxProject = new PBXProject(); pbxProject.ReadFromFile(projectPath);
// Perform any modifications you want to the PBXProject
// Get the target GUID string mainTargetGuid = pbxProject.GetUnityMainTargetGuid();
// Add a new build configuration and add a new property to it string configName = "exampleConfig"; pbxProject.AddBuildConfig(configName); string configGuid = pbxProject.BuildConfigByName(mainTargetGuid, configName); pbxProject.AddBuildPropertyForConfig(configGuid, "exampleProperty", "exampleValue");
// Add a new file to project and to build list string filePath = Path.Combine(Application.dataPath, "Resources/InputFile.txt"); string fileGuid = pbxProject.AddFile(filePath, "Resources/InputFile.txt"); pbxProject.AddFileToBuild(mainTargetGuid, fileGuid);
// Add frameworks to the project pbxProject.AddFrameworkToProject(mainTargetGuid, "CoreBluetooth.framework", false); pbxProject.AddFrameworkToProject(mainTargetGuid, "MapKit.framework", true);
// Apply changes to the pbxproj file pbxProject.WriteToFile(projectPath); }
}
unityPostprocessTargetPhonyBuildPhaseName | The name of the placeholder build phase, which Unity adds to indicate a place to add post-processing actions. |
PBXProject | Creates a new instance of PBXProject class. |
AddAssetTagForFile | Adds an asset tag for the given file. |
AddAssetTagToDefaultInstall | Adds the asset tag to the list of tags to download during initial installation. |
AddBuildConfig | Creates a new set of build configurations for all targets in the project. |
AddBuildProperty | Adds a value to the build property list in all the build configurations for the specified target(s). |
AddBuildPropertyForConfig | Adds a value to build property list of the given build configuration(s). |
AddCapability | Adds a target capability to the Xcode project. |
AddCopyFilesBuildPhase | Creates a new Copy Files build phase for a given target. |
AddCopyFilesBuildPhaseBeforeTargetPostprocess | Creates a new Copy Files build phase for a given target. |
AddFile | Adds a new file reference to the list of known files. |
AddFileToBuild | Configure a file to build for the given native target. |
AddFileToBuildSection | Configures file for building for the given native target on specific build section. |
AddFileToBuildWithFlags | Configure a file for building for the given target with specific compiler flags. |
AddFolderReference | Adds a new folder reference to the list of known files. |
AddFrameworksBuildPhase | Creates a new frameworks build phase for given target. |
AddFrameworkToProject | Adds a system framework dependency for the specified target. |
AddHeadersBuildPhase | Creates a new headers build phase for a given target. |
AddKnownRegion | Adds the provided regions to the Xcode Project. |
AddLocaleVariantFile | Adds Locale to Variant Group of Xcode Project for iOS platform. |
AddPublicHeaderToBuild | Configures a file for building for the given native target as a public header. |
AddRemotePackageFrameworkToProject | Adds a remote package framework dependency for the specified target. |
AddRemotePackageReferenceAtBranch | Adds a reference to the remote package at the given branch. |
AddRemotePackageReferenceAtRevision | Adds a reference to the remote package at the given revision. |
AddRemotePackageReferenceAtVersion | Adds a reference to the remote package at the given version. |
AddRemotePackageReferenceAtVersionUpToNextMajor | Adds a reference to the remote package at the given version and allows updates up to the next major version. |
AddRemotePackageReferenceAtVersionUpToNextMinor | Adds a reference to the remote package at the given version and allows updates up to the next minor version. |
AddRemotePackageReferenceWithVersionRange | Adds a reference to the remote package and allows updates in the given version range. |
AddResourcesBuildPhase | Creates a new resources build phase for a given target. |
AddShellScriptBuildPhase | Creates a new copy shell script phase for a given target. |
AddShellScriptBuildPhaseBeforeTargetPostprocess | Creates a new copy shell script phase for a given target. |
AddSourcesBuildPhase | Creates a new sources build phase for a given target. |
AddTarget | Creates a new native target. |
AddTargetDependency | Creates a dependency between this target and another target. The other target may be in a different project. |
BuildConfigByName | Returns the GUID of build configuration with the given name for the specific target. |
BuildConfigNames | Returns the names of the build configurations available in the project. |
ClearKnownRegions | Removes the deprecated regions that get added automatically in Xcode Project. |
ContainsFileByProjectPath | Checks if the project contains a file with the given project path. |
ContainsFileByRealPath | Checks if the project contains a file with the given physical path. |
ContainsFramework | Checks whether the given system framework is a dependency of a target. |
FindFileGuidByProjectPath | Finds a file with the given project path in the project. |
FindFileGuidByRealPath | Finds a file with the given physical path in the project. |
GetAllBuildPhasesForTarget | Returns all build phases for the specified target. |
GetBaseReferenceForConfig | Gets the base configuration reference GUID for the specified build configuration. |
GetBuildPhaseName | Returns the name of the build phase with the specified GUID. |
GetBuildPhaseType | Returns the type of the build phase with the specified GUID. |
GetBuildPropertyForAnyConfig | Gets a build property value for the given name in all the build configurations for the specified target(s). If a property has multiple values, those are delimited by a space. |
GetBuildPropertyForConfig | Gets a build property value for the given name in the specified build configuration(s). If a property has multiple values they are delimited by a space. |
GetCompileFlagsForFile | Returns compile flags set for the specific file on a given target. |
GetCopyFilesBuildPhaseByTarget | Returns the GUID of matching copy files build phase for the given target. |
GetEntitlementFilePathForTarget | Returns the relative path to the entitlement file for the specified build target. |
GetFrameworksBuildPhaseByTarget | Returns the GUID of frameworks build phase for the given target. |
GetHeadersBuildPhaseByTarget | Returns the GUID of the headers build phase for the given target. |
GetRealPathsOfAllFiles | Return a list of all known files. |
GetResourcesBuildPhaseByTarget | Returns the GUID of resources build phase for the given target. |
GetShellScriptBuildPhaseForTarget | Returns the GUID of matching copy shell script build phase for the given target. |
GetSourcesBuildPhaseByTarget | Returns the GUID of sources build phase for the given target. |
GetTargetProductFileRef | Returns the file reference of the artifact created by building target. |
GetUnityFrameworkTargetGuid | Returns the GUID of the framework target in Unity project. |
GetUnityMainTargetGuid | Returns the GUID of the main target in Unity project. |
InsertCopyFilesBuildPhase | Creates a new copy files build phase for a given target. |
InsertShellScriptBuildPhase | Creates a new shell script build phase for a given target. |
ProjectGuid | Returns the GUID of the project. |
ReadFromFile | Reads the project from a file identified by the given path. |
ReadFromStream | Reads the project from the given text reader. |
ReadFromString | Reads the project from the given string. |
RemoveAssetTag | Removes an asset tag. |
RemoveAssetTagForFile | Removes an asset tag for the given file. |
RemoveAssetTagFromDefaultInstall | Removes the asset tag from the list of tags to download during initial installation. |
RemoveBuildConfig | Removes all build configurations with the given name from all targets in the project. |
RemoveFile | Removes the given file from project. |
RemoveFileFromBuild | Removes the given file from the list of files to build for the given target. |
RemoveFrameworkFromProject | Removes a system framework dependency for the specified target. |
ReplaceFile | Replaces a specified file with a new file. |
SetBaseReferenceForConfig | Sets the base configuration reference for the specified build configuration. |
SetBuildProperty | Sets a build property to the given value in all build configurations for the specified target(s). |
SetBuildPropertyForConfig | Sets a build property to the given value in the specified build configuration(s). |
SetCompileFlagsForFile | Sets the compilation flags for the given file in the given target. |
SetDevelopmentRegion | Sets the default language and region for the bundle in Xcode Project. |
SetTeamId | Sets the Team ID of an Xcode project. |
TargetGuidByName | Returns the GUID of the native target with the given name. |
UpdateBuildProperty | Adds and removes values from a build property in all build configurations for the specified target(s). |
UpdateBuildPropertyForConfig | Adds and removes values from a build property in the given build configuration. |
WriteToFile | Writes the project contents to the specified file. |
WriteToStream | Writes the project contents to the specified text writer. |
WriteToString | Writes the contents of the project to string. |
GetPBXProjectPath | Returns the path to PBX project in the given Unity build path. |
GetUnityTestTargetName | Returns the default test target name. |
IsBuildable | Checks if a file with the given extension can be built by Xcode. |
IsKnownExtension | Checks if files with the given extension are known to PBXProject. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.