Bases: unreal.Object
Runs logic for mapping input data to transforms (the “Rig”)
C++ Source:
Plugin: ControlRig
Module: ControlRig
File: ControlRig.h
Editor Properties: (see get_editor_property/set_editor_property)
asset_user_data
(Array(AssetUserData)): [Read-Write] Asset User Data:
Array of user data stored with the asset
interaction_rig
(ControlRig): [Read-Write] Interaction Rig
interaction_rig_class
(type(Class)): [Read-Write] Interaction Rig Class
-
can_execute() → bool
Is valid for execution
- Return type
bool
-
clear_control_selection() → bool
Clear Control Selection
- Return type
bool
-
current_control_selection()
Current Control Selection
- Return type
Array(Name)
-
execute(state, event_name) → None
Execute
- Parameters
-
-
classmethod find_control_rigs(outer, optional_class)
Find Control Rigs
- Parameters
-
- Return type
Array(ControlRig)
-
get_absolute_time() → float
Gets the current absolute time
- Return type
float
-
get_current_frames_per_second() → float
Returns the current frames per second (this may change over time)
- Return type
float
-
get_hierarchy() → RigHierarchy
Get Hierarchy
- Return type
RigHierarchy
-
get_script_accessible_variables()
Returns the names of variables accessible in scripting
- Return type
Array(Name)
-
get_supported_events()
Get Supported Events
- Return type
Array(Name)
-
get_variable_as_string(variable_name) → str
Returns the value of a given variable as a string
- Parameters
variable_name (Name) –
- Return type
str
-
get_variable_type(variable_name) → Name
Returns the type of a given variable
- Parameters
variable_name (Name) –
- Return type
Name
-
get_vm() → RigVM
Get VM
- Return type
RigVM
-
property interaction_rig
[Read-Write] Interaction Rig
- Type
(ControlRig)
-
property interaction_rig_class
[Read-Write] Interaction Rig Class
- Type
(type(Class))
-
is_control_selected(control_name) → bool
Is Control Selected
- Parameters
control_name (Name) –
- Return type
bool
-
request_init() → None
Requests to perform an init during the next execution
-
request_setup() → None
Requests to perform a setup during the next execution
-
select_control(control_name, select=True) → None
Select Control
- Parameters
-
-
set_absolute_and_delta_time(absolute_time, delta_time) → None
Set the current absolute and delta times
- Parameters
-
-
set_absolute_time(absolute_time, set_delta_time_zero=False) → None
Set the current absolute time
- Parameters
-
-
set_delta_time(delta_time) → None
Set the current delta time
- Parameters
delta_time (float) –
-
set_frames_per_second(frames_per_second) → None
Set the current fps
- Parameters
frames_per_second (float) –
-
set_variable_from_string(variable_name, value) → bool
Returns the value of a given variable as a string
- Parameters
variable_name (Name) –
value (str) –
- Return type
bool
-
supports_event(event_name) → bool
Supports Event
- Parameters
event_name (Name) –
- Return type
bool