unreal.MetaSoundAssetSubsystem

class unreal.MetaSoundAssetSubsystem(outer: Object | None = None, name: Name | str = 'None')

Bases: EngineSubsystem

Meta Sound Asset Subsystem

C++ Source:

  • Plugin: Metasound

  • Module: MetasoundEngine

  • File: MetasoundAssetSubsystem.h

find_asset_class_info(path, force_load=True) → (out_doc_info=MetaSoundDocumentInfo, out_interface_info=MetaSoundClassInterfaceInfo) or None

Returns asset class info for the given MetaSound asset. Will attempt to get info without loading the asset if its tag data is up-to-date, or if set to force load, will load otherwise (synchronously and can be slow). Returns true if asset is found, was MetaSound, and all data was retrieved successfully, false if not.

Parameters:
Returns:

out_doc_info (MetaSoundDocumentInfo):

out_interface_info (MetaSoundClassInterfaceInfo):

Return type:

tuple or None

find_referencing_asset_class_info(meta_sound, only_presets=False, force_load=True) → (out_paths=Array[TopLevelAssetPath], out_doc_info=Array[MetaSoundDocumentInfo], out_interface_info=Array[MetaSoundClassInterfaceInfo]) or None

Returns info for all MetaSounds assets referencing the given MetaSound as a dependency. Only returns assets on disk (i.e. not in-memory, transient MetaSounds created by the builder API). (Optional) Only returns references that are presets of the given MetaSound if bOnlyPresets is true.

Parameters:
Returns:

out_paths (Array[TopLevelAssetPath]):

out_doc_info (Array[MetaSoundDocumentInfo]):

out_interface_info (Array[MetaSoundClassInterfaceInfo]):

Return type:

tuple or None

reassign_class_name(doc_interface) → bool

Reassigns a new class name for the given MetaSound object, invalidating all references to the given MetaSound Asset.

Parameters:

doc_interface (MetaSoundDocumentInterface)

Return type:

bool

register_asset_classes_in_directories(directories) → None

Register Asset Classes in Directories

Parameters:

directories (Array[MetaSoundAssetDirectory])

replace_references_in_directory(directories, old_class_name, new_class_name, old_version=[1, 0], new_version=[1, 0]) → bool

Replaces dependencies in a MetaSound with the given class name and version with another MetaSound with the given class name and version. Can be asset or code-defined. It is up to the caller to validate the two classes have matching interfaces (Swapping with classes of unmatched interfaces can leave MetaSound in non-executable state).

Parameters:
Return type:

bool

unregister_asset_classes_in_directories(directories) → None

Unregister Asset Classes in Directories

Parameters:

directories (Array[MetaSoundAssetDirectory])