1. Epic GamesDeveloper
  3. USequencerSettings

USequencerSettings

Serializable options for sequencer.

API > API/Editor > API/Editor/Sequencer

Serializable options for sequencer.

   
Name USequencerSettings
Type class
Header File /Engine/Source/Editor/Sequencer/Public/SequencerSettings.h
Include Path #include "SequencerSettings.h"

Syntax

UCLASS (MinimalAPI, Config=EditorPerProjectUserSettings, PerObjectConfig)  
class USequencerSettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

USequencerSettings ( const FObjectInitializer& ObjectInitializer
)

   SequencerSettings.h  

Typedefs

Name Type Remarks Include Path
FOnAllowEditsModeChanged TMulticastDelegate_OneParam< void, EAllowEditsMode >   SequencerSettings.h
FOnEvaluateSubSequencesInIsolationChanged TMulticastDelegate_NoParams< void >   SequencerSettings.h
FOnLoopStateChanged TMulticastDelegate_NoParams< void >   SequencerSettings.h
FOnShowSelectedNodesOnlyChanged TMulticastDelegate_NoParams< void >   SequencerSettings.h
FOnTimeDisplayFormatChanged TMulticastDelegate_NoParams< void >   SequencerSettings.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

FSequencerFilterBarConfig & FindOrAddTrackFilterBar ( const FName InIdentifier,
const bool bInSaveConfig
)

   SequencerSettings.h  

FSequencerFilterBarConfig * FindTrackFilterBar ( const FName InIdentifier
)

   SequencerSettings.h  

EAllowEditsMode GetAllowEditsMode()

 Gets the current allow edits mode. SequencerSettings.h  

float GetAssetBrowserHeight()

 Gets the asset browser height SequencerSettings.h  

float GetAssetBrowserWidth()

 Gets the asset browser width SequencerSettings.h  

EAutoChangeMode GetAutoChangeMode()

 Gets the current auto change mode. SequencerSettings.h  

bool GetAutoExpandNodesOnFilterPass()

   SequencerSettings.h  

bool GetAutoExpandNodesOnSelection()

 Gets whether or not to expand the outliner tree view when a child element is selected (from outside of the tree view). SequencerSettings.h  

bool GetAutoScrollEnabled()

 Gets whether or not auto-scroll is enabled when playing. SequencerSettings.h  

bool GetAutoSetTrackDefaults()

 Gets whether or not track defaults will be automatically set when modifying tracks. SequencerSettings.h  

bool GetCleanPlaybackMode()

   SequencerSettings.h  

bool GetCreateSpawnableCameras()

 Get whether to create spawnable cameras. SequencerSettings.h  

bool GetCurveEditorVisible()

 Return true if we should filter the curve editor tree to only nodes that are relevant to the current sequencer selection SequencerSettings.h  

const FCurveEditorZoomScaleConfig & GetCurveEditorZoomScaling()

   SequencerSettings.h  

float GetCurveValueSnapInterval()

 Gets the snapping interval for curve values. SequencerSettings.h  

bool GetDeleteKeysWhenTrimming()

   SequencerSettings.h  

bool GetDisableSectionsAfterBaking()

   SequencerSettings.h  

EFilterBarLayout GetFilterBarLayout()

   SequencerSettings.h  

bool GetForceWholeFrames()

 Gets whether or not to snap keys/sections/playhead to the interval which forces whole frames SequencerSettings.h  

TOptional< float > GetGridSpacing()

 Gets the state for spacing between grid lines SequencerSettings.h  

bool GetIncludePinnedInFilter()

   SequencerSettings.h  

bool GetInfiniteKeyAreas()

   SequencerSettings.h  

bool GetIsSnapEnabled()

 Gets whether or not snapping is enabled. SequencerSettings.h  

FFrameNumber GetJumpFrameIncrement()

 Get the number of frames to increment when jumping forwards/backwards SequencerSettings.h  

void GetKeyAreaCurveExtents ( const FString& ChannelName,
double& InMin,
double& InMax
) const

   SequencerSettings.h  

float GetKeyAreaHeightWithCurves()

   SequencerSettings.h  

EKeyGroupMode GetKeyGroupMode()

 Returns what channels will get keyed when one channel changes SequencerSettings.h  

