unreal.MovieSceneSubAssemblySection

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

Bases: MovieSceneCinematicShotSection

The UMovieSceneSubAssemblySection is only supported in the Template Assembly of a CineAssemblySchema as a placeholder section. The Track containing this section has a TrackType that indicates which section should be created when creating an Assembly from a Schema Template.

C++ Source:

  • Plugin: CinematicAssemblyTools

  • Module: CineAssemblyTools

  • File: MovieSceneSubAssemblySection.h

Editor Properties: (see get_editor_property/set_editor_property)

  • assembly_template (Object): [Read-Write] The object that will be used as a template to create a new sequence in this section. Can be a Level Sequence, Cine Assembly, or Schema

  • color_tint (Color): [Read-Write] The color tint for this section

  • condition_container (MovieSceneConditionContainer): [Read-Write] Optional dynamic condition for whether this section evaluates at runtime.

  • decorations (MovieSceneDecorationContainer): [Read-Write] Array of decorations for this movie scene

  • easing (MovieSceneEasingSettings): [Read-Write]

  • eval_options (MovieSceneSectionEvalOptions): [Read-Write]

  • is_active (bool): [Read-Write] Toggle whether this section is active/inactive

  • is_locked (bool): [Read-Write] Toggle whether this section is locked/unlocked

  • label (Name): [Read-Write] Semantic label for identifying the SubAssembly created from this section.

  • metadata_overrides (Map[str, str]): [Read-Write] Metadata key-value pairs, used to override the default values of a SubAssembly created for this section. Keys should match metadata field keys defined by this section’s template schema.

  • network_mask (uint8): [Read-Write]

  • new_sequence_name (Text): [Read-Write] The name that will be used when creating a new sequence for this section. Only applicable to Template sections

  • new_sequence_path (str): [Read-Write] The path (relative to the root assembly’s path) where the new sequence asset for this sections should be created

  • parameters (MovieSceneSectionParameters): [Read-Write]

  • post_roll_frames (FrameNumber): [Read-Write] The amount of time to continue ‘postrolling’ this section for after evaluation has ended.

  • pre_roll_frames (FrameNumber): [Read-Write] The amount of time to prepare this section for evaluation before it actually starts.

  • section_range (MovieSceneFrameRange): [Read-Write] The range in which this section is active

  • section_type (SubAssemblySectionType): [Read-Write] Indicates whether this section will be used as a reference to an existing sequence or as a template to create a new sequence

  • sub_sequence (MovieSceneSequence): [Read-Write] Movie scene being played by this section

  • timecode_source (MovieSceneTimecodeSource): [Read-Write] The timecode at which this movie scene section is based (ie. when it was recorded)

get_assembly_template() → Object

Returns the Assembly Template object

Return type:

Object

property label: Name

[Read-Write] Semantic label for identifying the SubAssembly created from this section.

Type:

(Name)

property metadata_overrides: None

[Read-Write] Metadata key-value pairs, used to override the default values of a SubAssembly created for this section. Keys should match metadata field keys defined by this section’s template schema.

Type:

(Map[str, str])

property new_sequence_name: Text

[Read-Write] The name that will be used when creating a new sequence for this section. Only applicable to Template sections

Type:

(Text)

property new_sequence_path: str

[Read-Write] The path (relative to the root assembly’s path) where the new sequence asset for this sections should be created

Type:

(str)

property section_type: SubAssemblySectionType

[Read-Write] Indicates whether this section will be used as a reference to an existing sequence or as a template to create a new sequence

Type:

(SubAssemblySectionType)

set_assembly_template(template_object) → None

Sets the Assembly Template and updates the SequenceName to match the new template

Parameters:

template_object (Object)