BuildPipeline
API for building Players or content builds.
Read time 1 minuteLast updated 6 days ago
Definition
- Type: Class
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
public class BuildPipeline
Remarks
The BuildPipeline class in the Unity Editor namespace provides tools to build Players and create content directory or AssetBundle builds. AssetBundles can be loaded from external sources such as the web, enhancing the flexibility and scalability of content delivery in Unity applications. The class contains several static properties and methods to facilitate building workflows.
Additional Resources: AssetBundles, Build Player Pipeline
Static Properties
Property | Description |
|---|---|
| isBuildingPlayer | Checks whether Unity is actively building a Player or a content build. |
Static Methods
Method | Description |
|---|---|
| BuildAssetBundles | Build AssetBundles from a building map. |
| BuildCanBeAppended | Checks if Unity can append the build. |
| BuildContentDirectory | Builds a content directory (serialized assets and scenes plus a manifest) at a defined output path. |
| BuildPlayer | Builds a Player. These overloads are still supported, but will be replaced. Please use BuildPlayer(BuildPlayerOptions buildPlayerOptions) and BuildPlayer(BuildPlayerWithProfileOptions buildPlayerWithProfileOptions) instead. |
| CleanBuildCache | Clears cached unified content-build data so the next build recomputes it. |
| GetBuildTargetGroup | Given a BuildTarget will return the BuildTargetGroup for the build target platform. |
| GetBuildTargetName | Given a BuildTarget will return the well known string representation for the build target platform. |
| GetCRCForAssetBundle | Extract the CRC checksum for the given AssetBundle. |
| GetHashForAssetBundle | Extract the hash for the given AssetBundle. |
| GetPlaybackEngineDirectory | Returns the path of a player directory. For ex., Editor\Data\PlaybackEngines\AndroidPlayer. |
| GetPlayerConnectionInitiateMode | Returns the mode currently used by players to initiate a connect to the host. |
| IsBuildTargetSupported | Returns true if the specified build target is currently available in the Editor. |