🔡
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

SymbolGenerator

PreviousSymbolNextSymbolPosition

Last updated 2 months ago

Generates random symbols from on a pool of weighted values.

Implements: Archigen.IGenerator<System.String>,

Constructors

Constructor
Description

SymbolGenerator()

Instantiates a new .

SymbolGenerator(System.String symbols)

Instantiates a new with the provided symbols. Each character in the string is considered a separate symbol.

Methods

Method
Returns
Description

Add(System.String symbols)

Adds the symbols in the provided string to this generator. Each character in the string is considered a separate symbol.

Cluster(System.String[] clusters)

Adds provided symbol clusters (sequences) to this generator. Each argument regardless of its length is considered a single symbol.

Copy()

Creates a deep copy of this excluding the Syllabore.SymbolGenerator.Random property.

Next()

System.String

Returns a random as a string. with higher weights are more likely to be selected.

Weight(System.Int32 weight)

Sets the weight of the most recently added symbols. This method should be called immediately after Syllabore.SymbolGenerator.Add or Syllabore.SymbolGenerator.Cluster.

Properties

Property
Type
Description

Random

System.Random

The instance of System.Random used to simulate randomness.

Symbols

System.Collections.Generic.List <>

The possible that can be generated by this generator.

IRandomizable
SymbolGenerator
SymbolGenerator
SymbolGenerator
SymbolGenerator
SymbolGenerator
SymbolGenerator
Symbol
Symbol
SymbolGenerator
Symbol
Symbol