Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > Sequencer > USequencerSettings

Light Theme

Dark Theme

USequencerSettings

Serializable options for sequencer.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USequencerSettings

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

	Name	Description
EAllowEditsMode	AllowEditsMode	Allow edits mode.
EAutoChangeMode	AutoChangeMode	The auto change mode (auto-key, auto-track or none).
bool	bActivateRealtimeViewports	When enabled, sequencer will activate 'Realtime' in viewports
bool	bAutoScrollEnabled	Enable or disable auto scroll in the timeline when playing.
bool	bAutoSetTrackDefaults	Whether or not track defaults will be automatically set when modifying tracks.
bool	bCleanPlaybackMode	When enabled, sequencer will playback in clean mode (game view, hide viewport UI)
bool	bCompileDirectorOnEvaluate	Whether to recompile the director blueprint when the sequence is evaluated (if one exists)
bool	bCreateSpawnableCameras	Enable or disable creating of spawnable cameras whenever cameras are created.
bool	bDeleteKeysWhenTrimming	Enable or disable deleting keys that fall beyond the section range when trimming.
bool	bEvaluateSubSequencesInIsolation	When enabled, entering a sub sequence will evaluate that sub sequence in isolation, rather than from the master sequence
bool	bInfiniteKeyAreas	Enable or disable setting key area sections as infinite by default.
bool	bIsolateCurveEditorToSelection	When enabled, changing the sequencer tree selection will isolate (auto-filter) the selected nodes in the curve editor.
bool	bIsSnapEnabled	Enable or disable snapping in the timeline.
bool	bKeepCursorInPlayRange	Enable or disable keeping the cursor in the current playback range during playback.
bool	bKeepCursorInPlayRangeWhileScrubbing	Enable or disable keeping the cursor in the current playback range while scrubbing.
bool	bKeepPlayRangeInSectionBounds	Enable or disable keeping the playback range constrained to the section bounds.
bool	bKeyInterpPropertiesOnly	Enable or disable only keyframing properties marked with the 'Interp' keyword.
bool	bLinkCurveEditorTimeRange	Enable or disable linking the curve editor time range to the sequencer timeline's time range.
bool	bRerunConstructionScripts	When enabled, construction scripts will be rerun on bound actors for every frame
bool	bRewindOnRecord	Defines whether to jump back to the start of the sequence when a recording is started
bool	bShowChannelColors	Enable or disable displaying channel bar colors for vector properties.
bool	bShowCombinedKeyframes	Enable or disable the combined keyframes at the top node level.
bool	bShowDebugVisualization	Enable or disable showing of debug visualization.
bool	bShowOutlinerInfoColumn	Whether to show the sequencer outliner info column
bool	bShowRangeSlider	Show the in/out range in the timeline with respect to the start/end range.
bool	bShowSelectedNodesOnly	Only show selected nodes in the tree view.
bool	bSnapCurveValueToInterval	Enable or disable snapping the curve value to the curve value interval.
bool	bSnapKeysAndSectionsToPlayRange	Enable or disable keeping keys and sections in the playback range.
bool	bSnapKeyTimesToInterval	Enable or disable snapping keys to the time snapping interval.
bool	bSnapKeyTimesToKeys	Enable or disable snapping keys to other keys.
bool	bSnapPlayTimeToDraggedKey	Enable or disable snapping the current time to the dragged key.
bool	bSnapPlayTimeToInterval	Enable or disable snapping the current time to the time snapping interval while scrubbing.
bool	bSnapPlayTimeToKeys	Enable or disable snapping the current time to keys of the selected track while scrubbing.
bool	bSnapPlayTimeToPressedKey	Enable or disable snapping the current time to the pressed key.
bool	bSnapSectionTimesToInterval	Enable or disable snapping sections to the time snapping interval.
bool	bSnapSectionTimesToSections	Enable or disable snapping sections to other sections.
bool	bSynchronizeCurveEditorSelection	When enabled, changing the sequencer tree selection will also select the relevant nodes in the curve editor tree if possible.
bool	bVisualizePreAndPostRoll	Enable or disable showing of pre and post roll visualization.
float	CurveValueSnapInterval	The curve value interval to snap to.
EFrameNumberDis...	FrameNumberDisplayFormat	What format do we display time in to the user?
TOptional< floa...	GridSpacing	Grid line spacing state
EKeyGroupMode	KeyGroupMode	Key group mode.
EMovieSceneKeyI...	KeyInterpolation	The interpolation type for newly created keyframes
TEnumAsByte< ES...	LoopMode	The loop mode of the playback in timeline.
FOnAllowEditsMo...	OnAllowEditsModeChangedEvent
FOnEvaluateSubS...	OnEvaluateSubSequencesInIsolationChangedEvent
FOnLoopStateCha...	OnLoopStateChangedEvent
FOnShowSelected...	OnShowSelectedNodesOnlyChangedEvent
TEnumAsByte< ES...	SpawnPosition	The default location of a spawnable when it is first dragged into the viewport from the content browser.
uint32	TrajectoryPathCap	Specifies the maximum number of keys to draw when rendering trajectories in viewports
uint8	ZeroPadFrames	The number of zeros to pad the frame numbers by.
TEnumAsByte< ES...	ZoomPosition	Whether to zoom in on the current position or the current time in the timeline.

