ITemplateGenerator<TParameters> Interface

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

Name	Description
TParameters	The type of parameters this generator uses.

Name		Description
Methods
	PrepareForRun(TParameters)	Prepares this generator with the specified parameters.
	Run(TParameters)	Runs the generator with the given parameter.

| Improve this Doc View Source

Prepares this generator with the specified parameters.

Task<bool> PrepareForRun(TParameters parameters)

Type	Name	Description
TParameters	parameters	The parameters for the template generator.

Type	Description
System.Threading.Tasks.Task<System.Boolean>	A task completing when the preparation is finished, with the result `True` if the preparation was successful, `false` otherwise.

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

Runs the generator with the given parameter.

bool Run(TParameters parameters)

Type	Name	Description
TParameters	parameters	The parameters for the template generator.

Type	Description
System.Boolean	`True` if the generation was successful, `false` otherwise.

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