Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

BuildPipeline.BuildPlayer

public static method BuildPlayer(buildPlayerOptions: BuildPlayerOptions): Build.Reporting.BuildReport;

Parameters

buildPlayerOptionsProvide various options to control the behavior of BuildPipeline.BuildPlayer.

Returns

BuildReport A BuildReport giving build process information.

Description

Builds a player.

Use this function to programatically create a build of your project. Note that any references to GameObjects acquired in the editor script before the BuildPlayer call will be invalid after it and will need to be reacquired.

no example available in JavaScript

public static method BuildPlayer(levels: string[], locationPathName: string, target: BuildTarget, options: BuildOptions): Build.Reporting.BuildReport;
public static method BuildPlayer(levels: EditorBuildSettingsScene[], locationPathName: string, target: BuildTarget, options: BuildOptions): Build.Reporting.BuildReport;

Parameters

levelsThe scenes to be included in the build. If empty, the currently open scene will be built. Paths are relative to the project folder (Assets/MyLevels/MyScene.unity).
locationPathNameThe path where the application will be built.
targetThe BuildTarget to build.
optionsAdditional BuildOptions, like whether to run the built player.

Returns

BuildReport An error message if an error occurred.

Description

Builds a player. These overloads are still supported, but will be replaced. Please use BuildPlayer (BuildPlayerOptions buildPlayerOptions) instead.

Did you find this page useful? Please give it a rating: