Interface IBuildTarget

Build target interface

Namespace: Unity.Industrial.Forma.Editor.UI.Components

Syntax

[MovedFrom(true, "UnityEditor.Industrial.Configuring.UI", "Unity.Industrial.Configurator.Editor", null)]
public interface IBuildTarget

Properties

DisplayName

The Build target display name.

Declaration

string DisplayName { get; }

Property Value

Type	Description
String

SupportedBuildTarget

The Unity Supported Build target.

Declaration

SupportedBuildTarget SupportedBuildTarget { get; }

Property Value

Type	Description
SupportedBuildTarget

Methods

AddButtons(VisualElement)

Build target custom buttons.

Declaration

void AddButtons(VisualElement buttonContainer)

Parameters

Type	Name	Description
VisualElement	buttonContainer

AddSettings(VisualElement)

Build target custom UI settings.

Declaration

void AddSettings(VisualElement settings)

Parameters

Type	Name	Description
VisualElement	settings

BuildAsync(IDictionary<String, String>)

Build the target

Declaration

Task<bool> BuildAsync(IDictionary<string, string> configData)

Parameters

Type	Name	Description
IDictionary<String, String>	configData

Returns

Type	Description
Task<Boolean>

GetBuildActionsAsync()

Build target custom buttons.

Declaration

Task<IEnumerable<BuildAction>> GetBuildActionsAsync()

Returns

Type	Description
Task<IEnumerable<BuildAction>>	Build actions

Initialize(BuildProfile)

Initialize the build target with current build profile.

Declaration

void Initialize(BuildProfile buildProfile)

Parameters

Type	Name	Description
BuildProfile	buildProfile

PublishProductsAsync(Boolean, Boolean)

Publish products using product publishers.

Declaration

Task<bool> PublishProductsAsync(bool displayDialogue = true, bool showLogs = false)

Parameters

Type	Name	Description
Boolean	displayDialogue	Whether or not a prompt should show asking user to confirm whether or not they wish to publish
Boolean	showLogs	Whether or not information regarding publish process should be printed to the console

Returns

Type	Description
Task<Boolean>	True if operation was successful. False otherwise.

PublishRuntimeAsync(Boolean, Boolean)

Publish runtime using runtime publishers.

Declaration

Task<bool> PublishRuntimeAsync(bool displayDialogue = true, bool showLogs = false)

Parameters

Type	Name	Description
Boolean	displayDialogue	Whether or not a prompt should show asking user to confirm whether or not they wish to publish
Boolean	showLogs	Whether or not information regarding publish process should be printed to the console

Returns

Type	Description
Task<Boolean>	True if operation was successful. False otherwise.