UCineAssemblySchema | Unreal Engine 5.6 Documentation

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)  
class UCineAssemblySchema : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UCineAssemblySchema

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UCineAssemblySchema()		CineAssemblySchema.h

Constants

Name	Type	Remarks	Include Path
DefaultThumbnailPath	const FSoftObjectPath	Asset path of the default thumbnail to use for schema assets	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"
DefaultAssemblyName	FString	The default name to be use when creating assemblies from this schema	CineAssemblySchema.h	EditAnywhere Category="Default"
DefaultAssemblyPath	FString	The default path to use when creating assemblies from this schema When an assembly asset is created, this path will be appended to path where the asset would normally have been created.	CineAssemblySchema.h
Description	FString	A user-facing text description of this schema	CineAssemblySchema.h	EditAnywhere Category="Default"
FoldersToCreate	TArray< FString >	Paths of folders that should be created for assemblies that use this schema, relative to the path of the top-level assembly	CineAssemblySchema.h
ParentSchema	FSoftObjectPath	Restricts assemblies made from this schema to using this Schema when picking a Parent Assembly	CineAssemblySchema.h	EditAnywhere 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 Category="Default"
SubsequencesToCreate	TArray< FString >	Paths of subsequence assets that should be created for assemblies that use this schema, relative to the path of the top-level assembly	CineAssemblySchema.h
ThumbnailImage	TObjectPtr< UTexture2D >	The thumbnail image to use for this schema and assemblies built from this schema	CineAssemblySchema.h	EditAnywhere Category="Default"

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
bSupportsRename	bool	Whether the schema asset supports renaming	CineAssemblySchema.h
bThumbnailPendingReset	bool	Whether the thumbnail brush needs to be updated	CineAssemblySchema.h
SchemaGuid	FGuid	Unique ID for this schema, assigned at object creation	CineAssemblySchema.h	AssetRegistrySearchable Meta=(IgnoreForMemberInitializationTest)
ThumbnailBrush	TSharedPtr< FSlateBrush >	Slate brush used to actually render the thumbnail image	CineAssemblySchema.h

Functions

Public

Name	Remarks	Include Path
FGuid GetSchemaGuid()	Get the unique ID of this schema	CineAssemblySchema.h
const FSlateBrush * GetThumbnailBrush()	Returns the thumbnail brush used by this schema	CineAssemblySchema.h
void RenameAsset ( const FString& InNewName )	Renames the underlying schema asset	CineAssemblySchema.h
bool SupportsRename()	Whether or not this schema can be renamed	CineAssemblySchema.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostDuplicate ( bool bDuplicateForPIE )		CineAssemblySchema.h
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		CineAssemblySchema.h
virtual void PostInitProperties()		CineAssemblySchema.h
virtual void PostLoad()		CineAssemblySchema.h
virtual void Serialize ( FArchive& Ar )		CineAssemblySchema.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Constants

Variables

Public

Protected

Functions

Public

Overridden from UObject