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.

  • 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

append_to_note_text(note) → None

Append to the note text associated with this assembly

Parameters:

note (str)

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_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_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)

set_author(author) → None

Set the author of this assembly

Parameters:

author (str)

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:
set_metadata_as_float(key, value) → None

Add a floating point number as metadata to this assembly

Parameters:
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:
set_metadata_as_token_string(key, value) → None

Add a tokenized string as metadata to this assembly

Parameters:
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)