unreal.ControlRigReplay

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

Bases: Object

Control Rig Replay

C++ Source:

  • Plugin: ControlRig

  • Module: ControlRig

  • File: ControlRigReplay.h

Editor Properties: (see get_editor_property/set_editor_property)

  • control_rig_object_path (SoftObjectPath): [Read-Only]

  • description (Text): [Read-Write]

  • enable_test (bool): [Read-Write]

  • frames_to_skip (Array[int32]): [Read-Write]

  • input_tracks (ControlRigReplayTracks): [Read-Write]

  • output_tracks (ControlRigReplayTracks): [Read-Write]

  • preview_skeletal_mesh_object_path (SoftObjectPath): [Read-Only]

  • tolerance (double): [Read-Write]

  • validate_hierarchy_topology (bool): [Read-Write]

  • validate_metadata (bool): [Read-Write]

  • validate_pose (bool): [Read-Write]

  • validate_variables (bool): [Read-Write]

property control_rig_object_path: SoftObjectPath

[Read-Only]

Type:

(SoftObjectPath)

classmethod create_new_asset(desired_package_path, blueprint_path_name, asset_class) → ControlRigReplay

Create New Asset

Parameters:

  • desired_package_path (str)

  • blueprint_path_name (str)

  • asset_class (type(Class))

Return type:

ControlRigReplay

property description: Text

[Read-Only]

Type:

(Text)

property enable_test: bool

[Read-Only]

Type:

(bool)

property frames_to_skip: None

[Read-Only]

Type:

(Array[int32])

get_playback_mode() → ControlRigReplayPlaybackMode

Get Playback Mode

Return type:

ControlRigReplayPlaybackMode

get_time_range() → Vector2D

Get Time Range

Return type:

Vector2D

is_paused() → bool

Is Paused

Return type:

bool

is_recording() → bool

Is Recording

Return type:

bool

is_replaying() → bool

Is Replaying

Return type:

bool

pause_replay() → bool

Pause Replay

Return type:

bool

property preview_skeletal_mesh_object_path: SoftObjectPath

[Read-Only]

Type:

(SoftObjectPath)

set_playback_mode(mode) → None

Set Playback Mode

Parameters:

mode (ControlRigReplayPlaybackMode)

start_recording(control_rig) → bool

Start Recording

Parameters:

control_rig (ControlRig)

Return type:

bool

start_replay(control_rig, mode=ControlRigReplayPlaybackMode.REPLAY_INPUTS) → bool

Start Replay

Parameters:
Return type:

bool

stop_recording() → bool

Stop Recording

Return type:

bool

stop_replay() → bool

Stop Replay

Return type:

bool

property tolerance: float

[Read-Only]

Type:

(double)

property validate_hierarchy_topology: bool

[Read-Only]

Type:

(bool)

property validate_metadata: bool

[Read-Only]

Type:

(bool)

property validate_pose: bool

[Read-Only]

Type:

(bool)

property validate_variables: bool

[Read-Only]

Type:

(bool)