UProductionFunctionLibrary

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

API > API/Plugins > API/Plugins/CineAssemblyToolsEditor

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

   
Name UProductionFunctionLibrary
Type class
Header File /Engine/Plugins/VirtualProduction/CinematicAssemblyTools/Source/CineAssemblyToolsEditor/Public/ProductionFunctionLibrary.h
Include Path #include "ProductionFunctionLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UProductionFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void AddProduction ( FCinematicProduction Production
)

 Add the input Cinematic Production to the Production Settings' list of productions ProductionFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static void ClearActiveProduction()

 Sets the active Cinematic Production to None ProductionFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static UCineAssembly * CreateAssembly ( UCineAssemblySchema* Schema,
TSoftObjectPtr< UWorld > Level,
TSoftObjectPtr< UCineAssembly > ParentAssembly,
const TMap< FString, FString >& Metadata,
const FString& Path,
const FString& Name,
bool bUseDefaultNameFromSchema
)

 Note: Prefer the CineAssembly Editor Function Library version of CreateAssembly. ProductionFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(AutoCreateRefTerm="Metadata")

static void DeleteProduction ( FGuid ProductionID
)

 Removes the Cinematic Production matching the input ProductionID from the Production Settings' list of productions ProductionFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static bool GetActiveProduction ( FCinematicProduction& Production
)

 Get the active Cinematic Production (if it exists) ProductionFunctionLibrary.h
  • BlueprintPure
  • Category="Cine Assembly Tools"
  • Meta=(ReturnDisplayName="IsValid")

static TArray< FCinematicProduction > GetAllProductions()

 Returns an array of all available Cinematic Productions ProductionFunctionLibrary.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

static bool GetProduction ( FGuid ProductionID,
FCinematicProduction& Production
)

 Get the Cinematic Production matching the input ProductionID (if it exists) ProductionFunctionLibrary.h
  • BlueprintPure
  • Category="Cine Assembly Tools"
  • Meta=(ReturnDisplayName="IsValid")

static bool GetProductionExtendedData ( FGuid ProductionID,
const UScriptStruct* DataStruct,
FInstancedStruct& OutData
)

 Given a ProductionID and an Extended Data Struct type, returns the Extended Data object for that production if found. ProductionFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static UProductionSettings * GetProductionSettings()

 Returns the Production Settings object ProductionFunctionLibrary.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

static bool IsActiveProduction ( FGuid ProductionID
)

 Returns true if input ProductionID matches the ID of the current Active Production ProductionFunctionLibrary.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

static void RenameProduction ( FGuid ProductionID,
FString NewName
)

 Renames the Cinematic Production matching the input ProductionID ProductionFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static void SetActiveProduction ( FCinematicProduction Production
)

 Sets the input Production as the current Active Production If no input is provided, the Active Production will be set to None ProductionFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static void SetActiveProductionByID ( FGuid ProductionID
)

 Sets the Production matching the input ProductionID as the current Active Production ProductionFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static bool SetProductionExtendedData ( FGuid ProductionID,
const FInstancedStruct& Data
)

 Given a ProductionID and an Extended Data Struct, sets the struct data on the production. ProductionFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page