Class ItemListCompiler

Namespace

Stride.Core.Assets.Compiler

Assembly

Stride.Core.Assets.dll

The base class to compile a series of AssetItems using associated IAssetCompilers. An item list compiler only creates the build steps required to creates some output items. The result of a compilation has then to be executed by the build engine to effectively create the outputs items.

public abstract class ItemListCompiler

Inheritance

object

ItemListCompiler

Constructors

ItemListCompiler(AssetCompilerRegistry, Type)

Create an instance of ItemListCompiler using the provided compiler registry.

protected ItemListCompiler(AssetCompilerRegistry compilerRegistry, Type compilationContext)

Parameters

compilerRegistry AssetCompilerRegistry

The registry that contains the compiler to use for each asset type

compilationContext Type

The context in which this list will compile the assets (Asset, Preview, thumbnail etc)

Fields

AssetCompiled

Raised when a single asset has been compiled.

public EventHandler<AssetCompiledArgs> AssetCompiled

Field Value

EventHandler<AssetCompiledArgs>

Methods

CompileItem(AssetCompilerContext, AssetCompilerResult, AssetItem)

Compile the required build step necessary to produce the desired output item.

public ListBuildStep CompileItem(AssetCompilerContext context, AssetCompilerResult compilationResult, AssetItem assetItem)

Parameters

context AssetCompilerContext

The context.

compilationResult AssetCompilerResult

The compilation result.

assetItem AssetItem

The asset item.

Returns

ListBuildStep

Prepare(AssetCompilerContext, IEnumerable<AssetItem>, AssetCompilerResult)

Compile the required build steps necessary to produce the desired outputs items.

protected void Prepare(AssetCompilerContext context, IEnumerable<AssetItem> assetItems, AssetCompilerResult compilationResult)

Parameters

context AssetCompilerContext

The context source.

assetItems IEnumerable<AssetItem>

The list of items to compile

compilationResult AssetCompilerResult

The current compilation result, containing the build steps and the logging