unreal.UAFRigVMAsset

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

Bases: RigVMHost

Base class for all AnimNext assets that can host RigVM logic

C++ Source:

• Plugin: UAF

• Module: UAF

• File: AnimNextRigVMAsset.h

Editor Properties: (see get_editor_property/set_editor_property)

• asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the asset

• asset_user_data_editor_only (Array[AssetUserData]): [Read-Write] Array of user data stored with the asset

• editor_data (Object): [Read-Only]

add_category(category_name, setup_undo_redo=True, print_python_command=True) → bool

Adds a category to an UAF asset

Parameters:

• category_name (str)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

bool

add_event_graph(name, event_struct, setup_undo_redo=True, print_python_command=True) → AnimNextEventGraphEntry

Adds an event graph to an UAF asset

Parameters:

• name (Name)

• event_struct (ScriptStruct)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

AnimNextEventGraphEntry

add_function(function_name, mutable, setup_undo_redo=True, print_python_command=True) → RigVMLibraryNode

Adds a function to an UAF asset

Parameters:

• function_name (Name)

• mutable (bool)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

RigVMLibraryNode

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

add_shared_variables(shared_variables, setup_undo_redo=True, print_python_command=True) → UAFSharedVariablesEntry

Adds shared variables to an UAF asset

Parameters:

• shared_variables (UAFSharedVariables)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

UAFSharedVariablesEntry

add_shared_variables_struct(struct, setup_undo_redo=True, print_python_command=True) → UAFSharedVariablesEntry

Adds shared variables struct to an UAF asset

Parameters:

• struct (ScriptStruct)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

UAFSharedVariablesEntry

add_variable(name, value_type, container_type=PropertyBagContainerType.NONE, value_type_object=None, default_value='', setup_undo_redo=True, print_python_command=True) → AnimNextVariableEntry

Adds a parameter to an UAF asset

Parameters:

• name (Name)

• value_type (PropertyBagPropertyType)

• container_type (PropertyBagContainerType)

• value_type_object (Object)

• default_value (str)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

AnimNextVariableEntry

find_entry(name) → UAFRigVMAssetEntry

Finds an entry in an AnimNext asset

Parameters:

name (Name)

Return type:

UAFRigVMAssetEntry

get_all_models() → Array[RigVMGraph]

Get All Models

Return type:

Array[RigVMGraph]

get_compilation_state() → AnimNextRigVMAssetState

Get Compilation State

Return type:

AnimNextRigVMAssetState

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_local_function_library() → RigVMFunctionLibrary

Get Local Function Library

Return type:

RigVMFunctionLibrary

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

recompile_vm() → None

Recompile VM

remove_all_entries(setup_undo_redo=True, print_python_command=True) → bool

Removes all entries from an UAF asset

Parameters:

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

bool

remove_category(category_name, setup_undo_redo=True, print_python_command=True) → bool

Removes a category from within an UAF asset

Parameters:

• category_name (str)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

bool

remove_entries(entries, setup_undo_redo=True, print_python_command=True) → bool

Removes multiple entries from an UAF asset

Parameters:

• entries (Array[UAFRigVMAssetEntry])

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

bool

remove_entry(entry, setup_undo_redo=True, print_python_command=True) → bool

Removes an entry from an UAF asset

Parameters:

• entry (UAFRigVMAssetEntry)

• setup_undo_redo (bool)

• print_python_command (bool)

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_category(category_name, new_category_name, setup_undo_redo=True, print_python_command=True) → bool

Renames a category within an UAF asset

Parameters:

• category_name (str)

• new_category_name (str)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

bool

rename_variable(variable_name, new_name, setup_undo_redo=True, print_python_command=True) → bool

Renames a variable in an UAF asset, updating all references across the project

Parameters:

• variable_name (Name)

• new_name (Name)

• setup_undo_redo (bool)

• print_python_command (bool)

Return type:

bool