1. Epic GamesDeveloper
  3. USequencerSettings

USequencerSettings

Serializable options for sequencer.

Unreal Engine C++ API Reference > Editor > Sequencer

Inheritance Hierarchy

References

   
Module Sequencer
Header /Engine/Source/Editor/Sequencer/Public/SequencerSettings.h
Include #include "SequencerSettings.h"

Syntax

class USequencerSettings : public UObject

Remarks

Serializable options for sequencer.

Variables

  Type Name Description
Protected variable EAllowEditsMode AllowEditsMode Allow edits mode.
Protected variable EAutoChangeMode AutoChangeMode The auto change mode (auto-key, auto-track or none).
Protected variable bool bActivateRealtimeViewports When enabled, sequencer will activate 'Realtime' in viewports
Protected variable bool bAutoExpandNodesOnSelection Whether to expand the sequencer tree view when a child element is selected (from outside of the tree view).
Protected variable bool bAutoScrollEnabled Enable or disable auto scroll in the timeline when playing.
Protected variable bool bAutoSetTrackDefaults Whether or not track defaults will be automatically set when modifying tracks.
Protected variable bool bCleanPlaybackMode When enabled, sequencer will playback in clean mode (game view, hide viewport UI)
Protected variable bool bCompileDirectorOnEvaluate Whether to recompile the director blueprint when the sequence is evaluated (if one exists)
Protected variable bool bCreateSpawnableCameras Enable or disable creating of spawnable cameras whenever cameras are created.
Protected variable bool bDeleteKeysWhenTrimming Enable or disable deleting keys that fall beyond the section range when trimming.
Protected variable bool bDisableSectionsAfterBaking Whether to disable sections after baking as opposed to deleting.
Protected variable bool bEvaluateSubSequencesInIsolation When enabled, entering a sub sequence will evaluate that sub sequence in isolation, rather than from the root sequence
Protected variable bool bInfiniteKeyAreas Enable or disable setting key area sections as infinite by default.
Protected variable bool bIsolateCurveEditorToSelection When enabled, changing the sequencer tree selection will isolate (auto-filter) the selected nodes in the curve editor.
Protected variable bool bIsSnapEnabled Enable or disable snapping in the timeline.
Protected variable bool bKeepCursorInPlayRangeWhileScrubbing Enable or disable keeping the playhead in the current playback range while scrubbing.
Protected variable bool bKeepPlayRangeInSectionBounds Enable or disable keeping the playback range constrained to the section bounds.
Protected variable bool bLeftMouseDragDoesMarquee Defines whether left mouse drag does marquee select instead of camera orbit
Protected variable bool bLinkCurveEditorTimeRange Enable or disable linking the curve editor time range to the sequencer timeline's time range.
Protected variable bool bRerunConstructionScripts When enabled, construction scripts will be rerun on bound actors for every frame
Protected variable bool bResetPlayheadWhenNavigating Enable or disable resetting the playhead when navigating in and out of subsequences.
Protected variable bool bRewindOnRecord Defines whether to jump back to the start of the sequence when a recording is started
Protected variable bool bShowChannelColors Enable or disable displaying channel bar colors for the key bars.
Protected variable bool bShowDebugVisualization Enable or disable showing of debug visualization.
Protected variable bool bShowKeyBars Enable or disable key bar connections.
Protected variable bool bShowLayerBars Enable or disable the layer bars to edit keyframes in bulk.
Protected variable bool bShowRangeSlider Show the in/out range in the timeline with respect to the start/end range.
Protected variable bool bShowSelectedNodesOnly Only show selected nodes in the tree view.
Protected variable bool bShowSequencerToolbar Enable or disable displaying the sequencer toolbar.
Protected variable bool bShowStatusBar Enable or disable displaying the status bar for number of items.
Protected variable bool bShowTickLines Enable or disable displaying the tick lines.
Protected variable bool bSnapCurveValueToInterval Enable or disable snapping the curve value to the curve value interval.
Protected variable bool bSnapKeysAndSectionsToPlayRange Enable or disable keeping keys and sections in the playback range.
Protected variable bool bSnapKeyTimesToInterval Enable or disable snapping keys to the time snapping interval.
Protected variable bool bSnapKeyTimesToKeys Enable or disable snapping keys to other keys.
Protected variable bool bSnapPlayTimeToDraggedKey Enable or disable snapping the playhead to the dragged key.
Protected variable bool bSnapPlayTimeToInterval Enable or disable snapping the playhead to the time snapping interval while scrubbing.
Protected variable bool bSnapPlayTimeToKeys Enable or disable snapping the playhead to keys while scrubbing.
Protected variable bool bSnapPlayTimeToMarkers Enable or disable snapping the playhead to markers while scrubbing.
Protected variable bool bSnapPlayTimeToPressedKey Enable or disable snapping the playhead to the pressed key.
Protected variable bool bSnapPlayTimeToSections Enable or disable snapping the playhead to section bounds while scrubbing.
Protected variable bool bSnapSectionTimesToInterval Enable or disable snapping sections to the time snapping interval.
Protected variable bool bSnapSectionTimesToSections Enable or disable snapping sections to other sections.
Protected variable bool bSynchronizeCurveEditorSelection When enabled, changing the sequencer tree selection will also select the relevant nodes in the curve editor tree if possible.
Protected variable bool bVisualizePreAndPostRoll Enable or disable showing of pre and post roll visualization.
Protected variable float CurveValueSnapInterval The curve value interval to snap to.
Protected variable EFrameNumberDisplayFormats FrameNumberDisplayFormat What format do we display time in to the user?
Protected variable TOptional< float > GridSpacing Grid line spacing state
Protected variable FFrameNumber JumpFrameIncrement The number of frames to jump by when jumping forward or backwards.
Protected variable FString KeyAreaCurveExtents The key area curve extents, stored per channel name
Protected variable float KeyAreaHeightWithCurves The key area height when showing curves
Protected variable EKeyGroupMode KeyGroupMode Key group mode.
Protected variable EMovieSceneKeyInterpolation KeyInterpolation The interpolation type for newly created keyframes
Protected variable TEnumAsByte< ESequencerLoopMode > LoopMode The loop mode of the playback in timeline.
Protected variable FString MovieRendererName Which movie renderer to use
Protected variable FOnAllowEditsModeChanged OnAllowEditsModeChangedEvent  
Protected variable FOnEvaluateSubSequencesInIsolationChanged OnEvaluateSubSequencesInIsolationChangedEvent  
Protected variable FOnLoopStateChanged OnLoopStateChangedEvent  
Protected variable FOnShowSelectedNodesOnlyChanged OnShowSelectedNodesOnlyChangedEvent  
Protected variable FOnTimeDisplayFormatChanged OnTimeDisplayFormatChangedEvent  
Protected variable float ReduceKeysTolerance The tolerance to use when reducing keys
Protected variable TArray< FColor > SectionColorTints Section color tints
Protected variable TEnumAsByte< ESequencerSpawnPosition > SpawnPosition The default location of a spawnable when it is first dragged into the viewport from the content browser.
Protected variable TArray< FString > TrackFilters The track filters that are enabled
Protected variable uint32 TrajectoryPathCap Specifies the maximum number of keys to draw when rendering trajectories in viewports
Protected variable float TreeViewWidth The tree view width percentage
Protected variable uint8 ZeroPadFrames The number of zeros to pad the frame numbers by.
Protected variable TEnumAsByte< ESequencerZoomPosition > ZoomPosition Whether to zoom in on the current position or the current time in the timeline.

