1. Epic GamesDeveloper
  3. UProductionSettings

UProductionSettings

Cinematic Production Settings

API > API/Plugins > API/Plugins/CineAssemblyToolsEditor

Cinematic Production Settings

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

Syntax

UCLASS (Config=Engine, defaultconfig)  
class UProductionSettings : public UDeveloperSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UProductionSettings()

   ProductionSettings.h  

Constants

Name Type Remarks Include Path
ProductionNameMaxLength int32 Maximum number of characters allowed in a Production Name ProductionSettings.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveProductionChangedDelegate FOnActiveProductionChanged Delegate that broadcasts when the active production changes ProductionSettings.h  
ActiveProductionID FGuid ID of the active production (in the Productions array) ProductionSettings.h  
ActiveProductionName FString Name of the active production ProductionSettings.h
  • VisibleAnywhere
  • Category="Default"
  • Meta=(DisplayName="Active Production")
bEnableProductionsLevelEditorToolbar bool Enable the production level editor toolbar. ProductionSettings.h
  • Config
  • EditAnywhere
  • Category="Default"
  • Meta=(ConfigRestartRequired=true, DisplayName="Enable Production Toolbar")
OriginalDefaultDisplayRateTooltip FString Original tooltip text for sequencer settings ProductionSettings.h  
OriginalDefaultStartTimeTooltip FString   ProductionSettings.h  
ProductionListChangedDelegate FOnProductionListChanged Delegate that broadcasts when a production is added/removed ProductionSettings.h  
Productions TArray< FCinematicProduction > List of available productions in this project ProductionSettings.h
  • Config
  • EditAnywhere
  • Category="Default"
ProjectDefaultAssetNames TMap< const UClass *, FString > Default asset names previously registered with AssetTools, used to reset them when the active production changes ProductionSettings.h  
ProjectDefaultDisplayRate FString Cached default project settings that are overridden by the active production, used to reset when there is no active production ProductionSettings.h  
ProjectDefaultStartTime float   ProductionSettings.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddAssetNaming ( FGuid ProductionID,
const UClass* AssetClass,
const FString& DefaultName
)

 Adds a new entry into the DefaultAssetNames map of the production matching the input ID ProductionSettings.h  

void AddNamespaceToDenyList ( FGuid ProductionID,
const FString& Namespace
)

 Adds a Naming Token namespace to the DenyList of the production matching the input ID ProductionSettings.h  

void AddProduction ( const FCinematicProduction& ProductionToAdd
)

 Adds the input production to the list ProductionSettings.h  

void AddProduction ()

 Adds a new empty production to the list ProductionSettings.h  

void AddTemplateFolder ( FGuid ProductionID,
const FString& Path,
bool bCreateIfMissing
)

 Add a new path to the input production's list of template folders ProductionSettings.h  

void DeleteProduction ( FGuid ProductionID
)

 Removes the production matching the input ID from the list ProductionSettings.h  

void DuplicateProduction ( FGuid ProductionID
)

 Adds a duplicate of the input production to the list ProductionSettings.h  

FFrameRate GetActiveDisplayRate()

 Returns the DefaultDisplayRate of the active production, or the underlying level sequence setting if there is no active production ProductionSettings.h  

TOptional< const FCinematicProduction > GetActiveProduction()

 Returns a copy of the active production (if there is one) ProductionSettings.h  

FGuid GetActiveProductionID()

 Returns the unique ID of the active production ProductionSettings.h  

int32 GetActiveStartFrame()

 Returns the DefaultStartFrame of the active production, or the value based on the underlying movie scene tools setting if there is no active production ProductionSettings.h  

ESubsequencePriority GetActiveSubsequencePriority()

 Returns the SubsequencePriority of the active production, or the default config value if there is no active production ProductionSettings.h  

virtual FName GetCategoryName()

   ProductionSettings.h  

virtual FName GetContainerName()

   ProductionSettings.h  

FStructView GetMutableProductionExtendedData ( FGuid ProductionID,
const UScriptStruct& DataStruct
)

 Given a production ID and data struct, tries to get a mutable view on the productions extended data of the matching type. ProductionSettings.h  

TStructView< TStruct > GetMutableProductionExtendedData ( FGuid ProductionID
)

 Given a production ID and data struct, tries to get a mutable view on the productions extended data of the matching type. ProductionSettings.h  

