unreal.ProductionFunctionLibrary

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

Bases: BlueprintFunctionLibrary

Library of Blueprint/Python accessible functions to interface with the Cinematic Production Settings

C++ Source:

  • Plugin: CinematicAssemblyTools

  • Module: CineAssemblyToolsEditor

  • File: ProductionFunctionLibrary.h

classmethod add_production(production) → None

Add the input Cinematic Production to the Production Settings’ list of productions

Parameters:

production (CinematicProduction)

classmethod clear_active_production() → None

Sets the active Cinematic Production to None

classmethod create_assembly(schema, level, parent_assembly, metadata, path, name, use_default_name_from_schema=True) → CineAssembly

Create a new CineAssembly asset using the input Schema, Level, and Metadata. If bUseDefaultNameFromSchema is true, the default assembly name from the specified schema will be used as the new asset name. It is important that any metadata required for resolving asset naming tokens is provided to this function so that the Assembly and SubAssemblies are all named correctly.

Parameters:
Return type:

CineAssembly

classmethod delete_production(production_id) → None

Removes the Cinematic Production matching the input ProductionID from the Prodctuion Settings’ list of productions

Parameters:

production_id (Guid)

classmethod get_active_production() → CinematicProduction or None

Get the active Cinematic Production (if it exists)

Returns:

production (CinematicProduction):

Return type:

CinematicProduction or None

classmethod get_all_productions() → Array[CinematicProduction]

Returns an array of all available Cinematic Productions

Return type:

Array[CinematicProduction]

classmethod get_production(production_id) → CinematicProduction or None

Get the Cinematic Production matching the input ProductionID (if it exists)

Parameters:

production_id (Guid)

Returns:

production (CinematicProduction):

Return type:

CinematicProduction or None

classmethod get_production_extended_data(production_id, data_struct) → InstancedStruct or None

Given a ProductionID and an Extended Data Struct type, returns the Extended Data object for that production if found.

Parameters:
Returns:

out_data (InstancedStruct):

Return type:

InstancedStruct or None

classmethod is_active_production(production_id) → bool

Returns true if input ProductionID matches the ID of the current Active Production

Parameters:

production_id (Guid)

Return type:

bool

classmethod rename_production(production_id, new_name) → None

Renames the Cinematic Production matching the input ProductionID

Parameters:

  • production_id (Guid)

  • new_name (str)

classmethod set_active_production(production=[[], '', [24, 1], 0, SubsequencePriority.BOTTOM_UP, [], {}]) → None

Sets the input Production as the current Active Production If no input is provided, the Active Production will be set to None

Parameters:

production (CinematicProduction)

classmethod set_active_production_by_id(production_id) → None

Sets the Production matching the input ProductionID as the current Active Production

Parameters:

production_id (Guid)

classmethod set_production_extended_data(production_id, data) → bool

Given a ProductionID and an Extended Data Struct, sets the struct data on the production.

Parameters:
Return type:

bool