Class PipelineBuildEvent

Namespace

MonoGame.Framework.Content.Pipeline.Builder

Assembly

MonoGame.Framework.Content.Pipeline.dll

Class to provide methods and properties for handling pipeline build events.

public class PipelineBuildEvent

Inheritance

object

PipelineBuildEvent

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PipelineBuildEvent()

Creates a new pipeline build event.

public PipelineBuildEvent()

Fields

Extension

Gets the extension of the file to use in this pipeline event

public static readonly string Extension

Field Value

string

Properties

BuildAsset

Gets or sets the additional (nested) assets.

public List<string> BuildAsset { get; set; }

Property Value

List<string>

The additional (nested) assets.

Remarks

Additional assets are built by using an ExternalReference<T> and calling BuildAndLoadAsset<TInput, TOutput>(ExternalReference<TInput>, string) or BuildAsset<TInput, TOutput>(ExternalReference<TInput>, string).

Examples: The mesh processor may build textures and effects in addition to the mesh.

BuildOutput

Gets or sets the related output files.

public List<string> BuildOutput { get; set; }

Property Value

List<string>

The related output files.

Remarks

Related output files are non-XNB files that are included in addition to the XNB files. Related output files need to be copied to the output folder by a content processor and registered by calling AddOutputFile(string).

Dependencies

Gets or sets the dependencies.

public List<string> Dependencies { get; set; }

Property Value

List<string>

The dependencies.

Remarks

Dependencies are extra files that are required in addition to the SourceFile. Dependencies are added using AddDependency(string). Changes to the dependent file causes a rebuilt of the content.

DestFile

Absolute path to the output file.

public string DestFile { get; set; }

Property Value

string

DestTime

The date/time stamp of the destination file.

public DateTime DestTime { get; set; }

Property Value

DateTime

Importer

The name of the DLL containing the importer.

public string Importer { get; set; }

Property Value

string

ImporterTime

The date/time stamp of the DLL containing the importer.

public DateTime ImporterTime { get; set; }

Property Value

DateTime

Parameters

Gets or sets the parameters of this build event.

public OpaqueDataDictionary Parameters { get; set; }

Property Value

OpaqueDataDictionary

Remarks

Parameter are stored in an OpaqueDataDictionary

ParametersXml

Gets or sets the list of parameters.

public List<PipelineBuildEvent.Pair> ParametersXml { get; set; }

Property Value

List<PipelineBuildEvent.Pair>

Processor

The name of the DLL containing the processor.

public string Processor { get; set; }

Property Value

string

ProcessorTime

The date/time stamp of the DLL containing the processor.

public DateTime ProcessorTime { get; set; }

Property Value

DateTime

SourceFile

Absolute path to the source file.

public string SourceFile { get; set; }

Property Value

string

SourceTime

The date/time stamp of the source file.

public DateTime SourceTime { get; set; }

Property Value

DateTime

Methods

Load(string)

Creates a pipeline build event from a file.

public static PipelineBuildEvent Load(string filePath)

Parameters

filePath string

Path of the file to process.

Returns

PipelineBuildEvent

PipelineBuildEvent instance.

NeedsRebuild(PipelineManager, PipelineBuildEvent)

Checks if the current content files need to be rebuilt.

public bool NeedsRebuild(PipelineManager manager, PipelineBuildEvent cachedEvent)

Parameters

manager PipelineManager

Pipeline manager.

cachedEvent PipelineBuildEvent

Cached build event.

Returns

bool

true if the content needs to be rebuilt; otherwise false.

Save(string)

Saves the build event to a file as serialized Xml.

public void Save(string filePath)

Parameters

filePath string

Full path to save the file.