Constructors

  Type Name Description
Public function  

USequencerSettings ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const EAllowEditsMode Gets the current allow edits mode.
Public function Const EAutoChangeMode Gets the current auto change mode.
Public function Const bool Gets whether or not to expand the outliner tree view when a child element is selected (from outside of the tree view).
Public function Const bool Gets whether or not auto-scroll is enabled when playing.
Public function Const bool Gets whether or not track defaults will be automatically set when modifying tracks.
Public function Const bool  
Public function Const bool Get whether to create spawnable cameras.
Public function Const float Gets the snapping interval for curve values.
Public function Const bool  
Public function Const bool  
Public function Const TOptional< float > Gets the state for spacing between grid lines
Public function Const bool  
Public function Const bool Gets whether or not snapping is enabled.
Public function Const FFrameNumber Get the number of frames to increment when jumping forwards/backwards
Public function Const void

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

  
Public function Const float  
Public function Const EKeyGroupMode Returns what channels will get keyed when one channel changes
Public function Const EMovieSceneKeyInterpolation Get the default Interpolation type for newly created keyframes if the channel does not already have keyframes
Public function Const bool Gets whether left mouse drag does marquee select instead of camera orbit and ALT always moves the camera
Public function Const bool Gets whether or not to link the curve editor time range.
Public function Const ESequencerLoopMode Gets the loop mode.
Public function Const FString What movie renderer to use
Public function FOnAllowEditsModeChanged & Gets the multicast delegate which is run whenever the allow edits mode is changed.
Public function FOnEvaluateSubSequencesInIsolationChanged & Gets the multicast delegate which is run whenever evaluate sub sequences in isolation is changed.
Public function FOnLoopStateChanged &  
Public function FOnShowSelectedNodesOnlyChanged &  
Public function FOnTimeDisplayFormatChanged &  
Public function Const float  
Public function Const TArray< FColor >  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Gets whether or not to show the time range slider.
Public function Const bool Gets whether or not to show selected nodes only.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Gets whether or not to snap curve values to the interval.
Public function Const bool  
Public function Const bool Gets whether or not to snap key times to the interval.
Public function Const bool Gets whether or not to snap keys to other keys.
Public function Const bool Gets whether or not to snap the play time to the dragged key.
Public function Const bool Gets whether or not to snap the play time to the interval while scrubbing.
Public function Const bool Gets whether or not to snap the play time to keys while scrubbing.
Public function Const bool Gets whether or not to snap the play time to markers while scrubbing.
Public function Const bool Gets whether or not to snap the play time to the pressed key.
Public function Const bool Gets whether or not to snap the play time to section bounds while scrubbing.
Public function Const bool Gets whether or not to snap sections to the interval.
Public function Const bool Gets whether or not to snap sections to other sections.
Public function Const ESequencerSpawnPosition Get initial spawn position.
Public function Const EFrameNumberDisplayFormats What format should we display the UI controls in when representing time in a sequence?
Public function Const uint32  
Public function Const float Gets the tree view width percentage
Public function Const uint8 Get the number of digits we should zero-pad to when showing frame numbers in sequencer
Public function Const ESequencerZoomPosition Get zoom in/out position (mouse position or current time).
Public function Const bool

