🔡
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

TransformSet

PreviousTransformNextTransformStep

Last updated 2 months ago

A takes a source name, applies one or more , then creates a new name. By default, all of the same set are applied to the source name and in the order they were added. To randomize what transforms are applied, call Syllabore.TransformSet.RandomlySelect when configuring a .

Implements: , ,

Constructors

Constructor
Description

TransformSet()

Instantiates a new . By default, all future s that are added to this set will be used in the order they were added unless there is a call to Syllabore.TransformSet.RandomlySelect.

Methods

Method
Returns
Description

Add( transform)

Adds a new to this .

Apply( sourceName)

Returns a new that is the result of one or more s applied to the specified source . This method leaves the source untouched. This method can result in no changes if Syllabore.TransformSet.Chance is less than 1.0.

Join( set)

Combines this with the specified . A new that is the combination of the two is returned.

RandomlySelect(System.Int32 limit)

Sets this to randomly select transforms to apply to the source name. The parameter specifies the maximum number of unique transforms that will be applied.

Properties

Property
Type
Description

Chance

System.Double

The probability this transform set will make changes to a name. This value must be between 0 and 1 inclusive. Note that each in the set can also have its own chance value which is rolled separately.

Random

System.Random

Used to simulate randomness when Syllabore.TransformSet.UseRandomSelection is true.

RandomSelectionCount

System.Int32

When Syllabore.TransformSet.UseRandomSelection is true, this property is used to determine how many random are selected and applied.

Transforms

System.Collections.Generic.List <>

The that make up this .

UseRandomSelection

System.Boolean

When true, are not applied in the order they were added. Instead, a random number of are selected and applied. Property Syllabore.TransformSet.RandomSelectionCount is used to determine how many random selections are made.

TransformSet
Transform
Transform
TransformSet
IPotentialAction
INameTransformer
IRandomizable
TransformSet
Transform
Transform
TransformSet
Transform
TransformSet
Name
Name
Name
Transform
Name
Name
TransformSet
TransformSet
TransformSet
TransformSet
TransformSet
TransformSet
TransformSet
Transform
Transform
Transform
Transform
TransformSet
Transform
Transform