bShowRangeSlider

bShowRangeSlider

#Overview

name: bShowRangeSlider

The value of this variable can be defined or overridden in .ini config files. 6 .ini config files referencing this setting variable.

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of bShowRangeSlider is to control the visibility of the in/out range slider in the Sequencer timeline within Unreal Engine 5’s editor interface.

This setting variable is primarily used by the Sequencer module, which is part of Unreal Engine’s editor toolset for creating and editing cinematic sequences and animations.

The value of this variable is set in the USequencerSettings constructor (SequencerSettings.cpp:16) where it is initialized to false by default. It can be modified through the SetShowRangeSlider function, which also saves the configuration when the value changes.

The bShowRangeSlider variable interacts with other Sequencer settings, such as bIsSnapEnabled and various snapping options, as they are all part of the USequencerSettings class.

Developers should be aware that this variable affects the user interface of the Sequencer tool. Changing its value will directly impact the visibility of the range slider in the timeline, which can affect the workflow for content creators working with cinematic sequences.

Best practices when using this variable include:

  1. Consider user preferences when deciding whether to show or hide the range slider by default.
  2. Provide a way for users to toggle this setting within the Sequencer interface for flexibility.
  3. Ensure that hiding the range slider doesn’t impede essential functionality for timeline manipulation.
  4. When modifying this setting programmatically, use the SetShowRangeSlider function to ensure proper configuration saving.
  5. Be mindful of how this setting interacts with other Sequencer settings to maintain a consistent and intuitive user experience.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:851, section: [LevelSequenceEditor SequencerSettings]

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:859, section: [TemplateSequenceEditor SequencerSettings]

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:867, section: [TakeRecorderSequenceEditor SequencerSettings]

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:877, section: [EmbeddedActorSequenceEditor SequencerSettings]

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:888, section: [NiagaraSequenceEditor SequencerSettings]

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:904, section: [DaySequenceEditor SequencerSettings]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Editor/Sequencer/Private/SequencerSettings.cpp:16

Scope (from outer to inner):

file
function     USequencerSettings::USequencerSettings

Source code excerpt:

	SpawnPosition = SSP_Origin;
	bCreateSpawnableCameras = true;
	bShowRangeSlider = false;
	bIsSnapEnabled = true;
	bSnapKeyTimesToInterval = true;
	bSnapKeyTimesToKeys = true;
	bSnapSectionTimesToInterval = true;
	bSnapSectionTimesToSections = true;
	bSnapPlayTimeToKeys = false;

#Loc: <Workspace>/Engine/Source/Editor/Sequencer/Private/SequencerSettings.cpp:171

Scope (from outer to inner):

file
function     bool USequencerSettings::GetShowRangeSlider

Source code excerpt:

bool USequencerSettings::GetShowRangeSlider() const
{
	return bShowRangeSlider;
}

void USequencerSettings::SetShowRangeSlider(bool InbShowRangeSlider)
{
	if ( bShowRangeSlider != InbShowRangeSlider )
	{
		bShowRangeSlider = InbShowRangeSlider;
		SaveConfig();
	}
}

bool USequencerSettings::GetIsSnapEnabled() const
{

#Loc: <Workspace>/Engine/Source/Editor/Sequencer/Public/SequencerSettings.h:506

Scope (from outer to inner):

file
class        class USequencerSettings : public UObject

Source code excerpt:

	/** Show the in/out range in the timeline with respect to the start/end range. */
	UPROPERTY( config, EditAnywhere, Category=Timeline )
	bool bShowRangeSlider;

	/** Enable or disable snapping in the timeline. */
	UPROPERTY( config, EditAnywhere, Category=Snapping )
	bool bIsSnapEnabled;

	/** Enable or disable snapping keys to the time snapping interval. */