1. Epic GamesDeveloper
  3. UCineAssembly

UCineAssembly

A cinematic building block that associates a level sequence with a level

API > API/Plugins > API/Plugins/CineAssemblyTools

A cinematic building block that associates a level sequence with a level

   
Name UCineAssembly
Type class
Header File /Engine/Plugins/VirtualProduction/CinematicAssemblyTools/Source/CineAssemblyTools/Public/CineAssembly.h
Include Path #include "CineAssembly.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, HideCategories=Animation)  
class UCineAssembly : public ULevelSequence

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UCineAssembly()

   CineAssembly.h  

Constants

Name Type Remarks Include Path
AssemblyGuidPropertyName const FName   CineAssembly.h
AssetRegistryTag_AssemblyType const FName The asset registry tag that contains the assembly type information CineAssembly.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssemblyName FTemplateString The assembly name, which supports tokens CineAssembly.h  
AssemblyNote FString User-facing notes about this assembly asset CineAssembly.h  
bIsDataOnly bool Mark this CineAssembly as Data-Only. CineAssembly.h
  • AssetRegistrySearchable
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Default"
  • AdvancedDisplay
  • Meta=(DisplayName="Data-Only")
DefaultFolderNames TArray< FTemplateString > Array of template names (possibly containing tokens), based on the schema, used to create folders for this assembly CineAssembly.h  
InstanceMetadata TMap< FName, FString > User added metadata key/value pairs, which will be added as additional asset registry tags CineAssembly.h
  • EditAnywhere
  • Category="Instance Metadata"
Level FSoftObjectPath The level to open before opening this asset in Sequencer CineAssembly.h
  • EditAnywhere
  • Category="Default"
  • Meta=(AllowedClasses="/Script/Engine.World")
ParentAssembly FSoftObjectPath Reference to another assembly asset that is the parent of this assembly CineAssembly.h
  • EditAnywhere
  • Category="Default"
  • Meta=(AllowedClasses="/Script/CineAssemblyTools.CineAssembly")
Production FGuid The ID of the Cinematic Production that this assembly is associated with CineAssembly.h
  • EditAnywhere
  • Category="Default"
ProductionName FString The name of the Cinematic Production that this assembly is associated with CineAssembly.h  
SubAssemblies TArray< TObjectPtr< UMovieSceneSubSection > > Array of Subsequence Sections created based on the schema CineAssembly.h  
SubAssemblyNames TArray< FTemplateString > Array of template names (possibly containing tokens), based on the schema, used to create the SubAssemblies CineAssembly.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AssemblyGuid FGuid Unique ID for this assembly, assigned at object creation CineAssembly.h
  • AssetRegistrySearchable
  • Meta=(IgnoreForMemberInitializationTest)
BaseSchema TObjectPtr< UCineAssemblySchema > The schema that was used as a base when creating this assembly (can be null if no schema was used) CineAssembly.h  
InstanceMetadataKeys TArray< FName > Copy of the keys present in the InstanceMetadata map, used to keep the json representation consistent with the map contents CineAssembly.h  
MetadataJsonObject TSharedPtr< FJsonObject > Json object responsible for storing the schema and instance metadata for this assembly CineAssembly.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMetadataNamingToken ( const FString& InKey
)

 Adds a new metadata key to the list of supported naming tokens for assemblies CineAssembly.h  

void AppendToNoteText ( FString InNote
)

 Append to the note text associated with this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void CreateSubAssemblies()

 Creates one or more subsequence assets, parented to this assembly, based on the schema CineAssembly.h  

FGuid GetAssemblyGuid()

 Get the unique ID of this assembly CineAssembly.h  

void GetAssetPathAndRootFolder ( FString& OutAssetPath,
FString& OutRootFolder
)

 Returns the asset path and its root folder (which might be different if the schema defines a default assembly path) CineAssembly.h  

FString GetAuthor()

 Gets the author of this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

FString GetCreatedString()

 Gets the created date-time of this assembly as a localtime formatted string. CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

