unreal.CineAssembly

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

Bases: LevelSequence

A cinematic building block that associates a level sequence with a level

C++ Source:

• Plugin: CinematicAssemblyTools

• Module: CineAssemblyTools

• File: CineAssembly.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

• instance_metadata (Map[Name, str]): [Read-Write] User added metadata key/value pairs, which will be added as additional asset registry tags

• is_data_only (bool): [Read-Write] Mark this CineAssembly as Data-Only. When Data-Only, opening a CineAssembly opens only it’s details.

• label (Name): [Read-Write] Semantic label for identifying this assembly

• level (SoftObjectPath): [Read-Write] The level to open before opening this asset in Sequencer

• parent_assembly (SoftObjectPath): [Read-Write] Reference to another assembly asset that is the parent of this assembly

• production (Guid): [Read-Write] The ID of the Cinematic Production that this assembly is associated with

• should_create (bool): [Read-Write] If true, the CineAssembly factory will create this Assembly. If false, it (and its SubAssemblies and Associated Assets) is skipped.

• source_assembly (CineAssembly): [Read-Write] If this assembly was duplicated from another, this holds a soft reference to the source.

append_to_note_text(note) → None

Append to the note text associated with this assembly

Parameters:

note (str)

apply_metadata(metadata) → None

Apply a map of metadata key-value pairs to this assembly. Keys matching the schema’s AssemblyMetadata are applied with type-awareness based on each field’s defined type. Keys not found in the schema are stored as InstanceMetadata.

Parameters:

metadata (Map[str, str])

find_associated_assets_by_label(label) → Array[Object]

Get the list of Associated Assets configured on this assembly whose Label matches the input

Parameters:

label (Name)

Return type:

Array[Object]

find_sub_assemblies_by_label(label) → Array[CineAssembly]

Get the direct child SubAssemblies of this assembly whose Label matches the input

Parameters:

label (Name)

Return type:

Array[CineAssembly]

get_associated_asset_desc(asset_id) → AssemblyAssociatedAssetDesc

Returns a copy of the Associated Asset descriptor with the given AssetID on the Assembly. To mutate, call one of the appropriate setter functions with the descriptor’s AssetID.

Parameters:

asset_id (Guid)

Return type:

AssemblyAssociatedAssetDesc

get_associated_asset_descs() → Array[AssemblyAssociatedAssetDesc]

Returns copies of all Associated Asset descriptors on the Assembly. To mutate one, call one of the appropriate setter functions with the descriptor’s AssetID.

Return type:

Array[AssemblyAssociatedAssetDesc]

get_associated_assets() → Array[Object]

Get the list of Associated Assets configured on this assembly

Return type:

Array[Object]

get_author() → str

Gets the author of this assembly

Return type:

str

get_created_string() → str

Gets the created date-time of this assembly as a localtime formatted string.

Return type:

str

get_date_created_string() → str

Gets the date this assembly was created as a YYYY-MM-DD string.

Return type:

str

get_full_metadata_string() → str

Get all of the metadata for this assembly as a formatted JSON string

Return type:

str

get_label() → Name

Get the semantic label for this assembly

Return type:

Name

get_level() → World

Get the target level associated with this assembly

Return type:

World

get_metadata_as_bool(key) → bool or None

Get the metadata value for the input key as a boolean (if it exists)

Parameters:

key (str)

Returns:

out_value (bool):

Return type:

bool or None

get_metadata_as_float(key) → float or None

Get the metadata value for the input key as a floating-point number (if it exists)

Parameters:

key (str)

Returns:

out_value (float):

Return type:

float or None

get_metadata_as_integer(key) → int32 or None

Get the metadata value for the input key as an integer (if it exists)

Parameters:

key (str)

Returns:

out_value (int32):

Return type:

int32 or None

get_metadata_as_string(key) → str or None

Get the metadata value for the input key as a string (if it exists)

Parameters:

key (str)

Returns:

out_value (str):

Return type:

str or None

get_metadata_as_token_string(key) → TemplateString or None

Get the metadata value for the input key as a token string (if it exists)

Parameters:

key (str)

Returns:

out_value (TemplateString):

Return type:

TemplateString or None

get_note_text() → str

Get the note text associated with this assembly

Return type:

str

get_parent_assembly() → CineAssembly

Get the parent assembly of this assembly

Return type:

CineAssembly

get_production_id() → Guid

Get the production ID associated with this assembly

Return type:

Guid

get_production_name() → str

Get the production name associated with this assembly

Return type:

str

get_schema() → CineAssemblySchema

Get the base schema for this assembly

Return type:

CineAssemblySchema

get_sub_assemblies() → Array[CineAssembly]

Get the direct child SubAssemblies of this assembly

Return type:

Array[CineAssembly]

get_time_created_string() → str

Gets the 24-hour time of day this assembly was created as a HH:MM:SS string.

Return type:

str

property is_data_only: bool

[Read-Write] Mark this CineAssembly as Data-Only. When Data-Only, opening a CineAssembly opens only it’s details.

Type:

(bool)

property label: Name

[Read-Write] Semantic label for identifying this assembly

Type:

(Name)

set_associated_asset_label(asset_id, new_label) → None

Sets the Label of the Associated Asset descriptor matching the AssetID in the Assembly.

Parameters:

• asset_id (Guid)

• new_label (Name)

set_associated_asset_name(asset_id, new_asset_name) → None

Sets the AssetName of the Associated Asset descriptor matching the AssetID in the Assembly. Note: Operation will fail if descriptor’s asset has already been created.

Parameters:

• asset_id (Guid)

• new_asset_name (str)

set_associated_asset_should_create(asset_id, should_create) → None

Sets the bShouldCreate flag of the Associated Asset descriptor matching the AssetID in the Assembly. Note: This operation has no effect if the descriptor’s asset has already been created.

Parameters:

• asset_id (Guid)

• should_create (bool)

set_author(author) → None

Set the author of this assembly

Parameters:

author (str)

set_label(label) → None

Set the semantic label for this assembly

Parameters:

label (Name)

set_level(level) → None

Set the target level associated with this assembly

Parameters:

level (World)

set_metadata_as_bool(key, value) → None

Add a boolean as metadata to this assembly

Parameters:

• key (str)

• value (bool)

set_metadata_as_float(key, value) → None

Add a floating point number as metadata to this assembly

Parameters:

• key (str)

• value (float)

set_metadata_as_integer(key, value) → None

Add an integer as metadata to this assembly

Parameters:

• key (str)

• value (int32)

set_metadata_as_string(key, value) → None

Add a string as metadata to this assembly

Parameters:

• key (str)

• value (str)

set_metadata_as_token_string(key, value) → None

Add a tokenized string as metadata to this assembly

Parameters:

• key (str)

• value (TemplateString)

set_note_text(note) → None

Set the note text associated with this assembly

Parameters:

note (str)

set_parent_assembly(parent) → None

Set the parent assembly of this assembly

Parameters:

parent (CineAssembly)

property should_create: bool

[Read-Write] If true, the CineAssembly factory will create this Assembly. If false, it (and its SubAssemblies and Associated Assets) is skipped.

Type:

(bool)

property source_assembly: CineAssembly

[Read-Only] If this assembly was duplicated from another, this holds a soft reference to the source.

Type:

(CineAssembly)