FrameNumberDisplayFormat

FrameNumberDisplayFormat

#Overview

name: FrameNumberDisplayFormat

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

It is referenced in 4 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of FrameNumberDisplayFormat is to control how frame numbers are displayed in the Unreal Engine Sequencer, which is a part of the cinematics and animation system. This setting determines the format used to represent time in the Sequencer’s user 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:61) with a default value of EFrameNumberDisplayFormats::Seconds. It can be modified through the SetTimeDisplayFormat function, which also saves the configuration and broadcasts a change event.

FrameNumberDisplayFormat interacts with the OnTimeDisplayFormatChangedEvent, which is broadcast when the format is changed. This allows other parts of the system to react to changes in the time display format.

Developers should be aware that changing this setting will affect how time is displayed throughout the Sequencer UI. It’s important to choose a format that best suits the project’s needs and the team’s workflow.

Best practices when using this variable include:

1. Considering the project’s requirements and the team’s familiarity with different time formats when choosing a setting.
2. Being consistent with the chosen format across the project to avoid confusion.
3. If changing the format programmatically, use the SetTimeDisplayFormat function to ensure the change is properly saved and broadcast.
4. Be aware that this setting is config-based (UPROPERTY(config)), meaning it will be saved to the project’s configuration files and persist between editor sessions.

#Setting Variables

#References In INI files

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

• INI Section: LevelSequenceEditor SequencerSettings
• Raw value: Frames
• Is Array: False

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

• INI Section: TemplateSequenceEditor SequencerSettings
• Raw value: Frames
• Is Array: False

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

• INI Section: TakeRecorderSequenceEditor SequencerSettings
• Raw value: NonDropFrameTimecode
• Is Array: False

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

• INI Section: DaySequenceEditor SequencerSettings
• Raw value: Frames
• Is Array: False

#References in C++ code

#Callsites

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

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

Scope (from outer to inner):

file
function     USequencerSettings::USequencerSettings

Source code excerpt:

	bVisualizePreAndPostRoll = true;
	TrajectoryPathCap = 250;
	FrameNumberDisplayFormat = EFrameNumberDisplayFormats::Seconds;
	bAutoExpandNodesOnSelection = true;
	bRestoreOriginalViewportOnCameraCutUnlock = true;
	TreeViewWidth = 0.3f;
	bShowTickLines = true;
	bShowSequencerToolbar = true;
	ViewDensity = "Relaxed";

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

Scope (from outer to inner):

file
function     void USequencerSettings::SetTimeDisplayFormat

Source code excerpt:

void USequencerSettings::SetTimeDisplayFormat(EFrameNumberDisplayFormats InFormat)
{
	if (InFormat != FrameNumberDisplayFormat)
	{
		FrameNumberDisplayFormat = InFormat;
		SaveConfig();
		OnTimeDisplayFormatChangedEvent.Broadcast();
	}
}

void USequencerSettings::SetMovieRendererName(const FString& InMovieRendererName)

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

Scope (from outer to inner):

file
class        class USequencerSettings : public UObject
function     EFrameNumberDisplayFormats GetTimeDisplayFormat

Source code excerpt:

	/** What format should we display the UI controls in when representing time in a sequence? */
	EFrameNumberDisplayFormats GetTimeDisplayFormat() const { return FrameNumberDisplayFormat; }
	/** Sets the time display format to the specified type. */
	void SetTimeDisplayFormat(EFrameNumberDisplayFormats InFormat);

	/** What movie renderer to use */
	FString GetMovieRendererName() const { return MovieRendererName; }
	/** Sets the movie renderer to use */

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

Scope (from outer to inner):

file
class        class USequencerSettings : public UObject

Source code excerpt:

	/** What format do we display time in to the user? */
	UPROPERTY(config, EditAnywhere, Category=General)
	EFrameNumberDisplayFormats FrameNumberDisplayFormat;

	/** Which movie renderer to use */
	UPROPERTY(config, EditAnywhere, Category=General)
	FString MovieRendererName;

	/** Whether to expand the sequencer tree view when a child element is selected (from outside of the tree view). */