FString GetDateCreatedString()

 Gets the date this assembly was created as a YYYY-MM-DD string. CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

FString GetFullMetadataString()

 Get all of the metadata for this assembly as a formatted JSON string CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

TSoftObjectPtr< UWorld > GetLevel()

 Get the target level associated with this assembly CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

bool GetMetadataAsBool ( FString InKey,
bool& OutValue
) const

 Get the metadata value for the input key as a boolean (if it exists) CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"
  • Meta=(ReturnDisplayName="FoundKey")

bool GetMetadataAsFloat ( FString InKey,
float& OutValue
) const

 Get the metadata value for the input key as a floating-point number (if it exists) CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"
  • Meta=(ReturnDisplayName="FoundKey")

bool GetMetadataAsInteger ( FString InKey,
int32& OutValue
) const

 Get the metadata value for the input key as an integer (if it exists) CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"
  • Meta=(ReturnDisplayName="FoundKey")

bool GetMetadataAsString ( FString InKey,
FString& OutValue
) const

 Get the metadata value for the input key as a string (if it exists) CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"
  • Meta=(ReturnDisplayName="FoundKey")

bool GetMetadataAsTokenString ( FString InKey,
FTemplateString& OutValue
) const

 Get the metadata value for the input key as a token string (if it exists) CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"
  • Meta=(ReturnDisplayName="FoundKey")

TArray< FString > GetMetadataKeys()

 Get all of the metadata keys for this assembly CineAssembly.h  

FString GetNoteText()

 Get the note text associated with this assembly CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

TSoftObjectPtr< UCineAssembly > GetParentAssembly()

 Get the parent assembly of this assembly CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

FGuid GetProductionID()

 Get the production ID associated with this assembly CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

FString GetProductionName()

 Get the production name associated with this assembly CineAssembly.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

const UCineAssemblySchema * GetSchema()

 Get the base schema for this assembly CineAssembly.h  

FString GetTimeCreatedString()

 Gets the 24-hour time of day this assembly was created as a HH:MM:SS string. CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void InitializeFromTemplate ( ULevelSequence* Template
)

 Given a ULevelSequence as a template, initialize this assembly from it. CineAssembly.h  

void SetAuthor ( const FString& InAuthor
)

 Set the author of this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetLevel ( TSoftObjectPtr< UWorld > InLevel
)

 Set the target level associated with this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetMetadataAsBool ( FString InKey,
bool InValue
)

 Add a boolean as metadata to this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetMetadataAsFloat ( FString InKey,
float InValue
)

 Add a floating point number as metadata to this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetMetadataAsInteger ( FString InKey,
int32 InValue
)

 Add an integer as metadata to this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetMetadataAsString ( FString InKey,
FString InValue
)

 Add a string as metadata to this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetMetadataAsTokenString ( FString InKey,
FTemplateString InValue
)

 Add a tokenized string as metadata to this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetNoteText ( FString InNote
)

 Set the note text associated with this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetParentAssembly ( TSoftObjectPtr< UCineAssembly > InParent
)

 Set the parent assembly of this assembly CineAssembly.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetSchema ( UCineAssemblySchema* InSchema
)

 Set the base schema for this assembly, only if one is not already set CineAssembly.h  

Overridden from ULevelSequence

Name Remarks Include Path Unreal Specifiers

virtual void Initialize()

   CineAssembly.h  

Overridden from UMovieSceneSequence

Name Remarks Include Path Unreal Specifiers

virtual bool IsCompatibleAsSubSequence ( const UMovieSceneSequence& ParentSequence
) const

   CineAssembly.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetAssetRegistryTagMetadata ( TMap< FName, FAssetRegistryTagMetadata >& OutMetadata
) const

   CineAssembly.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   CineAssembly.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   CineAssembly.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   CineAssembly.h  

virtual void PostInitProperties()

   CineAssembly.h  

virtual void PostLoad()

   CineAssembly.h  

virtual void Serialize ( FArchive& Ar
)

   CineAssembly.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page