Constructors

	Name	Description
	USequencerSettings ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
EAllowEditsM...	GetAllowEditsMode()	Gets the current allow edits mode.
EAutoChangeM...	GetAutoChangeMode()	Gets the current auto change mode.
bool	GetAutoScrollEnabled()	Gets whether or not auto-scroll is enabled when playing.
bool	GetAutoSetTrackDefaults()	Gets whether or not track defaults will be automatically set when modifying tracks.
bool	GetCleanPlaybackMode()
bool	GetCreateSpawnableCameras()	Get whether to create spawnable cameras.
float	GetCurveValueSnapInterval()	Gets the snapping interval for curve values.
bool	GetDeleteKeysWhenTrimming()
TOptional< f...	GetGridSpacing()	Gets the state for spacing between grid lines
bool	GetInfiniteKeyAreas()
bool	GetIsSnapEnabled()	Gets whether or not snapping is enabled.
EKeyGroupMod...	GetKeyGroupMode()	Returns what channels will get keyed when one channel changes
EMovieSceneK...	GetKeyInterpolation()	Gets default key interpolation.
bool	GetKeyInterpPropertiesOnly()	Gets whether or not to key interp properties only.
bool	GetLinkCurveEditorTimeRange()	Gets whether or not to link the curve editor time range.
ESequencerLo...	GetLoopMode()	Gets the loop mode.
FOnAllowEdit...	GetOnAllowEditsModeChanged()	Gets the multicast delegate which is run whenever the allow edits mode is changed.
FOnEvaluateS...	GetOnEvaluateSubSequencesInIsolationChanged()	Gets the multicast delegate which is run whenever evaluate sub sequences in isolation is changed.
FOnLoopState...	GetOnLoopStateChanged()
FOnShowSelec...	GetOnShowSelectedNodesOnlyChanged()
bool	GetShowChannelColors()
bool	GetShowCombinedKeyframes()
bool	GetShowOutlinerInfoColumn()	Gets whether to show the sequencer outliner info column
bool	GetShowRangeSlider()	Gets whether or not to show the time range slider.
bool	GetShowSelectedNodesOnly()	Gets whether or not to show selected nodes only.
bool	GetSnapCurveValueToInterval()	Gets whether or not to snap curve values to the interval.
bool	GetSnapKeysAndSectionsToPlayRange()
bool	GetSnapKeyTimesToInterval()	Gets whether or not to snap key times to the interval.
bool	GetSnapKeyTimesToKeys()	Gets whether or not to snap keys to other keys.
bool	GetSnapPlayTimeToDraggedKey()	Gets whether or not to snap the play time to the dragged key.
bool	GetSnapPlayTimeToInterval()	Gets whether or not to snap the play time to the interval while scrubbing.
bool	GetSnapPlayTimeToKeys()	Gets whether or not to snap the play time to keys while scrubbing.
bool	GetSnapPlayTimeToPressedKey()	Gets whether or not to snap the play time to the pressed key.
bool	GetSnapSectionTimesToInterval()	Gets whether or not to snap sections to the interval.
bool	GetSnapSectionTimesToSections()	Gets whether or not to snap sections to other sections.
ESequencerSp...	GetSpawnPosition()	Get initial spawn position.
EFrameNumber...	GetTimeDisplayFormat()	What format should we display the UI controls in when representing time in a sequence?
uint32	GetTrajectoryPathCap()
uint8	GetZeroPadFrames()	Get the number of digits we should zero-pad to when showing frame numbers in sequencer
ESequencerZo...	GetZoomPosition()	Get zoom in/out position (mouse position or current time).
void	IsolateCurveEditorToSelection ( bool bInIsolateCurveEditorToSelecti... )	Assign whether we should filter the curve editor tree to only nodes that are relevant to the current sequencer selection
void	SetActivateRealtimeViewports ( bool bInActivateRealtimeViewports )	Toggle whether to allow possession of PIE viewports
void	SetAllowEditsMode ( EAllowEditsMode AllowEditsMode )	Sets the current auto-key mode.
void	SetAutoChangeMode ( EAutoChangeMode AutoChangeMode )	Sets the current auto change mode.
void	SetAutoScrollEnabled ( bool bInAutoScrollEnabled )	Sets whether or not auto-scroll is enabled when playing.
void	SetAutoSetTrackDefaults ( bool bInAutoSetTrackDefaults )	Sets whether or not track defaults will be automatically set when modifying tracks.
void	SetCleanPlaybackMode ( bool bInCleanPlaybackMode )	Toggle whether to playback in clean mode
void	SetCompileDirectorOnEvaluate ( bool bInCompileDirectorOnEvaluate )	Assign whether whether to recompile the director blueprint when the sequence is evaluated (if one exists)
void	SetCreateSpawnableCameras ( bool bInCreateSpawnableCameras )	Set whether to create spawnable cameras.
void	SetCurveValueSnapInterval ( float InCurveValueSnapInterval )	Sets the snapping interval for curve values.
void	SetDeleteKeysWhenTrimming ( bool bInDeleteKeysWhenTrimming )	Set whether to delete keys that fall beyond the section range when trimming
void	SetEvaluateSubSequencesInIsolation ( bool bInEvaluateSubSequencesInIsola... )	Set whether to evaluate sub sequences in isolation
void	SetGridSpacing ( TOptional< float > InGridSpacing )	Sets the grid line spacing state
void	SetInfiniteKeyAreas ( bool bInInfiniteKeyAreas )	Set whether to show channel colors
void	SetIsSnapEnabled ( bool InbIsSnapEnabled )	Sets whether or not snapping is enabled.
void	SetKeepCursorInPlayRange ( bool bInKeepCursorInPlayRange )	Set whether or not the cursor should be kept within the playback range during playback in sequencer
void	SetKeepCursorInPlayRangeWhileScrubbing ( bool bInKeepCursorInPlayRangeWhileS... )	Set whether or not the cursor should be kept within the playback range while scrubbing in sequencer
void	SetKeepPlayRangeInSectionBounds ( bool bInKeepPlayRangeInSectionBound... )	Set whether or not the playback range should be synced to the section bounds
void	SetKeyGroupMode ( EKeyGroupMode )	Sets which channels are keyed when a channel is keyed
void	SetKeyInterpolation ( EMovieSceneKeyInterpolation InKeyIn... )	Sets default key interpolation
void	SetKeyInterpPropertiesOnly ( bool InbKeyInterpPropertiesOnly )	Sets whether or not to key interp properties only.
void	SetLinkCurveEditorTimeRange ( bool InbLinkCurveEditorTimeRange )	Sets whether or not to link the curve editor time range.
void	SetLoopMode ( ESequencerLoopMode InLoopMode )	Sets the loop mode.
void	SetRerunConstructionScripts ( bool bInRerunConstructionScripts )	Set whether to rerun construction scripts on bound actors every frame
void	SetRewindOnRecord ( bool bInRewindOnRecord )	Sets whether to jump to the start of the sequence when we start a recording.
void	SetShouldShowPrePostRoll ( bool bInVisualizePreAndPostRoll )	Toggle whether to show pre and post roll in sequencer
void	SetShowChannelColors ( bool bInShowChannelColors )	Set whether to show channel colors
void	SetShowCombinedKeyframes ( bool bInShowCombinedKeyframes )	Set whether to show combined keyframes at the top node
void	SetShowDebugVisualization ( bool bInShowDebugVisualization )	Toggle whether to show debug vis
void	SetShowOutlinerInfoColumn ( bool bInShowOutlinerInfoColumn )	Sets whether to show the sequencer outliner info column
void	SetShowRangeSlider ( bool InbShowRangeSlider )	Sets whether or not to show frame numbers.
void	SetShowSelectedNodesOnly ( bool Visible )	Sets whether or not to show selected nodes only.
void	SetSnapCurveValueToInterval ( bool InbSnapCurveValueToInterval )	Sets whether or not to snap curve values to the interval.
void	SetSnapKeysAndSectionsToPlayRange ( bool bInSnapKeysAndSectionsToPlayRa... )	Set whether or not keys and sections should be kept within the playback range when moving them
void	SetSnapKeyTimesToInterval ( bool InbSnapKeyTimesToInterval )	Sets whether or not to snap keys to the interval.
void	SetSnapKeyTimesToKeys ( bool InbSnapKeyTimesToKeys )	Sets whether or not to snap keys to other keys.
void	SetSnapPlayTimeToDraggedKey ( bool InbSnapPlayTimeToDraggedKey )	Sets whether or not to snap the play time to the dragged key.
void	SetSnapPlayTimeToInterval ( bool InbSnapPlayTimeToInterval )	Sets whether or not to snap the play time to the interval while scrubbing.
void	SetSnapPlayTimeToKeys ( bool InbSnapPlayTimeToKeys )	Sets whether or not to snap the play time to keys while scrubbing.
void	SetSnapPlayTimeToPressedKey ( bool InbSnapPlayTimeToPressedKey )	Sets whether or not to snap the play time to the pressed key.
void	SetSnapSectionTimesToInterval ( bool InbSnapSectionTimesToInterval )	Sets whether or not to snap sections to the interval.
void	SetSnapSectionTimesToSections ( bool InbSnapSectionTimesToSections )	Sets whether or not to snap sections to other sections.
void	SetSpawnPosition ( ESequencerSpawnPosition InSpawnPosi... )	Set initial spawn position.
void	SetTimeDisplayFormat ( EFrameNumberDisplayFormats InFormat )	Sets the time display format to the specified type.
void	SetZeroPadFrames ( uint8 InZeroPadFrames )	Set the number of digits we should zero-pad to when showing frame numbers in sequencer
void	SetZoomPosition ( ESequencerZoomPosition InZoomPositi... )	Set zoom in/out position (mouse position or current time).
bool	ShouldActivateRealtimeViewports()
bool	ShouldCompileDirectorOnEvaluate()	Check whether whether to recompile the director blueprint when the sequence is evaluated (if one exists)
bool	ShouldEvaluateSubSequencesInIsolation()
bool	ShouldIsolateToCurveEditorSelection()	Return true if we should filter the curve editor tree to only nodes that are relevant to the current sequencer selection
bool	ShouldKeepCursorInPlayRange()
bool	ShouldKeepCursorInPlayRangeWhileScrubbing()
bool	ShouldKeepPlayRangeInSectionBounds()
bool	ShouldRerunConstructionScripts()
bool	ShouldRewindOnRecord()	Gets whether to jump to the start of the sequence when we start a recording or not.
bool	ShouldShowDebugVisualization()
bool	ShouldShowPrePostRoll()	Check whether to show pre and post roll in sequencer
bool	ShouldSyncCurveEditorSelection()	Return true if we are to synchronize the curve editor and sequencer trees
float	SnapTimeToInterval ( float InTimeValue )	Snaps a time value in seconds to the currently selected interval.
void	SyncCurveEditorSelection ( bool bInSynchronizeCurveEditorSelec... )	Assign whether we are to synchronize the curve editor and sequencer trees

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally

Typedefs

Name	Description
FOnAllowEditsModeChanged
FOnEvaluateSubSequencesInIsolationChanged
FOnLoopStateChanged
FOnShowSelectedNodesOnlyChanged

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss