Version: 2022.3
LanguageEnglish
  • C#

CompilationPipeline

class in UnityEditor.Compilation

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

Methods and properties for script compilation pipeline.

Static Properties

codeOptimizationCurrent code optimization mode.

Static Methods

AssemblyDefinitionReferenceGUIDToGUIDConverts an assembly definition file GUID reference to a GUID string.
GetAssembliesGet all script assemblies compiled by Unity filtered by AssembliesType.
GetAssemblyDefinitionFilePathFromAssemblyNameReturns the assembly definition file path from an assembly name. Returns null if there is no assembly definition file for the given assembly name.
GetAssemblyDefinitionFilePathFromAssemblyReferenceReturns the assembly definition file path for an Assembly Definition File GUID or assembly name reference. Returns null if there is no assembly definition file for the given assembly reference.
GetAssemblyDefinitionFilePathFromScriptPathReturns the assembly definition file path for a source (script) path. Returns null if there is no assembly definition file for the given script path.
GetAssemblyDefinitionPlatformsReturns all the platforms supported by assembly definition files.Additional resources: AssemblyDefinitionPlatform.
GetAssemblyDefinitionReferenceTypeUtility method to determine whether an Assembly Definition File reference is a GUID reference or an assembly name reference.
GetAssemblyNameFromScriptPathReturns the assembly name for a source (script) path. Returns null if there is no assembly name for the given script path.
GetAssemblyRootNamespaceFromScriptPathGets the root namespace associated with the given script path.
GetDefinesFromAssemblyNameLists all the #define directives used to compile the specified assembly.
GetPrecompiledAssemblyNamesGet all precompiled assembly names.
GetPrecompiledAssemblyPathFromAssemblyNameReturns the Assembly file path from an assembly name. Returns null if there is no Precompiled Assembly name match.
GetPrecompiledAssemblyPathsReturns the paths to the precompiled assemblies which are included when building editor assemblies and match any of the given PrecompiledAssemblySources.
GetResponseFileDefinesFromAssemblyNameLists all the #define directives used to compile the specified assembly, that is from a Response File.
GetSystemAssemblyDirectoriesUse this to get a list of directories containing system references for the specific ApiCompatibilityLevel.
GUIDToAssemblyDefinitionReferenceGUIDConverts the given GUID to an assembly definition file GUID reference.
IsDefineConstraintsCompatibleAllows you to test whether the specified #define constraints are satisfied by the specified list of #define directives.
ParseResponseFileRetrieves the ResponseFileData describing the content of the response file.
RequestScriptCompilationAllows you to request that the Editor recompile scripts in the project.

Events

assemblyCompilationFinishedAn event that is invoked on the main thread when compilation of an assembly finishes.
assemblyCompilationNotRequiredAn event that is invoked on the main thread when an assembly does not require compilation.
assemblyCompilationStartedAn event that is invoked on the main thread when the assembly build starts.
codeOptimizationChangedThis event triggers whenever the codeOptimization property changes between Debug and Release modes.
compilationFinishedAn event that is invoked on the main thread when the compilation of assemblies finishes.
compilationStartedAn event that is invoked on the main thread when the compilation of assemblies starts.