EMovieSceneKeyInterpolation GetKeyInterpolation()

 Get the initial Interpolation type for newly created keyframes if the channel does not already have keyframes SequencerSettings.h  

float GetLastFilterBarSizeCoefficient()

   SequencerSettings.h  

bool GetLeftMouseDragDoesMarquee()

 Gets whether left mouse drag does marquee select instead of camera orbit and ALT always moves the camera SequencerSettings.h  

bool GetLinkCurveEditorTimeRange()

 Gets whether or not to link the curve editor time range. SequencerSettings.h  

bool GetLinkFiltersWithCurveEditor()

 Gets whether or not to link sequence filters with the curve editor tree SequencerSettings.h  

ESequencerLoopMode GetLoopMode()

 Gets the loop mode. SequencerSettings.h  

FLinearColor GetMarkedFrameColor()

   SequencerSettings.h  

FString GetMovieRendererName()

 What movie renderer to use SequencerSettings.h  

FOnAllowEditsModeChanged & GetOnAllowEditsModeChanged()

 Gets the multicast delegate which is run whenever the allow edits mode is changed. SequencerSettings.h  

FOnEvaluateSubSequencesInIsolationChanged & GetOnEvaluateSubSequencesInIsolationChanged()

 Gets the multicast delegate which is run whenever evaluate sub sequences in isolation is changed. SequencerSettings.h  

FOnLoopStateChanged & GetOnLoopStateChanged()

   SequencerSettings.h  

FOnShowSelectedNodesOnlyChanged & GetOnShowSelectedNodesOnlyChanged()

   SequencerSettings.h  

FOnTimeDisplayFormatChanged & GetOnTimeDisplayFormatChanged()

   SequencerSettings.h  

TArray< FColumnVisibilitySetting > GetOutlinerColumnSettings()

 Get outliner column visibility in display order SequencerSettings.h  

FLinearColor GetPlaybackRangeEndColor()

 Set the playback range end color SequencerSettings.h  

FLinearColor GetPlaybackRangeStartColor()

 Set the playback range start color SequencerSettings.h  

float GetReduceKeysTolerance()

   SequencerSettings.h  

bool GetRestoreOriginalViewportOnCameraCutUnlock()

 Gets whether unlocking a camera cut track should return the viewport to its original location, or keep it where the camera cut was. SequencerSettings.h  

bool GetScrubTimeStartFromCursor()

 Gets whether or not scrubbing time hot key starts from cursor. SequencerSettings.h  

TArray< FColor > GetSectionColorTints()

   SequencerSettings.h  

bool GetShowChannelColors()

   SequencerSettings.h  

bool GetShowInfoButton()

   SequencerSettings.h  

bool GetShowKeyBars()

   SequencerSettings.h  

bool GetShowLayerBars()

   SequencerSettings.h  

bool GetShowMarkedFrames()

   SequencerSettings.h  

bool GetShowRangeSlider()

 Gets whether or not to show the time range slider. SequencerSettings.h  

bool GetShowScalingAnchors()

   SequencerSettings.h  

bool GetShowSelectedNodesOnly()

 Gets whether or not to show selected nodes only. SequencerSettings.h  

bool GetShowSequencerToolbar()

   SequencerSettings.h  

bool GetShowTickLines()

   SequencerSettings.h  

FSidebarState & GetSidebarState()

 Gets the last saved sidebar state SequencerSettings.h  

bool GetSnapCurveValueToInterval()

 Gets whether or not to snap curve values to the interval. SequencerSettings.h  

bool GetSnapKeyTimesToElements()

 Gets whether or not to snap keys to other elements. SequencerSettings.h  

bool GetSnapPlayTimeToDraggedKey()

 Gets whether or not to snap the play time to the dragged key. SequencerSettings.h  

bool GetSnapPlayTimeToKeys()

 Gets whether or not to snap the play time to keys while scrubbing. SequencerSettings.h  

bool GetSnapPlayTimeToMarkers()

 Gets whether or not to snap the play time to markers while scrubbing. SequencerSettings.h  

bool GetSnapPlayTimeToPressedKey()

 Gets whether or not to snap the play time to the pressed key. SequencerSettings.h  

