unreal.RigVMBuildData

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

Bases: Object

The Build Data is used to store transient / intermediate build information for the RigVM graph to improve the user experience. This object is never serialized.

C++ Source:

  • Plugin: RigVM

  • Module: RigVMDeveloper

  • File: RigVMBuildData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • function_references (Map[RigVMLibraryNode, RigVMFunctionReferenceArray]): [Read-Write] deprecated: Property ‘FunctionReferences’ is deprecated.

  • graph_function_references (Map[RigVMGraphFunctionIdentifier, RigVMFunctionReferenceArray]): [Read-Only]

create_asset_variant(asset_data, name='None') → RigVMVariantRef

Creates a new variant of an asset

Parameters:
Return type:

RigVMVariantRef

create_function_variant(function_identifier, name='None') → RigVMVariantRef

Creates a new variant of a graph function within the same asset

Parameters:
Return type:

RigVMVariantRef

find_asset_variant_refs(guid) → Array[RigVMVariantRef]

Will find all the asset variants matching the given variant guid

Parameters:

guid (Guid)

Return type:

Array[RigVMVariantRef]

find_function_variant_refs(guid) → Array[RigVMVariantRef]

Will find all the function variants matching the given variant guid

Parameters:

guid (Guid)

Return type:

Array[RigVMVariantRef]

property function_references: None

[Read-Write] deprecated: Property ‘FunctionReferences’ is deprecated.

Type:

(Map[RigVMLibraryNode, RigVMFunctionReferenceArray])

gather_all_asset_variant_refs() → Array[RigVMVariantRef]

Will find all asset variant refs

Return type:

Array[RigVMVariantRef]

gather_all_function_variant_refs() → Array[RigVMVariantRef]

Will find all public function variant refs, and private function variant refs from loaded assets

Return type:

Array[RigVMVariantRef]

gather_function_variant_refs_for_asset(asset_data) → Array[RigVMVariantRef]

Will find the public function variant refs inside this asset, and private function variant refs if the asset is loaded

Parameters:

asset_data (AssetData)

Return type:

Array[RigVMVariantRef]

classmethod get() → RigVMBuildData

Returns the singleton build data

Return type:

RigVMBuildData

get_all_function_identifiers(only_public=True) → Array[RigVMGraphFunctionIdentifier]

Returns all known public function identifiers used in the project

Parameters:

only_public (bool)

Return type:

Array[RigVMGraphFunctionIdentifier]

get_asset_data_for_path(object_path) → AssetData

Returns the asset data given an object path

Parameters:

object_path (SoftObjectPath)

Return type:

AssetData

get_asset_data_for_variant(variant_ref) → AssetData

Returns the asset data given a variant reference

Parameters:

variant_ref (RigVMVariantRef)

Return type:

AssetData

get_function_identifier_for_variant(variant_ref) → RigVMGraphFunctionIdentifier

Returns the function identifier given a variant reference

Parameters:

variant_ref (RigVMVariantRef)

Return type:

RigVMGraphFunctionIdentifier

get_used_function_identifiers(only_public=True) → Array[RigVMGraphFunctionIdentifier]

Returns all known public function identifiers used in the project

Parameters:

only_public (bool)

Return type:

Array[RigVMGraphFunctionIdentifier]

get_variant_ref_for_asset(asset_data) → RigVMVariantRef

Returns the asset data given a variant reference

Parameters:

asset_data (AssetData)

Return type:

RigVMVariantRef

join_variant_set(variant_ref, guid) → RigVMVariantRef

Joins a variant with another variant’s set

Parameters:
Return type:

RigVMVariantRef

split_variant_from_set(variant_ref) → RigVMVariantRef

Splits a variant from its variant set (by assigning a new, unique guid

Parameters:

variant_ref (RigVMVariantRef)

Return type:

RigVMVariantRef