unreal.AnimNextRigVMAsset

class unreal.AnimNextRigVMAsset(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 AnimNext asset

Parameters:

  • category_name (str)

  • setup_undo_redo (bool)

  • print_python_command (bool)

Return type:

bool

add_data_interface(shared_variables: AnimNextSharedVariables, setup_undo_redo: bool = True, print_python_command: bool = True) → AnimNextSharedVariablesEntry

deprecated: ‘add_data_interface’ was renamed to ‘add_shared_variables’.

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

Adds an event graph to an AnimNext asset

Parameters:
Return type:

AnimNextEventGraphEntry

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

Adds a function to an AnimNext asset

Parameters:

  • function_name (Name)

  • mutable (bool)

  • setup_undo_redo (bool)

  • print_python_command (bool)

Return type:

RigVMLibraryNode

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

Adds shared variables to an AnimNext asset

Parameters:
Return type:

AnimNextSharedVariablesEntry

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

Adds shared variables struct to an AnimNext asset

Parameters:
Return type:

AnimNextSharedVariablesEntry

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 AnimNext asset

Parameters:
Return type:

AnimNextVariableEntry

find_entry(name) → AnimNextRigVMAssetEntry

Finds an entry in an AnimNext asset

Parameters:

name (Name)

Return type:

AnimNextRigVMAssetEntry

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

Removes all entries from an AnimNext asset

Parameters:

  • 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 AnimNext asset

Parameters:
Return type:

bool

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

Removes an entry from an AnimNext asset

Parameters:
Return type:

bool

rename_category(category_name, new_category_name, setup_undo_redo=True, print_python_command=True) → bool

Renames a category within an AnimNext asset

Parameters:

  • category_name (str)

  • new_category_name (str)

  • setup_undo_redo (bool)

  • print_python_command (bool)

Return type:

bool