bool GetSnapPlayTimeToSections()

 Gets whether or not to snap the play time to section bounds while scrubbing. SequencerSettings.h  

bool GetSnapSectionTimesToElements()

 Gets whether or not to snap sections to other elements. SequencerSettings.h  

ESequencerSpawnPosition GetSpawnPosition()

 Get initial spawn position. SequencerSettings.h  

bool GetStopPlayingWhenJumpingToStartOrEnd()

 Gets whether or not we stop playing when jumping to start or end. SequencerSettings.h  

const FSequencerThumbnailCaptureSettings & GetThumbnailCaptureSettings()

 Gets the settings that determine how the asset thumbnail is captured when the sequence is saved. SequencerSettings.h  

EFrameNumberDisplayFormats GetTimeDisplayFormat()

 What format should we display the UI controls in when representing time in a sequence? SequencerSettings.h  

ESequencerTimeWarpDisplay GetTimeWarpDisplayMode()

 Get the time-warp display mode SequencerSettings.h  

uint32 GetTrajectoryPathCap()

   SequencerSettings.h  

float GetTreeViewWidth()

 Gets the tree view width percentage SequencerSettings.h  

bool GetUseFilterSubmenusForCategories()

   SequencerSettings.h  

UE::Sequencer::EViewDensity GetViewDensity()

 Gets the saved view density SequencerSettings.h  

uint8 GetZeroPadFrames()

 Get the number of digits we should zero-pad to when showing frame numbers in sequencer SequencerSettings.h  

ESequencerZoomPosition GetZoomPosition()

 Get zoom in/out position (mouse position or current time). SequencerSettings.h  

bool HasKeyAreaCurveExtents ( const FString& ChannelName
) const

   SequencerSettings.h  

bool IsFilterBarVisible()

   SequencerSettings.h  

bool IsNavigationToolVisible()

   SequencerSettings.h  

void IsolateCurveEditorToSelection ( bool bInIsolateCurveEditorToSelection
)

 Assign whether we should filter the curve editor tree to only nodes that are relevant to the current sequencer selection SequencerSettings.h  

bool IsTrackFilterEnabled ( const FString& TrackFilter
) const

 Gets whether the given track filter is enabled SequencerSettings.h  

void RemoveKeyAreaCurveExtents ( const FString& ChannelName
)

 @ Remove curve extents for the given channel SequencerSettings.h  

bool RemoveTrackFilterBar ( const FName InIdentifier
)

   SequencerSettings.h  

void SetActivateRealtimeViewports ( bool bInActivateRealtimeViewports
)

 Toggle whether to allow possession of PIE viewports SequencerSettings.h  

void SetAllowEditsMode ( EAllowEditsMode AllowEditsMode
)

 Sets the current auto-key mode. SequencerSettings.h  

void SetAssetBrowserHeight ( float InAssetBrowserHeight
)

 Sets the asset browser width SequencerSettings.h  

void SetAssetBrowserWidth ( float InAssetBrowserWidth
)

 Sets the asset browser width SequencerSettings.h  

void SetAutoChangeMode ( EAutoChangeMode AutoChangeMode
)

 Sets the current auto change mode. SequencerSettings.h  

void SetAutoExpandNodesOnFilterPass ( const bool bInIncludePinned
)

   SequencerSettings.h  

void SetAutoExpandNodesOnSelection ( bool bInAutoExpandNodesOnSelection
)

 Sets whether or not to expand the outliner tree view when a child element is selected (from outside of the tree view). SequencerSettings.h  

void SetAutoScrollEnabled ( bool bInAutoScrollEnabled
)

 Sets whether or not auto-scroll is enabled when playing. SequencerSettings.h  

void SetAutoSetTrackDefaults ( bool bInAutoSetTrackDefaults
)

 Sets whether or not track defaults will be automatically set when modifying tracks. SequencerSettings.h  

void SetCleanPlaybackMode ( bool bInCleanPlaybackMode
)

 Toggle whether to playback in clean mode SequencerSettings.h  

void SetCompileDirectorOnEvaluate ( bool bInCompileDirectorOnEvaluate
)

 Assign whether whether to recompile the director blueprint when the sequence is evaluated (if one exists) SequencerSettings.h  

