Class NameGenerator

Name Generator class. These can be created and configured in the editor. Certain components use these, and they can be assigned in the inspector.

Inheritance

object

Object

ScriptableObject

NameGenerator

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.Simulation

Assembly: Unity.Simulation.Core.dll

Syntax

[CreateAssetMenu(fileName = "NameGenerator", menuName = "Simulation/NameGenerator", order = 1)]
[Serializable]
public class NameGenerator : ScriptableObject

Constructors

NameGenerator()

Default constructor that populates starting with Directory, Filename, Extension.

Declaration

public NameGenerator()

NameGenerator(params NameComponent[])

Variable length constructor for adding components. var generator = new NameGenerator ( new DirectoryNameComponent(), new FileNameComponent(), new LabelNameComponent("LABEL"), new TimestampNameComponent(), new SequenceNameComponent(), new ExtensionNameComponent() );

Declaration

public NameGenerator(params NameComponent[] components)

Parameters

Type	Name	Description
NameComponent[]	components	Variable length set of NameComponents to add to the NameGenerator.

Fields

components

The ordered list of NameComponent items that will be applied to the path.

Declaration

[SerializeReference]
public List<NameComponent> components

Field Value

Type	Description
List<NameComponent>

Methods

Generate(string, bool)

Generate a new path from a base path.

Declaration

public 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

Insert(int, Type)

Insert a NameComponent into the ordered list.

Declaration

public void Insert(int index, Type type)

Parameters

Type	Name	Description
int	index	Where in the ordered list to create a new NameComponent.
Type	type	Type of NameComponent to insert.

Insert(int, NameComponent)

Insert a NameComponent into the ordered list.

Declaration

public void Insert(int index, NameComponent component)

Parameters

Type	Name	Description
int	index	Where in the ordered list to create a new NameComponent.
NameComponent	component	The NameComponent to insert.