Class FrameNumberNameComponent
NameComponent that adds the current frame number to the path.
Inherited Members
Namespace: Unity.Simulation
Assembly: Unity.Simulation.Core.dll
Syntax
[Serializable]
public class FrameNumberNameComponent : NameComponentConstructors
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 |