void SetCreateSpawnableCameras ( bool bInCreateSpawnableCameras
)

 Set whether to create spawnable cameras. SequencerSettings.h  

void SetCurveEditorVisible ( bool bCurveEditorVisible
)

 Assign whether we should filter the curve editor tree to only nodes that are relevant to the current sequencer selection SequencerSettings.h  

void SetCurveEditorZoomScaling ( const FCurveEditorZoomScaleConfig& Value
)

 Sets the config affecting the zooming behaviour of Sequencer's Curve Editor. SequencerSettings.h  

void SetCurveValueSnapInterval ( float InCurveValueSnapInterval
)

 Sets the snapping interval for curve values. SequencerSettings.h  

void SetDeleteKeysWhenTrimming ( bool bInDeleteKeysWhenTrimming
)

 Set whether to delete keys that fall beyond the section range when trimming SequencerSettings.h  

void SetDisableSectionsAfterBaking ( bool bInDisableSectionsAfterBaking
)

 Set whether to disable sections when baking, as opposed to deleting SequencerSettings.h  

void SetEvaluateSubSequencesInIsolation ( bool bInEvaluateSubSequencesInIsolation
)

 Set whether to evaluate sub sequences in isolation SequencerSettings.h  

void SetFilterBarLayout ( const EFilterBarLayout InLayout
)

   SequencerSettings.h  

void SetFilterBarVisible ( const bool bInVisible
)

   SequencerSettings.h  

void SetForceWholeFrames ( bool bInForceWholeFrames
)

 Sets whether or not to snap keys/sections/playhead to the interval which forces whole frames SequencerSettings.h  

void SetGridSpacing ( TOptional< float > InGridSpacing
)

 Sets the grid line spacing state SequencerSettings.h  

void SetIncludePinnedInFilter ( const bool bInIncludePinned
)

   SequencerSettings.h  

void SetInfiniteKeyAreas ( bool bInInfiniteKeyAreas
)

 Set whether to show channel colors SequencerSettings.h  

void SetIsSnapEnabled ( bool InbIsSnapEnabled
)

 Sets whether or not snapping is enabled. SequencerSettings.h  

void SetJumpFrameIncrement ( FFrameNumber InJumpFrameIncrement
)

 Set the number of frames to increment when jumping forwards/backwards SequencerSettings.h  

void SetKeepCursorInPlayRangeWhileScrubbing ( bool bInKeepCursorInPlayRangeWhileScrubbing
)

 Set whether or not the cursor should be kept within the playback (or subsequence/shot) range while scrubbing in sequencer SequencerSettings.h  

void SetKeepPlayRangeInSectionBounds ( bool bInKeepPlayRangeInSectionBounds
)

 Set whether or not the playback range should be synced to the section bounds SequencerSettings.h  

void SetKeyAreaCurveExtents ( const FString& ChannelName,
double InMin,
double InMax
)

 Set the key area curve extents for the given channel SequencerSettings.h  

void SetKeyAreaHeightWithCurves ( float InKeyAreaHeightWithCurves
)

 Set the key area height when showing curves SequencerSettings.h  

void SetKeyGroupMode ( EKeyGroupMode
)

 Sets which channels are keyed when a channel is keyed SequencerSettings.h  

void SetKeyInterpolation ( EMovieSceneKeyInterpolation InKeyInterpolation
)

 Sets initial key interpolation for creating new keys on empty channels SequencerSettings.h  

void SetLastFilterBarSizeCoefficient ( const float bInSizeCoefficient
)

   SequencerSettings.h  

void SetLeftMouseDragDoesMarque ( bool bDoMarque
)

 Sets whether left mouse drag does marquee select instead of camera orbit and ALT always moves the camera SequencerSettings.h  

void SetLinkCurveEditorTimeRange ( bool InbLinkCurveEditorTimeRange
)

 Sets whether or not to link the curve editor time range. SequencerSettings.h  

void SetLinkFiltersWithCurveEditor ( bool bInLinkFiltersWithCurveEditor
)

 Sets whether or not to link sequence filters with the curve editor tree SequencerSettings.h  

void SetLoopMode ( ESequencerLoopMode InLoopMode
)

 Sets the loop mode. SequencerSettings.h  

