Navigation
API > API/Editor > API/Editor/WorldBookmark
World Bookmarks are assets that stores the state of the editor world.
| Name | UWorldBookmark |
| Type | class |
| Header File | /Engine/Source/Editor/WorldBookmark/Public/WorldBookmark/WorldBookmark.h |
| Include Path | #include "WorldBookmark/WorldBookmark.h" |
Syntax
UCLASS (MinimalAPI, Config=UserWorldBookmarks, PerObjectConfig)
class UWorldBookmark : public UBookmarkBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UBookmarkBase → UWorldBookmark
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UWorldBookmark
(
const FObjectInitializer& ObjectInitializer |
WorldBookmark/WorldBookmark.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFavorite | bool | User favorite. | WorldBookmark/WorldBookmark.h |
|
| BookmarkAssetPath | FString | Unused - The sole purpose of this property is to help users who would want to investigate/make changes to the ini themselves, as GUIDs are pretty opaque. | WorldBookmark/WorldBookmark.h |
|
| BookmarkGuid | FGuid | BookmarkGuid is our key to fetch the user settings for this bookmark in the Bookmarks.ini config file. | WorldBookmark/WorldBookmark.h |
|
| CategoryGuid | FGuid | WorldBookmark/WorldBookmark.h |
|
|
| EditorState | FEditorStateCollection | State of the editor. | WorldBookmark/WorldBookmark.h | |
| LastLoadedTimeStampUTC | FDateTime | Last loaded time (UTC) | WorldBookmark/WorldBookmark.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanLoad
(
FText* FailureReason |
Test whether it's possible to load this bookmark given the current state of the editor. | WorldBookmark/WorldBookmark.h | |
bool CanUpdate
(
FText* FailureReason |
Test whether it's possible to update this bookmark given the current state of the editor. | WorldBookmark/WorldBookmark.h | |
const FWorldBookmarkCategory & GetBookmarkCategory() |
Retrieve the world bookmark category for this bookmark. | WorldBookmark/WorldBookmark.h | |
TEnableIf< TIsDerivedFrom< TEditorStateType, UEditorState >::IsDerived, constTEditorStateType * >::Type GetEditorState() |
WorldBookmark/WorldBookmark.h | ||
bool GetIsUserFavorite() |
Return true if this bookmark was flagged as being a favorite bookmark of the user. | WorldBookmark/WorldBookmark.h | |
FDateTime GetUserLastLoadedTimeStampUTC() |
Retrieve the last time that bookmark was loaded, in UTC. | WorldBookmark/WorldBookmark.h | |
TEnableIf< TIsDerivedFrom< TEditorStateType, UEditorState >::IsDerived, bool >::Type HasEditorState() |
WorldBookmark/WorldBookmark.h | ||
bool HasEditorStates() |
Return true if the world bookmark contains states that can be restored. | WorldBookmark/WorldBookmark.h | |
void Load() |
Load the bookmark data, restoring the editor state (loaded world, camera location, etc) to what is defined by the bookmark. | WorldBookmark/WorldBookmark.h | |
void LoadStates
(
const TArray< TSubclassOf< UEditorState > >& InStatesToLoad |
Load the bookmark data, restoring only a specific set of editor states. | WorldBookmark/WorldBookmark.h | |
void SetIsUserFavorite
(
bool bIsUserFavorite |
Mark this bookmark as being a favorite bookmark of the user. | WorldBookmark/WorldBookmark.h | |
void SetUserLastLoadedTimeStampUTC
(
const FDateTime& InLastLoadedTimeStampUTC |
Store the last time that bookmark was loaded, in UTC. | WorldBookmark/WorldBookmark.h | |
void Update() |
Update the bookmark so that it reflects the current state of the editor. | WorldBookmark/WorldBookmark.h | |
void UpdateStates
(
const TArray< TSubclassOf< UEditorState > >& InStatesToUpdate |
Update a set of states for the bookmark. | WorldBookmark/WorldBookmark.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetCategoryAssetTag() |
Get the asset registry tag used to store bookmark category info. | WorldBookmark/WorldBookmark.h | |
static FSoftObjectPath GetWorldFromAssetData
(
const FAssetData& InAssetData |
Get the world associated with a bookmark's asset data. | WorldBookmark/WorldBookmark.h | |
static FName GetWorldNameAssetTag() |
Get the asset registry tag used to store the matching world's name. | WorldBookmark/WorldBookmark.h |