ItemListCompiler Class
Namespace: Stride.Core.Assets.CompilerAssembly: 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
Name | Description | |
---|---|---|
Constructors | ||
ItemListCompiler(AssetCompilerRegistry, Type) | Create an instance of ItemListCompiler using the provided compiler registry. |
|
Fields | ||
AssetCompiled | Raised when a single asset has been compiled. |
|
Methods | ||
CompileItem(AssetCompilerContext, AssetCompilerResult, AssetItem) | Compile the required build step necessary to produce the desired output item. |
|
Prepare(AssetCompilerContext, IEnumerable<AssetItem>, AssetCompilerResult) | Compile the required build steps necessary to produce the desired outputs items. |
Constructors
ItemListCompiler(AssetCompilerRegistry, Type)
Create an instance of ItemListCompiler using the provided compiler registry.
protected ItemListCompiler(AssetCompilerRegistry compilerRegistry, Type compilationContext)
Parameters
Type | Name | Description |
---|---|---|
AssetCompilerRegistry | compilerRegistry | The registry that contains the compiler to use for each asset type |
System.Type | compilationContext | 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
Type | Description |
---|---|
System.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
Type | Name | Description |
---|---|---|
AssetCompilerContext | context | The context. |
AssetCompilerResult | compilationResult | The compilation result. |
AssetItem | assetItem | The asset item. |
Returns
Type | Description |
---|---|
Stride.Core.BuildEngine.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
Type | Name | Description |
---|---|---|
AssetCompilerContext | context | The context source. |
System.Collections.Generic.IEnumerable<AssetItem> | assetItems | The list of items to compile |
AssetCompilerResult | compilationResult | The current compilation result, containing the build steps and the logging |