void SetMarkedFrameColor ( const FLinearColor& InColor
)

 Set the default marked frame color SequencerSettings.h  

void SetMovieRendererName ( const FString& InMovieRendererName
)

 Sets the movie renderer to use SequencerSettings.h  

void SetNavigationToolVisible ( const bool bInVisible
)

 Sets the visibility of the Navigation Tool SequencerSettings.h  

void SetOutlinerColumnVisibility ( const TArray< FColumnVisibilitySetting >& InColumnVisibilitySettings
)

 Sets the visibility of outliner columns in display order SequencerSettings.h  

void SetPlaybackRangeEndColor ( const FLinearColor& InColor
)

 Set the playback range end color SequencerSettings.h  

void SetPlaybackRangeStartColor ( const FLinearColor& InColor
)

 Set the playback range start color SequencerSettings.h  

void SetReduceKeysTolerance ( float InReduceKeysTolerance
)

 Set the tolerance to use when reducing keys SequencerSettings.h  

void SetRerunConstructionScripts ( bool bInRerunConstructionScripts
)

 Set whether to rerun construction scripts on bound actors every frame SequencerSettings.h  

void SetResetPlayheadWhenNavigating ( bool bInResetPlayheadWhenNavigating
)

 Set whether or not the cursor should be reset when navigating in and out of subsequences SequencerSettings.h  

void SetRestoreOriginalViewportOnCameraCutUnlock ( bool bInRestoreOriginalViewportOnCameraCutUnlock
)

 Sets whether unlocking a camera cut track should return the viewport to its original location, or keep it where the camera cut was. SequencerSettings.h  

void SetScrubTimeStartFromCursor ( bool bInValue
)

 Sets whether or not scrubing time hot key starts from cursor. SequencerSettings.h  

void SetSectionColorTints ( const TArray< FColor >& InSectionColorTints
)

 Set the section color tints SequencerSettings.h  

void SetShouldShowPrePostRoll ( bool bInVisualizePreAndPostRoll
)

 Toggle whether to show pre and post roll in sequencer SequencerSettings.h  

void SetShowChannelColors ( bool bInShowChannelColors
)

 Set whether to show channel colors for the key bars SequencerSettings.h  

void SetShowDebugVisualization ( bool bInShowDebugVisualization
)

 Toggle whether to show debug vis SequencerSettings.h  

void SetShowInfoButton ( bool bInShowInfoButton
)

 Set whether to show the info button in the playback controls SequencerSettings.h  

void SetShowKeyBars ( bool bInShowKeyBars
)

 Set whether to show key bars SequencerSettings.h  

void SetShowLayerBars ( bool bInShowLayerBars
)

 Set whether to show layer bars SequencerSettings.h  

void SetShowMarkedFrames ( bool bShowMarkedFrames
)

 Set whether to show marked frames SequencerSettings.h  

void SetShowRangeSlider ( bool InbShowRangeSlider
)

 Sets whether or not to show frame numbers. SequencerSettings.h  

void SetShowScalingAnchors ( bool bShowScalingAnchors
)

 Set whether to show scaling anchors SequencerSettings.h  

void SetShowSelectedNodesOnly ( bool Visible
)

 Sets whether or not to show selected nodes only. SequencerSettings.h  

void SetShowSequencerToolbar ( bool bInDrawTickLines
)

 Set whether to show sequencer toolbar bar SequencerSettings.h  

void SetShowTickLines ( bool bInDrawTickLines
)

 Set whether to show status bar SequencerSettings.h  

void SetSidebarState ( const FSidebarState& InSidebarState
)

 Sets the sidebar state to be restored on Sequencer initialize SequencerSettings.h  

void SetSnapCurveValueToInterval ( bool InbSnapCurveValueToInterval
)

 Sets whether or not to snap curve values to the interval. SequencerSettings.h  

void SetSnapKeyTimesToElements ( bool InbSnapKeyTimesToElements
)

 Sets whether or not to snap keys to other elements. SequencerSettings.h  

void SetSnapPlayTimeToDraggedKey ( bool InbSnapPlayTimeToDraggedKey
)

 Sets whether or not to snap the play time to the dragged key. SequencerSettings.h  

