UCineAssemblyEditorFunctionLibrary

Library of functions that expose CineAssembly functionality to editor scripting

API > API/Plugins > API/Plugins/CineAssemblyToolsEditor

Library of functions that expose CineAssembly functionality to editor scripting

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

Syntax

UCLASS ()  
class UCineAssemblyEditorFunctionLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FGuid AddAssociatedAsset ( UCineAssemblySchema* Schema,
TSubclassOf< UObject > AssetClass,
const FString& AssetName,
FName Label,
const FString& RelativePath,
UObject* TemplateAsset
)

 Adds a new Associated Asset descriptor to a Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(ScriptMethod)

static UMovieSceneSubAssemblySection * AddSubAssemblyReference ( UCineAssemblySchema* Schema,
ESubAssemblyTrackType TrackType,
UMovieSceneSequence* Sequence
)

 Adds a new reference SubAssembly track and section to a Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static UMovieSceneSubAssemblySection * AddSubAssemblyTemplate ( UCineAssemblySchema* Schema,
ESubAssemblyTrackType TrackType,
const FString& SubAssemblyName,
FName Label,
const FString& RelativePath,
UPARAM(meta=(AllowedClasses="/Script/LevelSequence.LevelSequence, /Script/CineAssemblyTools.CineAsse...
)

 Adds a new template SubAssembly track and section to a Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static UObject * BuildTokenContext ( UCineAssembly* Assembly
)

 Constructs a CineAssembly Naming Token context object for the input Assembly. CineAssemblyEditorFunctionLibrary.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& NameOverride
)

 Create a new CineAssembly asset using the input Schema, Level, and Metadata. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(AutoCreateRefTerm="Metadata")

static UCineAssembly * CreateAssemblyToConfigure ( UCineAssemblySchema* Schema,
TSoftObjectPtr< UWorld > Level,
TSoftObjectPtr< UCineAssembly > ParentAssembly,
const TMap< FString, FString >& Metadata
)

 Creates an in-memory (transient) CineAssembly object, with defaults configured from the input Schema, ready for further configuration. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(AutoCreateRefTerm="Metadata")

static UCineAssemblySchema * CreateSchema ( const FString& SchemaName,
const FString& AssetPath,
const FString& DefaultAssemblyName,
const FString& RelativeAssemblyPath,
const FString& Description,
UCineAssemblySchema* ParentSchema,
UTexture2D* ThumbnailImage,
bool bIsDataOnly,
bool bIsHidden
)

 Creates a new CineAssemblySchema asset at the specified path. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(AdvancedDisplay="Description, ParentSchema, ThumbnailImage, bIsDataOnly, bIsHidden")

static UCineAssembly * DuplicateAssembly ( UCineAssembly* SourceAssembly,
const FString& DuplicatePath,
const TMap< FString, FString >& Metadata,
bool bDuplicateSubsequences,
bool bDuplicateAssociatedAssets,
const FString& NameOverride,
EDuplicateExternalAssetPreference ExternalAssetPreference
)

 Duplicates a CineAssembly asset at the specified path. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(AutoCreateRefTerm="Metadata", AdvancedDisplay="ExternalAssetPreference")

static UCineAssembly * DuplicateAssemblyToConfigure ( UCineAssembly* SourceAssembly,
const TMap< FString, FString >& Metadata,
bool bDuplicateSubsequences
)

 Creates an in-memory (transient) duplicate of the source CineAssembly, ready for further configuration. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(AutoCreateRefTerm="Metadata")

static FNamingTokenResultData EvaluateTokenString ( const FString& TokenString,
UCineAssembly* Assembly
)

 Evaluates a tokenized string using the input Assembly for context. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static UCineAssembly * FinalizeConfiguredAssembly ( UCineAssembly* ConfiguredAssembly,
const FString& Path,
const FString& NameOverride
)

 Persists an in-memory, pre-configured CineAssembly object (typically returned by CreateAssemblyToConfigure()) to the specified path. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static UCineAssembly * FinalizeDuplicateAssembly ( UCineAssembly* ConfiguredDuplicateAssembly,
const FString& DuplicatePath,
const FString& NameOverride,
bool bDuplicateSubsequences,
bool bDuplicateAssociatedAssets,
EDuplicateExternalAssetPreference ExternalAssetPreference
)

 Persists an in-memory, pre-configured CineAssembly duplicate (typically returned by DuplicateAssemblyToConfigure()) to the specified path, and optionally duplicates the source assembly's unmanaged subsequences and associated assets. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(AdvancedDisplay="ExternalAssetPreference")

static TArray< FAssetData > FindAssembliesBySchema ( const UCineAssemblySchema* Schema
)

 Returns asset data for every CineAssembly asset created from the input Schema. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

static FAssemblyAssociatedAssetDesc GetAssemblyAssociatedAssetDesc ( UCineAssembly* Assembly,
FGuid AssetID
)

 Returns a copy of the Associated Asset descriptor with the given AssetID on the Assembly. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • DisplayName="Get Associated Asset Desc"
  • Meta=(ScriptMethod="GetAssociatedAssetDesc")

static TArray< FAssemblyAssociatedAssetDesc > GetAssemblyAssociatedAssetDescs ( UCineAssembly* Assembly
)

 Returns copies of all Associated Asset descriptors on the Assembly. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • DisplayName="Get Associated Asset Descs"
  • Meta=(ScriptMethod="GetAssociatedAssetDescs")

static FString GetDefaultAssetNameForClass ( const UClass* AssetClass
)

 Get the default asset name for a new Associated Asset of the given class CineAssemblyEditorFunctionLibrary.h  

static FAssemblyAssociatedAssetDesc GetSchemaAssociatedAssetDesc ( UCineAssemblySchema* Schema,
FGuid AssetID
)

 Returns a copy of the Associated Asset descriptor with the given AssetID on the Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • DisplayName="Get Associated Asset Desc"
  • Meta=(ScriptMethod="GetAssociatedAssetDesc")

static TArray< FAssemblyAssociatedAssetDesc > GetSchemaAssociatedAssetDescs ( UCineAssemblySchema* Schema
)

 Returns copies of all Associated Asset descriptors on the Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • DisplayName="Get Associated Asset Descs"
  • Meta=(ScriptMethod="GetAssociatedAssetDescs")

static FName MakeDefaultAssociatedAssetLabel ( const UCineAssemblySchema* Schema,
const UClass* AssetClass
)

 Get the default unique Label for a new Associated Asset of the given class on the given Schema CineAssemblyEditorFunctionLibrary.h  

static void OpenAssembly ( UCineAssembly* CineAssembly,
bool bOpenAssociatedLevel,
FCineAssemblyLevelSaveOptions SaveOptions
)

 Opens a CineAssembly in Sequencer, and optionally opens its associated Level CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(AdvancedDisplay="SaveOptions")

static bool OpenAssociatedLevel ( UCineAssembly* CineAssembly,
FCineAssemblyLevelSaveOptions SaveOptions
)

 Opens the Level associated with the input CineAssembly (if it has one). CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(AdvancedDisplay="SaveOptions")

static void RemoveAssociatedAsset ( UCineAssemblySchema* Schema,
FGuid AssetID
)

 Removes an Associated Asset descriptor from a Schema's template sequence by AssetID. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(ScriptMethod)

static void SetAssemblyAssociatedAssetLabel ( UCineAssembly* Assembly,
FGuid AssetID,
FName NewLabel
)

 Sets the Label of the Associated Asset descriptor matching the AssetID in the Assembly. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • DisplayName="Set Associated Asset Label"
  • Meta=(ScriptMethod="SetAssociatedAssetLabel")

static void SetAssemblyAssociatedAssetName ( UCineAssembly* Assembly,
FGuid AssetID,
const FString& NewAssetName
)

 Sets the AssetName of the Associated Asset descriptor matching the AssetID in the Assembly. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • DisplayName="Set Associated Asset Name"
  • Meta=(ScriptMethod="SetAssociatedAssetName")

static void SetAssemblyAssociatedAssetShouldCreate ( UCineAssembly* Assembly,
FGuid AssetID,
bool bShouldCreate
)

 Sets the bShouldCreate flag of the Associated Asset descriptor matching the AssetID in the Assembly. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • DisplayName="Set Associated Asset Should Create"
  • Meta=(ScriptMethod="SetAssociatedAssetShouldCreate")

static void SetAssociatedAssetClass ( UCineAssemblySchema* Schema,
FGuid AssetID,
TSubclassOf< UObject > NewAssetClass
)

 Sets the AssetClass of the Associated Asset descriptor matching the AssetID in the Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(ScriptMethod)

static void SetAssociatedAssetRelativePath ( UCineAssemblySchema* Schema,
FGuid AssetID,
const FString& NewRelativePath
)

 Sets the RelativePath of the Associated Asset descriptor matching the AssetID in the Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(ScriptMethod)

static void SetAssociatedAssetTemplate ( UCineAssemblySchema* Schema,
FGuid AssetID,
UObject* NewTemplateAsset
)

 Sets the TemplateAsset of the Associated Asset descriptor matching the AssetID in the Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • Meta=(ScriptMethod)

static void SetSchemaAssociatedAssetLabel ( UCineAssemblySchema* Schema,
FGuid AssetID,
FName NewLabel
)

 Sets the Label of the Associated Asset descriptor matching the AssetID in the Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • DisplayName="Set Associated Asset Label"
  • Meta=(ScriptMethod="SetAssociatedAssetLabel")

static void SetSchemaAssociatedAssetName ( UCineAssemblySchema* Schema,
FGuid AssetID,
const FString& NewAssetName
)

 Sets the AssetName of the Associated Asset descriptor matching the AssetID in the Schema's template sequence. CineAssemblyEditorFunctionLibrary.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"
  • DisplayName="Set Associated Asset Name"
  • Meta=(ScriptMethod="SetAssociatedAssetName")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page