unreal.CineAssemblySchema

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

Bases: Object

A template object for building different Cine Assembly types

C++ Source:

• Plugin: CinematicAssemblyTools

• Module: CineAssemblyTools

• File: CineAssemblySchema.h

Editor Properties: (see get_editor_property/set_editor_property)

• assembly_metadata (Array[AssemblyMetadataDesc]): [Read-Write] List of metadata fields that should be automatically added to assemblies made from this schema

• default_assembly_name (str): [Read-Write] The default name to be use when creating assemblies from this schema

• default_level (SoftObjectPath): [Read-Write] If checked, the selected override will be used to initialize the Level property for a new Assembly made from this Schema. If unchecked, the default Level for new Assemblies will be the currently open level when the Assembly is created.

• description (str): [Read-Write] A user-facing text description of this schema

• is_data_only (bool): [Read-Write] Mark this Schema as Data-Only. Assemblies made from this Schema will have their Data-Only defaulted to this value.

• is_hidden (bool): [Read-Write] Hidden schemas will not appear in the UI when creating new Cine Assemblies.

• override_default_level (bool): [Read-Write] Whether assemblies created from this schema should use the DefaultLevel

• parent_schema (SoftObjectPath): [Read-Write] Restricts assemblies made from this schema to using this Schema when picking a Parent Assembly

• schema_name (str): [Read-Write] The schema name, which will be used by assemblies made from this schema as their “assembly type”

• template_sequence (CineAssembly): [Read-Write] Template sequence, owned and managed by the schema, to use when creating the assembly as a starting point.

• thumbnail_texture (Texture2D): [Read-Write] The thumbnail image to use for this schema and assemblies built from this schema

add_associated_asset(asset_class, asset_name='', label='None', relative_path='', template_asset=None) → Guid

Adds a new Associated Asset descriptor to a Schema’s template sequence. When an Assembly is created from this Schema, the CineAssembly factory will create an asset of the specified class at the specified relative path, and include it in the Assembly’s asset tree.

EXPERIMENTAL: The CinematicAssemblyTools plugin officially supports UWorld for associated assets through the CineAssemblySchema UI. Associating assets of other class types may work, but some are untested.

Note: Only asset classes are supported. Non-asset classes, such as AActor or UActorComponent, will be rejected at runtime. Note: If AssetClass is UCineAssembly, the call is routed to AddSubAssemblyTemplate and the returned AssetID will be invalid. Consider calling AddSubAssemblyTemplate instead.

Parameters:

• asset_class (type(Class)) – The class of asset to create alongside each assembly. Only asset classes are supported. Non-asset classes, such as AActor or UActorComponent, will be rejected at runtime.

• asset_name (str) – Optional template name for the asset. If empty, the factory’s default asset name is used.

• label (Name) – Optional semantic label. If empty, a unique label is auto-assigned from the asset’s display name.

• relative_path (str) – Optional path, relative to the assembly root, where the asset should be created

• template_asset (Object) – Optional template asset to duplicate when the factory creates this descriptor’s asset. Must match AssetClass. If null, a new asset of AssetClass is created instead.

Returns:

The stable AssetID for the new descriptor. The AssetID will be invalid if the operation failed, or if the call was routed to AddSubAssemblyTemplate (see note above).

Return type:

Guid

add_default_folder(folder_path) → None

Add a default folder path that will be created for assemblies made from this schema. Also adds all intermediate parent paths (e.g. adding “A/B/C” will add “A”, “A/B”, and “A/B/C”).

Parameters:

folder_path (str)

clear_default_level() → None

Clear the default level for assemblies created from this schema

property default_assembly_name: str

[Read-Write] The default name to be use when creating assemblies from this schema

Type:

(str)

property description: str

[Read-Write] A user-facing text description of this schema

Type:

(str)

get_associated_asset_desc(asset_id) → AssemblyAssociatedAssetDesc

Returns a copy of the Associated Asset descriptor with the given AssetID on the Schema’s template sequence. 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 Schema’s template sequence. To mutate one, call one of the appropriate setter functions with the descriptor’s AssetID.

Return type:

Array[AssemblyAssociatedAssetDesc]

get_default_assembly_path() → str

Get the default path (relative to the content root) for assemblies created from this schema

Return type:

str

get_default_folders() → Array[str]

Get the list of default folder paths that will be created for assemblies made from this schema

Return type:

Array[str]

get_default_level() → World

Get the default level for assemblies created from this schema

Return type:

World

property is_data_only: bool

[Read-Write] Mark this Schema as Data-Only. Assemblies made from this Schema will have their Data-Only defaulted to this value.

Type:

(bool)

property is_hidden: bool

[Read-Write] Hidden schemas will not appear in the UI when creating new Cine Assemblies.

Type:

(bool)

property parent_schema: SoftObjectPath

[Read-Write] Restricts assemblies made from this schema to using this Schema when picking a Parent Assembly

Type:

(SoftObjectPath)

remove_associated_asset(asset_id) → None

Removes an Associated Asset descriptor from a Schema’s template sequence by AssetID.

Parameters:

asset_id (Guid)

remove_default_folder(folder_path) → bool

Remove a default folder path and all of its descendant folder paths. Returns true if any folders were found and removed.

Parameters:

folder_path (str)

Return type:

bool

property schema_name: str

[Read-Write] The schema name, which will be used by assemblies made from this schema as their “assembly type”

Type:

(str)

set_associated_asset_class(asset_id, new_asset_class) → None

Sets the AssetClass of the Associated Asset descriptor matching the AssetID in the Schema’s template sequence. Schema-only because AssetClass is a structural property shared across all assemblies.

Parameters:

• asset_id (Guid)

• new_asset_class (type(Class))

set_associated_asset_label(asset_id, new_label) → None

Sets the Label of the Associated Asset descriptor matching the AssetID in the Schema’s template sequence.

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 Schema’s template sequence.

Parameters:

• asset_id (Guid)

• new_asset_name (str)

set_associated_asset_relative_path(asset_id, new_relative_path) → None

Sets the RelativePath of the Associated Asset descriptor matching the AssetID in the Schema’s template sequence. Schema-only because RelativePath is a structural property shared across all assemblies.

Parameters:

• asset_id (Guid)

• new_relative_path (str)

set_associated_asset_template(asset_id, new_template_asset) → None

Sets the TemplateAsset of the Associated Asset descriptor matching the AssetID in the Schema’s template sequence. Schema-only because TemplateAsset is a structural property shared across all assemblies. Note: Operation will fail if the input TemplateAsset does not match the existing AssetClass filter of the Associated Asset descriptor.

Parameters:

• asset_id (Guid)

• new_template_asset (Object)

set_default_assembly_path(path) → None

Set the default path (relative to the content root) for assemblies created from this schema

Parameters:

path (str)

set_default_level(level) → None

Set the default level for assemblies created from this schema

Parameters:

level (World)

property template_sequence: CineAssembly

[Read-Only] Template sequence, owned and managed by the schema, to use when creating the assembly as a starting point.

Type:

(CineAssembly)

property thumbnail_texture: Texture2D

[Read-Write] The thumbnail image to use for this schema and assemblies built from this schema

Type:

(Texture2D)