HasKeyAreaCurveExtents ( const FString& ChannelName
)

  
Public function void

IsolateCurveEditorToSelection ( bool bInIsolateCurveEditorToSelection
)

 Assign whether we should filter the curve editor tree to only nodes that are relevant to the current sequencer selection
Public function Const bool

IsTrackFilterEnabled ( const FString& TrackFilter
)

 Gets whether the given track filter is enabled
Public function void

RemoveKeyAreaCurveExtents ( const FString& ChannelName
)

 @ Remove curve extents for the given channel
Public function void

SetActivateRealtimeViewports ( bool bInActivateRealtimeViewports
)

 Toggle whether to allow possession of PIE viewports
Public function void

SetAllowEditsMode ( EAllowEditsMode AllowEditsMode
)

 Sets the current auto-key mode.
Public function void

SetAutoChangeMode ( EAutoChangeMode AutoChangeMode
)

 Sets the current auto change mode.
Public function 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).
Public function void

SetAutoScrollEnabled ( bool bInAutoScrollEnabled
)

 Sets whether or not auto-scroll is enabled when playing.
Public function void

SetAutoSetTrackDefaults ( bool bInAutoSetTrackDefaults
)

 Sets whether or not track defaults will be automatically set when modifying tracks.
Public function void

SetCleanPlaybackMode ( bool bInCleanPlaybackMode
)

 Toggle whether to playback in clean mode
Public function void

SetCompileDirectorOnEvaluate ( bool bInCompileDirectorOnEvaluate
)

 Assign whether whether to recompile the director blueprint when the sequence is evaluated (if one exists)
