Class SessionTemplateGenerator

Namespace

Stride.Core.Assets.Templates

Assembly

Stride.Core.Assets.dll

Session-aware template generator: Run(SessionTemplateGeneratorParameters) sequences Generate(SessionTemplateGeneratorParameters) → ApplyMetadata(SessionTemplateGeneratorParameters) → SaveSession(SessionTemplateGeneratorParameters) → AfterSave(SessionTemplateGeneratorParameters). Each step is a public virtual so a decorator (e.g. Quantum-aware editor wrapper) can intercept it; CLI / headless flows get bare no-op + plain Save(ILogger, PackageSaveParameters?).

public abstract class SessionTemplateGenerator : TemplateGeneratorBase<SessionTemplateGeneratorParameters>, ITemplateGenerator<SessionTemplateGeneratorParameters>, ITemplateGenerator

Inheritance

object

TemplateGeneratorBase<SessionTemplateGeneratorParameters>

SessionTemplateGenerator

Implements

ITemplateGenerator<SessionTemplateGeneratorParameters>

ITemplateGenerator

Inherited Members

TemplateGeneratorBase<SessionTemplateGeneratorParameters>.IsSupportingTemplate(TemplateDescription)

TemplateGeneratorBase<SessionTemplateGeneratorParameters>.PrepareForRun(SessionTemplateGeneratorParameters)

Extension Methods

UnsafeUtilities.As<T>(object?)

Methods

AfterSave(SessionTemplateGeneratorParameters)

Optional post-save step.

public virtual Task<bool> AfterSave(SessionTemplateGeneratorParameters parameters)

Parameters

parameters SessionTemplateGeneratorParameters

Returns

Task<bool>

ApplyMetadata(SessionTemplateGeneratorParameters)

No-op by default; Quantum decorator materializes override metadata into the asset graph.

public virtual void ApplyMetadata(SessionTemplateGeneratorParameters parameters)

Parameters

parameters SessionTemplateGeneratorParameters

Generate(SessionTemplateGeneratorParameters)

Generates the template; must work unattended.

public abstract bool Generate(SessionTemplateGeneratorParameters parameters)

Parameters

parameters SessionTemplateGeneratorParameters

Returns

bool

Run(SessionTemplateGeneratorParameters)

Runs the generator with the given parameter.

public override sealed bool Run(SessionTemplateGeneratorParameters parameters)

Parameters

parameters SessionTemplateGeneratorParameters

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.

SaveSession(SessionTemplateGeneratorParameters)

Bare Save(ILogger, PackageSaveParameters?); Quantum decorator runs PrepareForSave first.

public virtual void SaveSession(SessionTemplateGeneratorParameters parameters)

Parameters

parameters SessionTemplateGeneratorParameters

WriteGitIgnore(SessionTemplateGeneratorParameters)

protected void WriteGitIgnore(SessionTemplateGeneratorParameters parameters)

Parameters

parameters SessionTemplateGeneratorParameters