UCineAssemblySchema

A template object for building different Cine Assembly types

API > API/Plugins > API/Plugins/CineAssemblyTools

A template object for building different Cine Assembly types

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

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UCineAssemblySchema : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCineAssemblySchema()

   CineAssemblySchema.h  

Constants

Name Type Remarks Include Path
AssetRegistryTag_ThumbnailTexture const FName Asset registry tag holding the soft object path of the schema's thumbnail texture, so thumbnail display can resolve without loading the schema. CineAssemblySchema.h
DefaultLevelMetadataKey const FString Metadata key identifying the schema's DefaultLevel as a linkable target. CineAssemblySchema.h
SchemaGuidPropertyName const FName   CineAssemblySchema.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssemblyMetadata TArray< FAssemblyMetadataDesc > List of metadata fields that should be automatically added to assemblies made from this schema CineAssemblySchema.h
  • EditAnywhere
  • Category="Metadata"
bIsDataOnly bool Mark this Schema as Data-Only. CineAssemblySchema.h
  • AssetRegistrySearchable
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Default"
  • AdvancedDisplay
  • Meta=(DisplayName="Data-Only")
bIsHidden bool Hidden schemas will not appear in the UI when creating new Cine Assemblies. CineAssemblySchema.h
  • AssetRegistrySearchable
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Default"
  • AdvancedDisplay
  • Meta=(DisplayName="Hidden")
bOverrideDefaultLevel bool Whether assemblies created from this schema should use the DefaultLevel CineAssemblySchema.h
  • EditAnywhere
  • Category="Assembly Defaults"
  • Meta=(InlineEditConditionToggle)
DefaultAssemblyName FString The default name to be use when creating assemblies from this schema CineAssemblySchema.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Default"
DefaultLevel FSoftObjectPath If checked, the selected override will be used to initialize the Level property for a new Assembly made from this Schema. CineAssemblySchema.h
  • EditAnywhere
  • Category="Assembly Defaults"
  • Meta=(AllowedClasses="/Script/Engine.World", EditCondition="bOverrideDefaultLevel")
Description FString A user-facing text description of this schema CineAssemblySchema.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Default"
ParentSchema FSoftObjectPath Restricts assemblies made from this schema to using this Schema when picking a Parent Assembly CineAssemblySchema.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Default"
  • Meta=(AllowedClasses="/Script/CineAssemblyTools.CineAssemblySchema")
SchemaName FString The schema name, which will be used by assemblies made from this schema as their "assembly type" CineAssemblySchema.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Default"
TemplateSequence TObjectPtr< UCineAssembly > Template sequence, owned and managed by the schema, to use when creating the assembly as a starting point. CineAssemblySchema.h
  • BlueprintReadOnly
  • Category="Default"
ThumbnailTexture TSoftObjectPtr< UTexture2D > The thumbnail image to use for this schema and assemblies built from this schema CineAssemblySchema.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Default"
  • Meta=(DisplayName="Thumbnail Image")

Protected

Name Type Remarks Include Path Unreal Specifiers
AssemblyPropertyMetadata TArray< FAssemblyMetadataDesc > List of metadata fields that refer to specific Assembly properties CineAssemblySchema.h  
bSupportsRename bool Whether the schema asset supports renaming CineAssemblySchema.h  
SchemaGuid FGuid Unique ID for this schema, assigned at object creation CineAssemblySchema.h
  • AssetRegistrySearchable
  • Meta=(IgnoreForMemberInitializationTest)

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddDefaultFolder ( const FString& FolderPath
)

 Add a default folder path that will be created for assemblies made from this schema. CineAssemblySchema.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void ClearDefaultLevel()

 Clear the default level for assemblies created from this schema CineAssemblySchema.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

const FAssemblyMetadataDesc * FindMetadataDesc ( const FString& InMetadataKey
) const

 Finds the metadata desc matching the input key, searching AssemblyMetadata and AssemblyPropertyMetadata CineAssemblySchema.h  

void ForEachMetadataDesc ( TFunctionRef< bool(const FAssemblyMetadataDesc&)> Visitor
) const

 Iterates over each metadata desc in AssemblyMetadata and AssemblyPropertyMetadata CineAssemblySchema.h  

const TArray< FAssemblyMetadataDesc > & GetAssemblyPropertyMetadata()

 Returns the list of metadata descriptors for linkable assembly properties CineAssemblySchema.h  

FString GetDefaultAssemblyName()

 Get the default name for a new Assembly made from this schema CineAssemblySchema.h  

FString GetDefaultAssemblyPath()

 Get the default path (relative to the content root) for assemblies created from this schema CineAssemblySchema.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

TArray< FString > GetDefaultFolders()

 Get the list of default folder paths that will be created for assemblies made from this schema CineAssemblySchema.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

TSoftObjectPtr< UWorld > GetDefaultLevel()

 Get the default level for assemblies created from this schema CineAssemblySchema.h
  • BlueprintPure
  • Category="Cine Assembly Tools"

FGuid GetSchemaGuid()

 Get the unique ID of this schema CineAssemblySchema.h  

FName MakeUniqueAssemblyLabel ( const FString& BaseName
) const

 Returns a unique Label of the form "{BaseName}{N}" for a new SubAssembly template section in this schema's TemplateSequence. CineAssemblySchema.h  

FName MakeUniqueAssetLabel ( const FString& BaseName
) const

 Returns a unique Label of the form "{BaseName}{N}" for a new Associated Asset in this schema's TemplateSequence. CineAssemblySchema.h  

bool RemoveDefaultFolder ( const FString& FolderPath
)

 Remove a default folder path and all of its descendant folder paths. CineAssemblySchema.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void RenameAsset ( const FString& InNewName
)

 Renames the underlying schema asset CineAssemblySchema.h  

void SetDefaultAssemblyPath ( const FString& InPath
)

 Set the default path (relative to the content root) for assemblies created from this schema CineAssemblySchema.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

void SetDefaultLevel ( TSoftObjectPtr< UWorld > InLevel
)

 Set the default level for assemblies created from this schema CineAssemblySchema.h
  • BlueprintCallable
  • Category="Cine Assembly Tools"

bool SupportsRename()

 Whether or not this schema can be renamed CineAssemblySchema.h  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   CineAssemblySchema.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   CineAssemblySchema.h  

virtual void PostInitProperties()

   CineAssemblySchema.h  

virtual void PostLoad()

   CineAssemblySchema.h  

virtual void Serialize ( FArchive& Ar
)

   CineAssemblySchema.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DefaultAssemblyPath_DEPRECATED FString   CineAssemblySchema.h  
FoldersToCreate_DEPRECATED TArray< FString >   CineAssemblySchema.h  
SubsequencesToCreate_DEPRECATED TArray< FString >   CineAssemblySchema.h  
SubsequenceTemplates_DEPRECATED TMap< FString, FSoftObjectPath >   CineAssemblySchema.h  
Template_DEPRECATED FSoftObjectPath   CineAssemblySchema.h  
ThumbnailImage_DEPRECATED TObjectPtr< UTexture2D >   CineAssemblySchema.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page