Public function void

SetCreateSpawnableCameras ( bool bInCreateSpawnableCameras
)

 Set whether to create spawnable cameras.
Public function void

SetCurveValueSnapInterval ( float InCurveValueSnapInterval
)

 Sets the snapping interval for curve values.
Public function void

SetDeleteKeysWhenTrimming ( bool bInDeleteKeysWhenTrimming
)

 Set whether to delete keys that fall beyond the section range when trimming
Public function void

SetDisableSectionsAfterBaking ( bool bInDisableSectionsAfterBaking
)

 Set whether to disable sections when baking, as opposed to deleting
Public function void

SetEvaluateSubSequencesInIsolation ( bool bInEvaluateSubSequencesInIsolation
)

 Set whether to evaluate sub sequences in isolation
Public function void

SetGridSpacing ( TOptional< float > InGridSpacing
)

 Sets the grid line spacing state
Public function void

SetInfiniteKeyAreas ( bool bInInfiniteKeyAreas
)

 Set whether to show channel colors
Public function void

SetIsSnapEnabled ( bool InbIsSnapEnabled
)

 Sets whether or not snapping is enabled.
Public function void

SetJumpFrameIncrement ( FFrameNumber InJumpFrameIncrement
)

 Set the number of frames to increment when jumping forwards/backwards
Public function void

SetKeepCursorInPlayRangeWhileScrubbing ( bool bInKeepCursorInPlayRangeWhileScrubbing
)

 Set whether or not the cursor should be kept within the playback range while scrubbing in sequencer
Public function void

SetKeepPlayRangeInSectionBounds ( bool bInKeepPlayRangeInSectionBounds
)

 Set whether or not the playback range should be synced to the section bounds
Public function void

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

 Set the key area curve extents for the given channel
Public function void

SetKeyAreaHeightWithCurves ( float InKeyAreaHeightWithCurves
)

 Set the key area height when showing curves
Public function void

SetKeyGroupMode ( EKeyGroupMode
)

 Sets which channels are keyed when a channel is keyed
Public function void

SetKeyInterpolation ( EMovieSceneKeyInterpolation InKeyInterpolation
)

 Sets default key interpolation for creating new keys on empty channels
Public function void

SetLeftMouseDragDoesMarque ( bool bDoMarque
)

 Sets whether left mouse drag does marquee select instead of camera orbit and ALT always moves the camera
Public function void

SetLinkCurveEditorTimeRange ( bool InbLinkCurveEditorTimeRange
)

 Sets whether or not to link the curve editor time range.
Public function void

SetLoopMode ( ESequencerLoopMode InLoopMode
)

 Sets the loop mode.
Public function void

SetMovieRendererName ( const FString& InMovieRendererName
)

 Sets the movie renderer to use
Public function void

SetReduceKeysTolerance ( float InReduceKeysTolerance
)

 Set the tolerance to use when reducing keys
Public function void

SetRerunConstructionScripts ( bool bInRerunConstructionScripts
)

 Set whether to rerun construction scripts on bound actors every frame
Public function void

SetResetPlayheadWhenNavigating ( bool bInResetPlayheadWhenNavigating
)

 Set whether or not the cursor should be reset when navigating in and out of subsequences
Public function void

SetSectionColorTints ( const TArray< FColor >& InSectionColorTints
)

 Set the section color tints
Public function void

SetShouldShowPrePostRoll ( bool bInVisualizePreAndPostRoll
)

 Toggle whether to show pre and post roll in sequencer
Public function void

SetShowChannelColors ( bool bInShowChannelColors
)

 Set whether to show channel colors for the key bars
Public function void

SetShowDebugVisualization ( bool bInShowDebugVisualization
)

 Toggle whether to show debug vis
Public function void

SetShowKeyBars ( bool bInShowKeyBars
)

 Set whether to show key bars
Public function void

SetShowLayerBars ( bool bInShowLayerBars
)

 Set whether to show layer bars
Public function void

SetShowRangeSlider ( bool InbShowRangeSlider
)

 Sets whether or not to show frame numbers.
Public function void

