🔡
Syllabore
GitHub
  • Overview
  • Starting Out
  • Fine-Tuning Generators
    • Positioning
    • Clusters
    • Weights
    • Chancing
    • Transforms
    • Filtering
  • More Techniques
    • Formatters
    • Generator Pools
    • Syllable Sets
    • Generator Serialization
  • More Examples
    • Soft/Hard-Sounding Names
    • Fantasy Names
    • Spaceship Names
    • Futuristic City Names
  • Class Docs
    • FilterCondition
    • FilterConstraint
    • GeneratorPool<T>
    • INameFilter
    • INameTransformer
    • IPotentialAction
    • IRandomizable
    • ISyllableGenerator
    • Name
    • NameFilter
    • NameFormat
    • NameFormatter
    • NameFormatterGeneratorOptions
    • NameGenerator
    • NameGeneratorSerializer
    • NameGeneratorTypeInformation
    • SerializedNameGenerator
    • SyllableGenerator
    • SyllableGeneratorFluentWrapper
    • SyllablePosition
    • SyllableSet
    • Symbol
    • SymbolGenerator
    • SymbolPosition
    • Transform
    • TransformSet
    • TransformStep
    • TransformStepType
Powered by GitBook
On this page
  • Constructors
  • Methods
  • Properties
  1. Class Docs

NameGenerator

PreviousNameFormatterGeneratorOptionsNextNameGeneratorSerializer

Last updated 2 months ago

Generates names by constructing syllables and joining them together.

Implements: Archigen.IGenerator<System.String>,

Constructors

Constructor
Description

NameGenerator()

NameGenerator(System.String firstSymbols, System.String middleSymbols)

NameGenerator(System.String firstSymbols, System.String middleSymbols, System.String lastSymbols)

Methods

Method
Returns
Description

Next()

System.String

Generates a name and returns it as a string.

SetSize(System.Int32 size)

SetSize(System.Int32 minSize, System.Int32 maxSize)

Properties

Property
Type
Description

MaximumRetries

System.Int32

If this generator has a filter, this is the maximum attempts that will be made to satisfy the filter before an InvalidOperationException is thrown. The default maximum retry count is 1000.

MaximumSize

System.Int32

The maximum number of syllables in generated names. The default maximum size is 3 syllables.

MinimumSize

System.Int32

The minimum number of syllables in generated names. The default minimum size is 2 syllables.

NameFilter

The filter used to control generated names. Can be null if no filter is being used.

NameTransformer

The transformer used to modify generated names. Can be null if no transform is being used.

Random

System.Random

The instance of System.Random used to simulate randomness.

SyllableGenerators

Initializes a new instance of the class with no symbols, no transformer, and no filter.

Initializes a new with specified symbol pools for the first and middle symbol positions of a syllable. Each character in the provided strings is considered a separate symbol. The generated syllables will be used for all positions of a name.

Initializes a new with specified symbol pools for the first, middle, and last symbol positions of a syllable. Each character in the provided strings is considered a separate symbol. The generated syllables will be used for all positions of a name.

SetFilter( filter)

Sets the name filter to use when generating names. Returns this instance of for chaining.

Sets both the minimum and maximum number of syllables to use per name. Returns this instance of for chaining.

Sets the minimum and maximum number of syllables to use per name. Returns this instance of for chaining.

SetSyllables( position, generator)

Sets the for the specified position. Returns this instance of for chaining.

SetTransform( transformer)

Sets the name transformer to use when generating names. Returns this instance of for chaining.

System.Collections.Generic.Dictionary <,>

The used by this .

IRandomizable
NameGenerator
NameGenerator
NameGenerator
INameFilter
NameGenerator
NameGenerator
NameGenerator
NameGenerator
NameGenerator
NameGenerator
SyllablePosition
ISyllableGenerator
NameGenerator
SyllableGenerator
NameGenerator
INameTransformer
NameGenerator
NameGenerator
INameFilter
INameTransformer
SyllablePosition
ISyllableGenerator
SyllableGenerator
NameGenerator