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

  • 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_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_number(key) → double or None

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

Parameters:

key (str)

Returns:

out_value (double):

Return type:

double 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_note_text() → str

Get the note text associated with this assembly

Return type:

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

Add a double-precision floating point number as metadata to this assembly

Parameters:

  • key (str)

  • value (double)

set_metadata_as_string(key, value) → None

Add a string as metadata to this assembly

Parameters:
set_note_text(note) → None

Set the note text associated with this assembly

Parameters:

note (str)