BuildEngineService Class

The main class for interacting with the uMod build engine. Use this class to compile a asset directory into mod format for loading at runtime.

Inheritance Hierarchy

Namespace: UMod.BuildEngine
Assembly: UMod-BuildEngine (in UMod-BuildEngine.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public sealed class BuildEngineService : BuildPipelineService<BuildContext, BuildPipelineAsset>

The BuildEngineService type exposes the following members.

Constructors

	Name	Description
	BuildEngineService	Initializes a new instance of the BuildEngineService class

Properties

	Name	Description
	LogLocation	Get the build engine log file location.

Methods

	Name	Description
	BuildMod	Start building a mod with the specified export settings.
	GetInvalidModFolderReason	Get the reason that the specified mod folder is invalid.
	GetInvalidModOutputReason	Get the reason that the specified mod export profile is invalid.
	GetLogFileStream	Open the build engine log file for reading or writing.
	IsValidModFolder	Attempts to validate a mod folder path. The specified folder must be inside the assets folder in order to be valid.
	IsValidOutput	Attempts to valdiate the specified export profile.
	RunProcessors	Run all build engine processors on their target assets. Should only be called when a build is in progress. (Overrides BuildPipelineServiceTContext, TAssetRunProcessors.)

Events

	Name	Description
	OnGenerateModIdentifier	An event that is triggered when the build engine requires a mod identifier to be created. You can add a listener to this event in order to manually generate mod identifiers.