unreal.TakeRecorderActorSource

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

Bases: TakeRecorderSource

This Take Recorder Source can record an actor from the World’s properties. Records the properties of the actor and the components on the actor and safely handles new components being spawned at runtime and the actor being destroyed.

C++ Source:

  • Plugin: Takes

  • Module: TakeRecorderSources

  • File: TakeRecorderActorSource.h

Editor Properties: (see get_editor_property/set_editor_property)

  • attach_record_behaviour (TakeRecorderAttachRecordBehaviour): [Read-Write] Control how attachments and hierarchies are recorded. If recording to possessable and the parent is not recorded or controlled by a sequence, the recorded transforms will be in local space since the child will still be attached to the parent in the level after recording. If recording to spawnable and the parent is not recorded or controlled by a sequence, the recorded transforms will be in global space since the child will not be attached to the parent in the level.

  • enabled (bool): [Read-Write] True if this source is cued for recording or not

  • exclude_animation_names (Array[str]): [Read-Write] Exclude all animation bones/curves that match this list

  • include_animation_names (Array[str]): [Read-Write] Include only the animation bones/curves that match this list

  • record_parent_hierarchy (bool): [Read-Write] deprecated: Please use AttachRecordBehaviour instead.

  • record_type (TakeRecorderActorRecordType): [Read-Write] Should this actor be recorded as a Possessable in Sequencer? If so the resulting Object Binding will not create a Spawnable copy of this object and instead will possess this object in the level.

  • recorded_properties (ActorRecorderPropertyMap): [Read-Write] Lists the properties and components on the current actor and whether or not each property will be recorded into a track in the resulting Level Sequence.

  • reduce_keys (bool): [Read-Write] Whether to perform key-reduction algorithms as part of the recording

  • spawnable_overwrite_behavior (TakeRecorderSpawnableOverwriteBehavior): [Read-Write] Should recording this actor as a spawnable overwrite existing spawnables or not.

  • take_number (int32): [Read-Write]

  • target (Actor): [Read-Write] Reference to the actor in the world that should have it’s properties recorded.

  • track_tint (Color): [Read-Write]

classmethod add_source_for_actor(actor, sources) → TakeRecorderSource

Add a take recorder source for the given actor.

Parameters:
Returns:

The added source or the source already present with the same actor

Return type:

TakeRecorderSource

property attach_record_behaviour: TakeRecorderAttachRecordBehaviour

[Read-Write] Control how attachments and hierarchies are recorded. If recording to possessable and the parent is not recorded or controlled by a sequence, the recorded transforms will be in local space since the child will still be attached to the parent in the level after recording. If recording to spawnable and the parent is not recorded or controlled by a sequence, the recorded transforms will be in global space since the child will not be attached to the parent in the level.

Type:

(TakeRecorderAttachRecordBehaviour)

property exclude_animation_names: None

[Read-Write] Exclude all animation bones/curves that match this list

Type:

(Array[str])

get_source_actor() → Actor

Get the target source actor.

Return type:

Actor

property include_animation_names: None

[Read-Write] Include only the animation bones/curves that match this list

Type:

(Array[str])

property record_parent_hierarchy: bool

[Read-Write] deprecated: Please use AttachRecordBehaviour instead.

Type:

(bool)

property record_type: TakeRecorderActorRecordType

[Read-Write] Should this actor be recorded as a Possessable in Sequencer? If so the resulting Object Binding will not create a Spawnable copy of this object and instead will possess this object in the level.

Type:

(TakeRecorderActorRecordType)

property recorded_properties: ActorRecorderPropertyMap

[Read-Write] Lists the properties and components on the current actor and whether or not each property will be recorded into a track in the resulting Level Sequence.

Type:

(ActorRecorderPropertyMap)

property reduce_keys: bool

[Read-Write] Whether to perform key-reduction algorithms as part of the recording

Type:

(bool)

classmethod remove_actor_from_sources(actor, sources) → None

Remove the given actor from TakeRecorderSources.

Parameters:

  • actor (Actor) – The actor to remove from the sources

  • sources (TakeRecorderSources) – The sources from where to remove the actor

set_source_actor(target) → None

Set the Target actor that we are going to record. Will reset the Recorded Property Map to defaults.

Parameters:

target (Actor)

property spawnable_overwrite_behavior: TakeRecorderSpawnableOverwriteBehavior

[Read-Write] Should recording this actor as a spawnable overwrite existing spawnables or not.

Type:

(TakeRecorderSpawnableOverwriteBehavior)

property target: Actor

[Read-Write] Reference to the actor in the world that should have it’s properties recorded.

Type:

(Actor)