In Game

A subset of the bookmark functionality can be used in shipped titles. This allows you to collect player feedback with specific locations. All runtime functions can be found in the UFtsViewBookmarkFunctionLibrary. A bookmark is a small struct that holds a string based id, a location vector and rotation vector and a string:string key value map for meta data.

Creating Bookmarks

Several methods exist to create bookmark data.

Function	Description
Create Bookmark from Camera View 🔎 » C++ API	Takes a camera component and saves its transform and the current level into a bookmark. Parameters Camera Camera to capture view from OutBookmark Resulting bookmark data Returns True if bookmark was created
Get Bookmark From Clipboard 🔎 » C++ API	Reads the contents of the clipboard and converts the json string to a bookmark. Parameters OutBookmark Bookmark read from clipboard Returns True if clipboard contents could be converted to a bookmark
Read Bookmark From Json 🔎 » C++ API	Takes a json string and reads data into a bookmark. Parameters JsonString Json data to parse OutBookmark Resulting bookmark data Returns True if conversion was a success
Make FtsViewBookmark	Unreal's build in make function.

Exporting Bookmarks

Bookmarks can easily be exported to the clipboard or to a JSON string.

Function	Description
Copy Bookmark To Clipboard 🔎 » C++ API	Converts a bookmark into condensed json and saves it in the clipboard. Parameters Bookmark Bookmark to write into clipboard
WriteBookmarkToJson 🔎 » C++ API	Converts bookmark data into a condensed json string. Parameters Bookmark Bookmark to serialize OutJsonString Data converted into json string Returns True if conversion was a success

Meta Data

Meta data can be used to store arbitrary data in a bookmark.

Function	Description
Get Bookmark Meta Data Entry 🔎 » C++ API	Gets the value that fits the key for a bookmarks meta data if it exists. Parameters Bookmark Bookmark reference to get meta data from Key Key to get value for OutValue Meta data value Returns True if bookmark has data for the given key
Set Bookmark Meta Data Entry 🔎 » C++ API	Sets a new value to a given key for the bookmarks meta data. Parameters Bookmark Bookmark reference to write to Key Meta data key to set Value Value to set for key
Delete Bookmark MetaData Entry 🔎 » C++ API	Deletes a value from the bookmarks meta data. Parameters Bookmark Bookmark to modify Key Key of value to delete from data