TOptional< const FCinematicProduction > GetProduction ( FGuid ProductionID
) const

 Returns a copy of the production matching the input production ID (if it exists) ProductionSettings.h  

FConstStructView GetProductionExtendedData ( FGuid ProductionID,
const UScriptStruct& DataStruct
) const

 Given a production ID and data struct, tries to get a view on the productions extended data of the matching type. ProductionSettings.h  

TConstStructView< TStruct > GetProductionExtendedData ( FGuid ProductionID
) const

 Given a production ID and data struct, tries to get a view on the productions extended data of the matching type. ProductionSettings.h  

const TArray< FCinematicProduction > GetProductions()

 Returns a copy of the production list ProductionSettings.h  

virtual FName GetSectionName()

   ProductionSettings.h  

FString GetUniqueProductionName ( const FString& BaseName
) const

   ProductionSettings.h  
Returns a new unique production name ProductionSettings.h  

bool IsActiveProduction ( FGuid ProductionID
) const

 Returns true if the input production ID matches the ID of the active production ProductionSettings.h  

bool IsLevelEditorToolbarEnabled()

 Checks if the level editor toolbar is enabled. ProductionSettings.h  

FScopedModifyProductionExtendedData ModifyProductionExtendedData ( FGuid ProductionID,
const UScriptStruct& ExtendedDataStruct
)

 Get a FScopedModifyProductionExtendedData instance for the production matching the given production ID and extended data struct type. ProductionSettings.h  
Get a FScopedModifyProductionExtendedData instance for the production matching the given production ID. ProductionSettings.h  

FOnActiveProductionChanged & OnActiveProductionChanged()

 Returns the delegate that broadcasts when the active production changes ProductionSettings.h  

FOnProductionListChanged & OnProductionListChanged()

 Returns the delegate that broadcasts when a production is added/removed ProductionSettings.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   ProductionSettings.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   ProductionSettings.h  

virtual void PostEditUndo()

   ProductionSettings.h  

virtual void PostInitProperties()

   ProductionSettings.h  

virtual void PostReloadConfig ( FProperty* PropertyThatWasLoaded
)

   ProductionSettings.h  

void RemoveAssetNaming ( FGuid ProductionID,
const UClass* AssetClass
)

 Removes an entry from the DefaultAssetNames map of the production matching the input ID ProductionSettings.h  

void RemoveNamespaceFromDenyList ( FGuid ProductionID,
const FString& Namespace
)

 Removes a Naming Token namespace from the DenyList of the production matching the input ID ProductionSettings.h  

void RemoveTemplateFolder ( FGuid ProductionID,
const FString& Path
)

 Removes a path from the input production's list of template folders ProductionSettings.h  

void RenameProduction ( FGuid ProductionID,
FString NewName
)

 Renames the production matching the input ID ProductionSettings.h  

void SetActiveDisplayRate ( FFrameRate DisplayRate
)

 Sets the DefaultDisplayRate of the active production ProductionSettings.h  

void SetActiveProduction ( FGuid ProductionID
)

 Sets the active production based on the input production ID ProductionSettings.h  

void SetActiveStartFrame ( int32 StartFrame
)

 Sets the DefaultStartFrame of the active production ProductionSettings.h  

void SetActiveSubsequencePriority ( ESubsequencePriority Priority
)

 Sets the SubsequencePriority of the active production ProductionSettings.h  

void SetDisplayRate ( FGuid ProductionID,
FFrameRate DisplayRate
)

 Sets the DefaultDisplayRate of the production matching the input ID ProductionSettings.h  

bool SetProductionExtendedData ( FGuid ProductionID,
const FConstStructView& DataStructView
)

 Given a production ID and struct view, tries to set the struct in the productions extended data of the matching type. ProductionSettings.h  

void SetStartFrame ( FGuid ProductionID,
int32 StartFrame
)

 Sets the DefaultStartFrame of the production matching the input ID ProductionSettings.h  

void SetSubsequencePriority ( FGuid ProductionID,
ESubsequencePriority Priority
)

 Sets the SubsequencePriority of the production matching the input ID ProductionSettings.h  

void SetTemplateFolderHierarchy ( FGuid ProductionID,
const TArray< FFolderTemplate >& TemplateHierarchy
)

 Sets the input production's template folder hierarchy to the input array of template folders ProductionSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetProductionsPropertyMemberName()

 Get the checked member name for the Productions property. ProductionSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page