unreal.RigVMEditorAsset

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

Bases: Object

Rig VMEditor Asset

C++ Source:

• Plugin: RigVM

• Module: RigVMDeveloper

• File: RigVMEditorAsset.h

add_member_variable(name, cpp_type, is_public=False, is_read_only=False, default_value='') → Name

Add Member Variable

Parameters:

• name (Name)

• cpp_type (str)

• is_public (bool)

• is_read_only (bool)

• default_value (str)

Return type:

Name

add_model(name='Rig Graph', setup_undo_redo=True, print_python_command=True) → RigVMGraph

Add Model

Parameters:

• name (str)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

RigVMGraph

bulk_remove_member_variables(names) → bool

Bulk Remove Member Variables

Parameters:

names (Array[Name])

Return type:

bool

change_member_variable_type(name, cpp_type, is_public=False, is_read_only=False, default_value='') → bool

Change Member Variable Type

Parameters:

• name (Name)

• cpp_type (str)

• is_public (bool)

• is_read_only (bool)

• default_value (str)

Return type:

bool

create_rig_vm_host() → RigVMHost

Create Rig VMHost

Return type:

RigVMHost

generate_python_commands() → Array[str]

Generate Python Commands

Return type:

Array[str]

get_all_models() → Array[RigVMGraph]

Get All Models

Return type:

Array[RigVMGraph]

get_asset_variables() → Array[RigVMGraphVariableDescription]

Get Asset Variables

Return type:

Array[RigVMGraphVariableDescription]

get_asset_variant() → RigVMVariant

Get Asset Variant

Return type:

RigVMVariant

get_asset_variant_ref() → RigVMVariantRef

Get Asset Variant Ref

Return type:

RigVMVariantRef

get_auto_vm_recompile() → bool

Get Auto VMRecompile

Return type:

bool

get_controller(graph=None) → RigVMController

Get Controller

Parameters:

graph (RigVMGraph)

Return type:

RigVMController

get_controller_by_name(graph_name='') → RigVMController

Get Controller by Name

Parameters:

graph_name (str)

Return type:

RigVMController

get_default_model() → RigVMGraph

Get Default Model

Return type:

RigVMGraph

get_focused_model() → RigVMGraph

Get Focused Model

Return type:

RigVMGraph

get_local_function_library() → RigVMFunctionLibrary

Get Local Function Library

Return type:

RigVMFunctionLibrary

get_matching_variants() → Array[RigVMVariantRef]

Get Matching Variants

Return type:

Array[RigVMVariantRef]

get_model(ed_graph=None) → RigVMGraph

Get Model

Parameters:

ed_graph (EdGraph)

Return type:

RigVMGraph

get_or_create_controller(graph=None) → RigVMController

Get or Create Controller

Parameters:

graph (RigVMGraph)

Return type:

RigVMController

get_or_create_local_function_library(setup_undo_redo=True) → RigVMFunctionLibrary

Get or Create Local Function Library

Parameters:

setup_undo_redo (bool)

Return type:

RigVMFunctionLibrary

join_asset_variant(guid) → bool

Join Asset Variant

Parameters:

guid (Guid)

Return type:

bool

recompile_vm() → None

Recompile VM

recompile_vm_if_required() → None

Recompile VMIf Required

remove_member_variable(name) → bool

Remove Member Variable

Parameters:

name (Name)

Return type:

bool

remove_model(name='Rig Graph', setup_undo_redo=True, print_python_command=True) → bool

Remove Model

Parameters:

• name (str)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

bool

rename_member_variable(old_name, new_name) → bool

Rename Member Variable

Parameters:

• old_name (Name)

• new_name (Name)

Return type:

bool

request_auto_vm_recompilation() → None

Request Auto VMRecompilation

request_rig_vm_init() → None

Request Rig VMInit

set_auto_vm_recompile(auto_recompile) → None

Set Auto VMRecompile

Parameters:

auto_recompile (bool)

set_variable_index(name, new_index) → bool

Set Variable Index

Parameters:

• name (Name)

• new_index (int32)

Return type:

bool

split_asset_variant() → bool

Split Asset Variant

Return type:

bool