Class TemplateGeneratorBase<TParameters>

Namespace

Stride.Core.Assets.Templates

Assembly

Stride.Core.Assets.dll

Base implementation for ITemplateGenerator and ITemplateGenerator<TParameters>.

public abstract class TemplateGeneratorBase<TParameters> : ITemplateGenerator<TParameters>, ITemplateGenerator where TParameters : TemplateGeneratorParameters

Type Parameters

TParameters

The type of parameters this generator uses.

Inheritance

object

TemplateGeneratorBase<TParameters>

Implements

ITemplateGenerator<TParameters>

ITemplateGenerator

Methods

IsSupportingTemplate(TemplateDescription)

Determines whether this generator is supporting the specified template

public abstract bool IsSupportingTemplate(TemplateDescription templateDescription)

Parameters

templateDescription TemplateDescription

The template description.

Returns

bool

true if this generator is supporting the specified template; otherwise, false.

PrepareForRun(TParameters)

Prepares this generator with the specified parameters.

public abstract Task<bool> PrepareForRun(TParameters parameters)

Parameters

parameters TParameters

The parameters for the template generator.

Returns

Task<bool>

A task completing when the preparation is finished, with the result True if the preparation was successful, false otherwise.

Remarks

This method should be used to verify that the parameters are correct, and to ask user for additional information before running the template.

Run(TParameters)

Runs the generator with the given parameter.

public abstract bool Run(TParameters parameters)

Parameters

parameters TParameters

The parameters for the template generator.

Returns

bool

True if the generation was successful, false otherwise.

Remarks

This method should work in unattended mode and should not ask user for information anymore.