Navigation
API > API/Runtime > API/Runtime/Projects
Struct specifying the structure of the records file, this is used to maintain an association between recently opened projects and the location of the editor engine used to open them. This is meant to be a machine wide record to facilitate locating the right engine executable.
Usage:
- QueueUpdate to update the record
- Load to read from the record
| Name | FProjectEditorRecord |
| Type | struct |
| Header File | /Engine/Source/Runtime/Projects/Public/ProjectEditorRecords.h |
| Include Path | #include "ProjectEditorRecords.h" |
Syntax
struct FProjectEditorRecord
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FProjectEditorRecord() |
ProjectEditorRecords.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AsyncUpdateTask | FGraphEventRef | Handle for the latest async task | ProjectEditorRecords.h |
| BaseDirProperty | const FString | Property used to specify the path of the base dir of the engine used for the project | ProjectEditorRecords.h |
| EngineLocationProperty | const FString | Property used to specify the path of the engine used to open the project | ProjectEditorRecords.h |
| EpicAppProperty | const FString | Property used to specify an Epic App | ProjectEditorRecords.h |
| ProjectsProperty | const FString | Property used to specify a Projects list | ProjectEditorRecords.h |
| SubProjectProperty | const FString | Property used to specify a SubProjects list | ProjectEditorRecords.h |
| TimestampProperty | const FString | Property used to specify a last accessed timestamp | ProjectEditorRecords.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ProjectEditorJson | TSharedPtr< FJsonObject > | The json contents of the records loaded/saved to disk | ProjectEditorRecords.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DaysToKeepRecords | const int32 | Number of days that have to pass for an entry to be considered stale and be removed on save | ProjectEditorRecords.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TSharedPtr< FJsonObject > FindOrAddProperty
(
const FString& InProperty |
Finds or adds an object property to the root of the json | ProjectEditorRecords.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FString GetFileLocation() |
Gets the location of the file on disk | ProjectEditorRecords.h | |
static FProjectEditorRecord Load() |
Loads a project editor record from disk, using the default location LOCALAPPDATA%/UnrealEngine/Editor/ProjectEditorRecords.json location can be overriden by cvar r.Editor.ProjectEditorRecordsFile | ProjectEditorRecords.h | |
static TSharedPtr< FJsonObject > MakeDefaultProperties () |
Creates a JsonObject containing the default entries | ProjectEditorRecords.h | |
static void QueueUpdate
(
TUniqueFunction< void(FProjectEditorRecord&)>&& InUpdateFunction |
This is the main way to interact with the json contents to add entries in a safe way. | ProjectEditorRecords.h | |
static void TearDown() |
Waits for any queued async tasks to finish if there are any | ProjectEditorRecords.h |