Interface ITemplateGenerator<TParameters>

Namespace

Stride.Core.Assets.Templates

Assembly

Stride.Core.Assets.dll

The interface to represent a template generator.

public interface ITemplateGenerator<in TParameters> : ITemplateGenerator where TParameters : TemplateGeneratorParameters

Type Parameters

TParameters

The type of parameters this generator uses.

Inherited Members

ITemplateGenerator.IsSupportingTemplate(TemplateDescription)

Methods

PrepareForRun(TParameters)

Prepares this generator with the specified parameters.

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.

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.