unreal.MetaSoundBuilderOptions

class unreal.MetaSoundBuilderOptions(name: Name = 'None', force_unique_class_name: bool = False)

Bases: StructBase

Meta Sound Builder Options

C++ Source:

  • Plugin: Metasound

  • Module: MetasoundEngine

  • File: MetasoundBuilderBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • force_unique_class_name (bool): [Read-Write] If the resulting MetaSound is building over an existing document, a unique class name will be generated, invalidating any referencing MetaSounds and registering the MetaSound as a new entry in the Frontend. If building a new document, option is ignored (new document always generates a unique class name).

  • name (Name): [Read-Write] Name of generated object. If object already exists, used as the base name to ensure new object is unique. If left ‘None’, creates unique name.

property force_unique_class_name: bool

[Read-Write] If the resulting MetaSound is building over an existing document, a unique class name will be generated, invalidating any referencing MetaSounds and registering the MetaSound as a new entry in the Frontend. If building a new document, option is ignored (new document always generates a unique class name).

Type:

(bool)

property name: Name

[Read-Write] Name of generated object. If object already exists, used as the base name to ensure new object is unique. If left ‘None’, creates unique name.

Type:

(Name)