Get RAPTOR

IRaptorModelVariantNamer

A module's naming rule for variant copies (RaptorSuiteModelVariant.VariantName).

NamespaceAssemblyKindStability
Raptor.EditorToolsRaptor.Editorinterfacepreview, since 0.1.0

Register an implementation with RaptorModelVariantNamers.Register.

public interface IRaptorModelVariantNamer

Methods

TryVariantName

bool TryVariantName(string sourceName, Func<string, bool> taken, out string name)

Names the copy of sourceName. Return true and set name to handle the copy. Return false to pass it to the next namer and, after the last one, to RAPTOR's "<stem> Variant N" rule.

taken is the caller's test for a taken name, passed through unchanged. When it is null, use the namer's default, normally RaptorModelPlacement.NameTaken or its scoped overload.

ParameterTypeDescription
sourceNamestringThe source model's name.
takenFunc<string, bool>The caller's test for a taken name, or null for the namer's default.
nameout stringThe name chosen.

Returns: True when this namer names the copy.

Called by RAPTOR.