Version: 2022.2
LanguageEnglish
  • C#

XcScheme

class in UnityEditor.iOS.Xcode

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 <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Represents an Xcode scheme (xcscheme file).

#if UNITY_IOS
string schemePath = pathToBuiltProject + "/Unity-iPhone.xcodeproj/xcshareddata/xcschemes/Unity-iPhone.xcscheme";

var xcscheme = new XcScheme(); xcscheme.ReadFromFile(schemePath);

xcscheme.SetMetalValidationOnRun(XcScheme.MetalValidation.Extended); xcscheme.SetFrameCaptureModeOnRun(XcScheme.FrameCaptureMode.Metal); xcscheme.AddArgumentPassedOnLaunch("--myarg = 1");

xcscheme.WriteToFile(schemePath); #endif

Constructors

XcSchemeCreates a new instance of the XcScheme class.

Public Methods

AddArgumentPassedOnLaunchAdds command line arguments to be passed on launch.
GetBuildConfigurationReturns the build configuration used for running.
ReadFromFileReads the scheme from a file identified by the given path.
ReadFromStreamReads the scheme from the given text reader.
ReadFromStringReads the scheme from the given string.
SetBuildConfigurationSets the build configuration to be used for running.
SetDebugExecutableSets the **Debug executable** toggle in the scheme.
SetFrameCaptureModeOnRunSets whether frame capture should be enabled.
SetMetalValidationOnRunSets the **Metal API Validation** option in the scheme.
WriteToFileWrites the scheme contents to the specified file.
WriteToStreamWrites the scheme contents to the specified text writer.
WriteToStringWrites the contents of the scheme to a string.