docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class SequenceNameComponent

    NameComponent that adds a sequence number to the path.

    Inheritance
    object
    NameComponent
    SequenceNameComponent
    Inherited Members
    NameComponent.prefix
    NameComponent.suffix
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.SimulationPro
    Assembly: Unity.SimulationPro.Capture.dll
    Syntax
    [Serializable]
    public class SequenceNameComponent : NameComponent

    Constructors

    SequenceNameComponent()

    Default Constructor

    Declaration
    public SequenceNameComponent()

    SequenceNameComponent(int, int)

    Constructor to specify the starting number and step.

    Declaration
    public SequenceNameComponent(int start = 0, int step = 1)
    Parameters
    Type Name Description
    int start

    Start value or position.

    int step

    The step to increase with each call to Generate. Negative numbers will cause the sequence to decrement.

    SequenceNameComponent(int, int, string, string)

    Constructor to pass in the affixes.

    Declaration
    public SequenceNameComponent(int start = 0, int step = 1, string prefix = "", string suffix = "")
    Parameters
    Type Name Description
    int start

    Start value or position.

    int step

    The step to increase with each call to Generate. Negative numbers will cause the sequence to decrement.

    string prefix

    This will be prepended to the output from this NameComponent

    string suffix

    This will be appended to the output from this NameComponent

    Fields

    start

    The starting number for the sequence.

    Declaration
    public int start
    Field Value
    Type Description
    int

    step

    The step to increase with each call to Generate. Negative numbers will cause the sequence to decrement.

    Declaration
    public int step
    Field Value
    Type Description
    int

    Methods

    Generate(string, bool)

    Returns the current sequence value, and increments it by the step.

    Declaration
    public override string Generate(string path, bool modify = true)
    Parameters
    Type Name Description
    string path

    Base path used to generate a new path.

    bool modify

    If false, the NameComponent will not modify its state. This is equivalent to Reset() followed by Generate().

    Returns
    Type Description
    string

    The path component generated by this NameComponent

    Overrides
    NameComponent.Generate(string, bool)

    Reset()

    Reset the SequenceNameComponent back to its configuration state.

    Declaration
    public override void Reset()
    Overrides
    NameComponent.Reset()
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)