docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class FrameNumberNameComponent

    NameComponent that adds the current frame number to the path.

    Inheritance
    object
    NameComponent
    FrameNumberNameComponent
    Inherited Members
    NameComponent.prefix
    NameComponent.suffix
    NameComponent.Reset()
    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 FrameNumberNameComponent : NameComponent

    Constructors

    FrameNumberNameComponent()

    Default Constructor

    Declaration
    public FrameNumberNameComponent()

    FrameNumberNameComponent(string, string)

    Constructor to pass in the affixes.

    Declaration
    public FrameNumberNameComponent(string prefix = "", string suffix = "")
    Parameters
    Type Name Description
    string prefix

    This will be prepended to the output from this NameComponent

    string suffix

    This will be appended to the output from this NameComponent

    Methods

    Generate(string, bool)

    Returns the current frame number.

    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)
    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)