void SetSnapPlayTimeToKeys ( bool InbSnapPlayTimeToKeys
)

 Sets whether or not to snap the play time to keys while scrubbing. SequencerSettings.h  

void SetSnapPlayTimeToMarkers ( bool InbSnapPlayTimeToMarkers
)

 Sets whether or not to snap the play time to markers while scrubbing. SequencerSettings.h  

void SetSnapPlayTimeToPressedKey ( bool InbSnapPlayTimeToPressedKey
)

 Sets whether or not to snap the play time to the pressed key. SequencerSettings.h  

void SetSnapPlayTimeToSections ( bool InbSnapPlayTimeToSections
)

 Sets whether or not to snap the play time to section bounds while scrubbing. SequencerSettings.h  

void SetSnapSectionTimesToElements ( bool InbSnapSectionTimesToElements
)

 Sets whether or not to snap sections to other elements. SequencerSettings.h  

void SetSpawnPosition ( ESequencerSpawnPosition InSpawnPosition
)

 Set initial spawn position. SequencerSettings.h  

void SetStopPlayingWhenJumpingToStartOrEnd ( bool bInValue
)

 Sets whether or not we stop playing when jumping to start or end. SequencerSettings.h  

void SetThumbnailCaptureSettings ( const FSequencerThumbnailCaptureSettings& InNewValue
)

 Sets how the asset thumbnail is captured when the sequence is saved. SequencerSettings.h  

void SetTimeDisplayFormat ( EFrameNumberDisplayFormats InFormat
)

 Sets the time display format to the specified type. SequencerSettings.h  

void SetTimeWarpDisplayMode ( ESequencerTimeWarpDisplay InTimeWarpDisplay
)

 Set the time-warp display mode SequencerSettings.h  

void SetTrackFilterEnabled ( const FString& TrackFilter,
bool bEnabled
)

 Sets whether the track filter should be enabled/disabled SequencerSettings.h  

void SetTreeViewWidth ( float InTreeViewWidth
)

 Sets the tree view width percentage SequencerSettings.h  

void SetUseFilterSubmenusForCategories ( const bool bInUseFilterSubmenusForCategories
)

   SequencerSettings.h  

void SetViewDensity ( FName InViewDensity
)

 Sets the saved view density SequencerSettings.h  

void SetZeroPadFrames ( uint8 InZeroPadFrames
)

 Set the number of digits we should zero-pad to when showing frame numbers in sequencer SequencerSettings.h  

void SetZoomPosition ( ESequencerZoomPosition InZoomPosition
)

 Set zoom in/out position (mouse position or current time). SequencerSettings.h  

bool ShouldActivateRealtimeViewports()

   SequencerSettings.h  

bool ShouldCompileDirectorOnEvaluate()

 Check whether whether to recompile the director blueprint when the sequence is evaluated (if one exists) SequencerSettings.h  

bool ShouldEvaluateSubSequencesInIsolation()

   SequencerSettings.h  

bool ShouldIsolateToCurveEditorSelection()

 Return true if we should filter the curve editor tree to only nodes that are relevant to the current sequencer selection SequencerSettings.h  

bool ShouldKeepCursorInPlayRangeWhileScrubbing()

   SequencerSettings.h  

bool ShouldKeepPlayRangeInSectionBounds()

   SequencerSettings.h  

bool ShouldRerunConstructionScripts()

   SequencerSettings.h  

bool ShouldResetPlayheadWhenNavigating()

   SequencerSettings.h  

bool ShouldShowDebugVisualization()

   SequencerSettings.h  

bool ShouldShowPrePostRoll()

 Check whether to show pre and post roll in sequencer SequencerSettings.h  

bool ShouldSyncCurveEditorSelection()

 Return true if we are to synchronize the curve editor and sequencer trees SequencerSettings.h  

float SnapTimeToInterval ( float InTimeValue
) const

 Snaps a time value in seconds to the currently selected interval. SequencerSettings.h  

void SyncCurveEditorSelection ( bool bInSynchronizeCurveEditorSelection
)

 Assign whether we are to synchronize the curve editor and sequencer trees SequencerSettings.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   SequencerSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool ShouldShowThumbnailCaptureSettings()

   SequencerSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page