SetShowSelectedNodesOnly ( bool Visible
)

 Sets whether or not to show selected nodes only.
Public function void

SetShowSequencerToolbar ( bool bInDrawTickLines
)

 Set whether to show sequencer toolbar bar
Public function void

SetShowStatusBar ( bool bInShowStatusBar
)

 Set whether to show status bar
Public function void

SetShowTickLines ( bool bInDrawTickLines
)

 Set whether to show status bar
Public function void

SetSnapCurveValueToInterval ( bool InbSnapCurveValueToInterval
)

 Sets whether or not to snap curve values to the interval.
Public function void

SetSnapKeysAndSectionsToPlayRange ( bool bInSnapKeysAndSectionsToPlayRange
)

 Set whether or not keys and sections should be kept within the playback range when moving them
Public function void

SetSnapKeyTimesToInterval ( bool InbSnapKeyTimesToInterval
)

 Sets whether or not to snap keys to the interval.
Public function void

SetSnapKeyTimesToKeys ( bool InbSnapKeyTimesToKeys
)

 Sets whether or not to snap keys to other keys.
Public function void

SetSnapPlayTimeToDraggedKey ( bool InbSnapPlayTimeToDraggedKey
)

 Sets whether or not to snap the play time to the dragged key.
Public function void

SetSnapPlayTimeToInterval ( bool InbSnapPlayTimeToInterval
)

 Sets whether or not to snap the play time to the interval while scrubbing.
Public function void

SetSnapPlayTimeToKeys ( bool InbSnapPlayTimeToKeys
)

 Sets whether or not to snap the play time to keys while scrubbing.
Public function void

SetSnapPlayTimeToMarkers ( bool InbSnapPlayTimeToMarkers
)

 Sets whether or not to snap the play time to markers while scrubbing.
Public function void

SetSnapPlayTimeToPressedKey ( bool InbSnapPlayTimeToPressedKey
)

 Sets whether or not to snap the play time to the pressed key.
Public function void

SetSnapPlayTimeToSections ( bool InbSnapPlayTimeToSections
)

 Sets whether or not to snap the play time to section bounds while scrubbing.
Public function void

SetSnapSectionTimesToInterval ( bool InbSnapSectionTimesToInterval
)

 Sets whether or not to snap sections to the interval.
Public function void

SetSnapSectionTimesToSections ( bool InbSnapSectionTimesToSections
)

 Sets whether or not to snap sections to other sections.
Public function void

SetSpawnPosition ( ESequencerSpawnPosition InSpawnPosition
)

 Set initial spawn position.
Public function void

SetTimeDisplayFormat ( EFrameNumberDisplayFormats InFormat
)

 Sets the time display format to the specified type.
Public function void

SetTrackFilterEnabled ( const FString& TrackFilter,
bool bEnabled
)

 Sets whether the track filter should be enabled/disabled
Public function void

SetTreeViewWidth ( float InTreeViewWidth
)

 Sets the tree view width percentage
Public function void

SetZeroPadFrames ( uint8 InZeroPadFrames
)

 Set the number of digits we should zero-pad to when showing frame numbers in sequencer
Public function void

SetZoomPosition ( ESequencerZoomPosition InZoomPosition
)

 Set zoom in/out position (mouse position or current time).
Public function Const bool  
Public function Const bool Check whether whether to recompile the director blueprint when the sequence is evaluated (if one exists)
Public function Const bool  
Public function Const bool Return true if we should filter the curve editor tree to only nodes that are relevant to the current sequencer selection
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Check whether to show pre and post roll in sequencer
Public function Const bool Return true if we are to synchronize the curve editor and sequencer trees
Public function Const float

SnapTimeToInterval ( float InTimeValue
)

 Snaps a time value in seconds to the currently selected interval.
Public function void

SyncCurveEditorSelection ( bool bInSynchronizeCurveEditorSelection
)

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

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Typedefs

Name Description
FOnAllowEditsModeChanged  
FOnEvaluateSubSequencesInIsolationChanged  
FOnLoopStateChanged  
FOnShowSelectedNodesOnlyChanged  
FOnTimeDisplayFormatChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page