# Animated Book Menu # Release Notes ## Release 1.4.1 (New Version numbering) ### Supported Unreal Engine Verisons - UE 5.4 - UE 5.3 ### Overview - Change of version numbering - InteractExt Function added to BookMenuActor - Performance improvements on AnimInstance - UE 5.4 compatibility adjustments - Fix of GetBookMenuData function of BookMenuActor ### BookMenuActor - InteractExt function added - The Interactxt function additionally offers another Output with th UV Coordinates of the UVBookTrace - Compatibility adjustments - mainly added include files UE5.4 seems to require now - GetBookMenuData fix - Fixed a bug that caused that the WidgetInstances on UBookMenuData were still null after GetBookMenuData() on BookMenuActor ### BookMenuComponent - InteractExt function added - just interfacing the InteractExt of the BookMenuActor ### BookMenuAnimInstance - Timer Callback added for page rendering to provide an option to improve performance if needed - Developers can now configur the time between two rendercalls of the Widgets - The Option is available in the BookMenuData Asset, Property: RedrawTime - If 0 every frame will be rendered otherwise the given time in seconds will be used e.g. 0.1 for every 100ms - Compatibility adjustments - mainly added include files UE5.4 seems to require now ### BookMenuData - RedrawTime attribute added to control the time between two render calls of the widgets ### BookMenuStatics - Compatibility adjustments - mainly added include files UE5.4 seems to require now --- --- ## Release 5.3.2 for UE 5.3.2 ### Book Menu Actor and Book Menu Component - Removed LastPageSectionIndex and Last Page Index Properties due to confusion about their purpose - Get and Set BookMenu Data care now about cloning the data first before using it to avoid wrong runtime manipulation of data - Set Book Menu Data now initializes the Book Menu Actor and Anim INstance correctly ### Book Menu Interaction Actor - Added additional Widget Components to fix stalling UI animations during page turn or if not focused - Removed GetPageWidgetComponnt Function because it is obolete now ### Book Menu Anim Instance - refactoring of page rendering ### Page Section Data Struct - Widget Instances made readonly because the properties are only used at runtime internally - Added some helper functions for rendering - Removed Last Page Section Index and Last Page Index due to confusion about their usage - SetInteractionActor Function added ### Book Menu Statics - MenuDataRuntimeInstance added to clone Book Menu Data before runtime manipulation --- --- ## Release5.3.1 for UE 5.3.2 ### Book Menu Actor - Added Get Function for Property BookMenuData; GetBookMenuData - Added functions RegisterInteractionComponent and RegisterInteractionActor - Exposed the following Properties via respective Get Functions - GetCurrentPageSectionIndex - GetLastPageSectionIndex - GetPendingPageSectionIndex - GetCurrentPageIndex - GetLastPageIndex - GetBookIsOpen - GetBookShouldOpen - GetBookShouldClose - GetPageSections - Added Keyboard Focus features and Gamepad Support - SetKeyboardFocus ### Book Menu Component - Exposed the following Properties via respective Get Functions - GetCurrentPageSectionIndex - GetLastPageSectionIndex - GetPendingPageSectionIndex - GetCurrentPageIndex - GetLastPageIndex - GetBookIsOpen - GetBookShouldOpen - GetBookShouldClose - GetPageSections - Added Keyboard Focus features and Gamepad Support - SetKeyboardFocus ### BookMenuInteractionActor - ArrowComponent added (PointerZero) ### Book Menu Statics - ResetWidgetInteractionPointer ### Assets - Updated Master Materials - Folder structure in textures reorganized - AnimMontage moved to own Folder - Updated UV Layouts # Introduction Introducing the Fully Animated and Ready-to-Use Skeletal Book Mesh Plugin, designed for those who want to elevate their 3D widget experience with an interactive, animated book interface. This plugin allows you to render UMG User Widgets onto curved, animated book pages, making it perfect for creating immersive and engaging UI elements. With this plugin, you can easily render custom User Widgets on the book's pages, bringing a dynamic and captivating interface to your project. The UV-based line trace interaction ensures precise input handling. The book's functionality is fully exposed to blueprints, allowing you to control book animations and implement custom behaviors with ease. All rendering features as well as the animation logic, are encapsulated within the Animation Instance Class, simplifying the integration and management of the book's visual elements. The BookMenuData asset type streamlines the creation of multiple books with different covers and contents. This data-driven approach allows you to quickly define books in the editor, speeding up the development process. ![BookMenuPlugin](https://docs.suricoon.com/uploads/images/gallery/2024-07/scaled-1680-/image-1721552288322.png)## Main Features of the Plugin - Fully anminated and ready-to-use Skeletal Book Mesh - Control Animations through simple functions like: `Open Book` , `Close Book`, `Jump to Page` (turning the pages) - Render targets to display interactable custom User Widgets on the Skeletal Book Mesh pages - Interact with the Book Pages by simply calling the `Interact` function. The interact function will perform the `Line Tracing` and Widget Pointer handling for you. - Send input to the widgets through the UE5 build in `Widget Interaction Component`. No plugin specific magice here. ## Installation and Setup If you want to have a detailed description about the following steps, please refer to: [Getting Started](https://docs.suricoon.com/books/animated-book-menu/chapter/getting-started) - Install the Plugin for the UE5 Version you are using. You can do so by going to the `Epic Games Launcher > Unreal Engine > Library > Vault > search for animated book menu` - If the Plugin does not show up in your Vault, you might need to purchase it first from the [Marketplace](https://www.unrealengine.com/marketplace/en-US/product/animated-book-menu?sessionInvalidated=true) - Create a new Project or open an existing one - Open Plugin Settings and enable the Plugin `Animated Book Menu` - **Very important**: Open Project Settings and enable the option `Support UV From Hit Results` - Restart the Editor ## Plugin Structure ![drawing](https://docs.suricoon.com/uploads/images/gallery/2024-07/scaled-1680-/image-1721551880268.png)#### C++ Classes The plugin consists of two modules: a runtime module and an editor module. The editor module, though currently basic, adds a new asset type called BookMenuActorData to the editor context menu. This feature allows you to easily define and manage book menu data within the editor. The runtime module provides the essential base classes for the plugin. Most users won't need to interact with the C++ code, as the plugin's functionality is designed to be accessible through Blueprints. #### Contents In the content folder, you will find a variety of assets essential for creating interactive book menus:\\ - **Animations and Meshes:** Ready-to-use assets for the book's animated movements and structure. - **Blueprints for Book Menu Logic:** Pre-built Blueprints that you can copy and modify, or use as a base to derive your own custom Blueprints. - **Base and Example Widgets:** Templates to help you design and create your own interactive book menu pages. - **Textures and Materials:** Visual assets for customizing the appearance of your book menus. - **Example Book Menu Configuration Data:** Sample data configurations to help you get started quickly and understand the setup process. # Quick Start [AnimatedBookMenu\_ExampleProjects.zip](https://docs.suricoon.com/attachments/2) ## Prerequisites - Make sure the correct version of Unreal Engine is installed (UE 5.3+) - Make sure you have purchased the Plugin from the [Marketplace](https://www.unrealengine.com/marketplace/en-US/product/animated-book-menu) and installed it to the Engine ## Create a new Project **Open Unreal Engine Launcher and launch Unreal Engine (5.3+)** --- [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/scaled-1680-/image.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/image.png) **Create a new Project** --- [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/scaled-1680-/2oJimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/2oJimage.png) 1. Select Blank Project 2. Select Blueprint with Target Platform Windows, Quality Preset Maximum and leave Starter Content and Raytracing unchecked 3. Name the Project GettingStarted 4. Click on Create **Project Settings** --- - Once the project has loaded, go to `Settings > Project Settings` - In the Search bar type: Support UV From Hit Results - Enable the setting `Optimization > Support UV From Hit Result` [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/scaled-1680-/wKRimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/wKRimage.png) > ***NOTE:*** If being asked to restart, ignore it, we will restart the editor after the next step **Enable Plugin** --- - Navigate to `Edit > Plugins` - In the category "Advanced Gameplay" enable the Animated Book Menu Plugin - You can also search for "Book" in the search bar and then enable it [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/scaled-1680-/fylimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/fylimage.png) > ***NOTE:*** If being asked to restart the editor, confirm with Restart Now [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/scaled-1680-/DDmimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/DDmimage.png) ## Prepare some Content **Folder Setup** --- - In the Content Browser under Content, create a new Folder with the name "BookMenu" and navigate to it. [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/VSUimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/VSUimage.png) **Copy some initial files from the Plugins Content Folder** --- - In the Content Browser under Settings, make sure the Show Plugin Content option is checked [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/jyIimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/jyIimage.png) - Then navigate to the Content Folder of the Plugin, with the name Animated Book Menu Content [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/qJjimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/qJjimage.png) - Copy the following files from the Plugin Content folder to the BookMenu folder:
FromTo
/BookMenu/Blueprints/BookMenuActor\_BP/Game/BookMenu/MyBookMenuActor\_BP
/BookMenu/BookData/Example\_Book\_Menu\_Data/Game/BookMenu/MyBookData
## Basic Player Pawn Setup **Create Player Pawn Blueprnt Class** --- - Create a new Blueprint Class and select Pawn and name it PlayerPawn\_BP [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/8Dgimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/8Dgimage.png) **Add the Book Menu Component to the Player Pawn** --- - Open the PlayerPawn\_BP Blueprint and under Components, add the following Components to the DefaultSceneRoot - Camera - BookMenu [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/CuQimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/CuQimage.png) **Configure the Book Menu Component** --- - Select the BookMenu Component from the Component List [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/fYMimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/fYMimage.png) - and under Details->BookMenu set the following settings: [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-01/zSnimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-01/zSnimage.png) - While the two options are the copied assets from the previous Step. **Add some Begin Play Logic** --- - Add the following Blueprint nodes to the Begin Play event - This sets the Input node to Game and UI and shows the mouse cursor. ## Map Setup **Save the Map and set it as the Editor default map** --- Because we used the Blank Project Template, the editor will give us the default map at startup, which we have to save first. Click on `File > Save All` When being asked where to save the map, choose `/BookMenu/Map.umap` Then goto `Settings > Projects Settings > Maps & Modes` [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/image.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/image.png) Set Editor Startup Map and Game Default Map to the Map we have saved previously. **Place Player Pawn on Map** Drag and Dop the PlayerPawn\_BP Blueprint onto the map and adjust its position to something like that: [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/Au4image.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/Au4image.png) Select the recently placed `PlayerPawn_BP` Actor and navigate to the Details Panel. Under `Auto Poses Player`, select `Player 0` It is important to also delete the Player Start Object from the Map [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/51mimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/51mimage.png) Hit play, you should see something like this: [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/JD3image.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/JD3image.png) Just the Book lying open without any page turn or interaction. That's what we will add next. ## Automatic page turn logic **Adjust the Book Menu Data Config** --- Open the `MyBookData asset` (the one we copied earlier from the plugins content folder) Uncheck `Book Begins Play Open` and set the `Start Page Section` to 0 As we remember from the previous play test, the book started in an open state. That was because those options were set. Save the asset and run the game again by hitting Play. You should now see that the book starts in an closed state and simply does nothing else. [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/hLYimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/hLYimage.png) **Adjustments of the Book Menu Actor** --- Open the `MyBookMenuActor_BP` Blueprint (the one we copied earlier from the plugins content folder) `OnBeginPlay` we want open the Book and set some timers to automatically turn the pages after 5 and back again after 10 seconds. > ***NOTE:*** Because Begin Play is also exactly the moment where the whole initialization of the book, the rendering and the Anim instance happens, we should not call any book controls on begin play. But there is a solution by adding a one frame delay Add the following Blueprint Nodes to Begin Play of MyBookMenuActor\_BP The Delay Until Next Tick must be called before any book control functions on Begin Play. Otherwise the initialization and the control calls collide with each other. If you hit Play you should see an opening book animation ending like this: [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/JHjimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/JHjimage.png) Now let's add some automatic page turning. Add the following Blueprint Nodes to the output of "Open Book At" This will open the book. After 5 seconds the book will perform a forward page turn because the new Page Section we are jumping to is greater than the current one. After 10 seconds the book will perform a reverse Page Turn because the Page Section we are jumping to is smaller than the current one. Hit play to see the animation sequence we just created. ## Adding book interactions Last but not least, let's make the pages interactive. We want to create an interactive mouse which enables us to hover over the buttons and also to click on the buttons of the pages. **Add Book Menu Interaction Component to the Player Pawn** --- Open the `PlayerPawn_BP` Blueprint. Add a `BookMenuInteractionCopmponent` to the `DefaultSceneRoot` of the Actor [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/VfLimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/VfLimage.png) [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/5ZCimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/5ZCimage.png) Select the `BookMenuInteraction` Component and set the `BookMenuInteractionActor_BP` as the value under `BookMenu > BookMenuInteractionActorClass` [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/oMpimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/oMpimage.png) **Extend Begin Play on the Player Pawn** --- On the Begin Play Node add the "Register Interaction Component" Node after Set Show Mouse Cursor: This registers the newly added BookMenuInteraction Component inside the Book Menu Actor **Create regular mouse traces** In order to interact with the pages of the book we want to create traces starting starting from the mouse cursor on the screen into the game world. For this purpose the Book Menu Statics Library offers a node called `Create Mouse Trace Parameters`. Those parameters can be used to try an interaction on the Book Menu Actor. Add the following nodes to the Event Tick of the PlayerPawn\_BP: This creates the mouse trace parameters with an trace distance of 500 units and passes the start and end locations for the actual trace into the interact method of the Book Menu Actor If you enable `Debug Trace` you will later see how the traces are performed by drawn lines inside the viewport. Apropos viewport, let's switch to the viewport of the book menu actor and position the book menu interaction component in a way so that we can see what it is actually doing. In the viewport move the BookMenuInteraction Component to the position `X:120` `Y:0` and `Z:60` This will place the `BookMenuInteraction` Component so that we can see it in game. Like this in the background: [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/MEwimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/MEwimage.png) > ***NOTE:*** Usually you don't want to have the Book Menu Interaction Component on screen. Therefore it makes sense to move it behind the camera and for multiplyaer games not to replicate the component at all. Lets move the Book Menu Interaction Component behind the Camera to position `X: -120` `Y:0` `Z:0` Hit play and hover the Buttons. You should see them lighting up. But you can't click them yet. Thats what we are doing next. **Adding Input to the Book Menu Interaction Actor** --- Somewhere inside the event graph of PlayerPawn\_BP add the following nodes: This gets the Widget Interaction Component from the Book Menu Interaction Component. We can use this Widget Interaction Component like any normal Widget Interaction Component (see: Unreal Engine Documentation ) Which means we can do a lot of stuff with it. In our example we implement a pointer key press and release. Hit play and you will be able to hoer and click the buttons. That's the getting started Have fun and have a look onto my [Youtube Channel](https://www.youtube.com/@suricoon) for more tutorial, which will be added from time to time! # Book Menu Data # Book Menu Editor - Book Menu Data Book Menu Data Assets can be easily created within the Content Browser. Rightclick on any free space within the content browser and select Book Menu -> Book Menu Dta [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/scaled-1680-/L6nimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/L6nimage.png) [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/scaled-1680-/Yj8image.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/Yj8image.png) Currently the Book Menu Data Editor is a very simple properties editor. You can adjust any value here: [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-02/scaled-1680-/RKMimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-02/RKMimage.png) # Set Book Menu Data and Page Sections (Design Time and Run Time) ### Set Book Menu Data at design time The Book Menu Data normally should be set at design time. At least a possible default value. It can be set either on the Book Menu Component or the Book Menu Actor directly #### Book Menu Component **Option 1:** Set the Book Menu Data on the Class Default value inside any actor that instantiates the Book Menu Component [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-03/scaled-1680-/ojwimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-03/ojwimage.png) **Option 2:** Another way is to set the Book Menu Data on an actor that instantiates the Book Menu Component inside the 3D Viewport. [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-03/scaled-1680-/ZXWimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-03/ZXWimage.png) #### Book Menu Actor **Option 1:** Set the Book Menu Data on the Class Default value inside the Book Menu Actor.

This only works if the Book Menu Actor gets used directly e.g. by Placing it in the World. If the Book Menu Actor gets instantiated via a Book Menu Component, always the Book Menu Component Value overwrites the default value of the Book Menu Actor

[![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-03/scaled-1680-/WMFimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-03/WMFimage.png) **Option 2:** Another way is to set the Book Menu Data on an Book Menu Actor that was directly placed in the World inside the 3D Viewport. [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-03/scaled-1680-/qWzimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-03/qWzimage.png) ### Set Book Menu Data at run time The Book Menu Data can also be set after Begin play at run time. It can be set either on the Book Menu Component or the Book Menu Actor directly #### Book Menu Component Let's assume the Book Menu Component is instantiated on an Actor called PlayerPawn. Inside the PlayerPawn Blueprint on the Begin Play function, we want to set the Book Menu Data at run time. To do this we can simply call the function "SetBookMenuData" on the Book Menu Component. [![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-03/scaled-1680-/Csuimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-03/Csuimage.png) At Begin Play this will set the Book Menu Data and initialize all necessary parts of the Book Menu Component. #### Book Menu Actor the same function can also be called directly on the Book Menu Actor. Again, let's assume the Book Menu Component is instantiated on an Actor called PlayerPawn. Inside the PlayerPawn Blueprint on the Begin Play function, we want to set the Book Menu Data at run time. But this time we get the Book Menu Actor first from the Book Menu Component and call the function "SetBookMenuData" on the Book Menu Acor directly instead.

The example might look a bit silly but actually this shows us that the functions can be called on the Book Menu Actor as stand alone. In case we don't have a Book Menu Component (e.g. because the Book Menu Actor was placed directly in the World)

[![image.png](https://docs.suricoon.com/uploads/images/gallery/2024-03/scaled-1680-/xkvimage.png)](https://docs.suricoon.com/uploads/images/gallery/2024-03/xkvimage.png) ### Add Page Sections to the Book Menu Data at run time Usually the Book Menu Data Assets get created at design time, which means inside the content browser before running the game. Sometimes you may want to add some page sections dynamically at runtime. Because the Book Menu Data Assets instances created in the Content Browser might be used by many different Book Menu Actors (or Book Menu Components), it might not be a good idea to manipulate the Book Menu Data instances directly. Because this change would affect any Book Menu Actor that has a reference to the Book Menu Data Asset. The Bok Menu Plugin cares about this problem by cloning the Book Menu Data Asset first before using it internally. Additionally the Plugin provides a function to create runtime instances of the Book Menu Data Assets to work with at runtme without manipulating the default instances. Let's assume the Book Menu Component is instantiated on an Actor called PlayerPawn. Inside the PlayerPawn Blueprint on the Begin Play function, we want to - create a runtime instance of a Book Menu Data Asset - add a page section to it - set the new Book Menu Data on the Book Menu Component - open the book at the newly created section Here you can see the Blueprint for this: # Controlling the pages of the book ## Overview Controlling the behavior of the book is straight forward and easy. You can use the exposed blueprint functions o perform the different actions on the `BookMenuActor` class: - `Open Book At` - Opens the book on a given index - `Close Book` - Closes the book - `Jump to Page Section` - Performs a Page Turn Animation to move forward or backward in the book pages ## How to call the functions? The above mentioned functions are implemented in the `BookMenuActor` class. To call those functions, you can either invoke them on the `BookMenuActor` directly or calling them from anywhere by using a reference of the respective `BookMenuActor` **On the BookMenuActor directly** --- Inside a Blueprint which is derived from `BookMenuActor`, you can directly call the book control functions: [![](https://docs.suricoon.com/uploads/images/gallery/2024-07/scaled-1680-/image-1721559085718.png)](https://docs.suricoon.com/uploads/images/gallery/2024-07/image-1721559085718.png) **On the BookMenuComponent** --- If you have a reference to the `BookMenuComponent` you can call the book menu control functions via a reference on the `BookMenuActor`: [![](https://docs.suricoon.com/uploads/images/gallery/2024-07/scaled-1680-/image-1721559133617.png)](https://docs.suricoon.com/uploads/images/gallery/2024-07/image-1721559133617.png) ## Book Control Functions ### Open Book At
ParameterDescription
Section IndexThe Page Section Index to be displayed while opening the book
Use this function to open the book on a specific `page section index`. By default this is 0 which means that the book will open on the first pair of pages.\\ > **Hint** - If the book is already in an opned state, call ing this function will implicitly call the `Jump to Page Section` function instead To find out if the book is opened or closed you can us the following function: The function will return `true` if the book is already fully open. The function will return `false` if the book is closed or the open animation is still in progress. To find out if the book should be opening at the moment, you can call the following function: The function will return `true` if the book should be in an open state but is not yet fully open. The function will return `false` if the book is fully open. ### Close Book This function will close the book. To find out if the book should be in a closed sate, you can call this function: The function will return `true` if the book should be in an closed state but is not yet fully closed. The function will return `false` if the book is fully closed. ### Jump to Page Section
ParameterDescription
Section IndexThe Page Section Index to be navigated to
Using this function you can navigate through the `page sections` of the book. Depending on the `Current Page Section Index` the function will either perform a page turn animation forward or backwards. > **Examples:** - If the `Section Index` parameter is greater than the `Current Page Section Index` a page turn forward will be performed > if the `Section Index` parameter is smaller than the `Current Page Section Index` a page turn backward will be performed To get the current active page section index you can call the following function: This will return the index of current active `page section index` > **Note:** - Do not confuse the `page scetion index` with the `page index`. The `page index` indicates the left `0` or right `1` page of a page section # Additional Resources # Example Project You can download the Example Projects here: [AnimatedBookMenu\_ExampleProjects.zip](https://suricooncom-my.sharepoint.com/:u:/g/personal/stefan_suricoon_com/EWDPSPGls-FAltGbvacieVUBg1y_Zr5zHwbhGw1zCw-XhA?e=VITq7M) # More Turorials Please have a look onto my [Youtube Channel](https://www.youtube.com/@suricoon) for more tutorials, which will be added from time to time! # Blueprint Interface Documentation # ABookMenuActor ### Properties
**Property Name****Type****Access****Description**
BookMenuDataUBookMenuDataEditAnywhereDefault Configuration Data for the Book, containing information such as the the widgets to be displayed as book pages
SkeletalMeshComponentUSkeletalMeshComponentVisibleAnywhere, BlueprintReadOnlyThe animated book mesh
StaticMeshComponentUStaticMeshComponentVisibleAnywhere, BlueprintReadOnlyA dummy static mesh component for doing traces. Needed to determine the UV coordinates based on trace hit results. The static mesh will be hidden in game. Must represent the book in a open state.
LeftPageCollisionUBoxComponentVisibleAnywhere, BlueprintReadOnlyCollision box used to determine which page of the book was traced
RightPageCollisionUBoxComponentVisibleAnywhere, BlueprintReadOnlyCollision box used to determine which page of the book was traced
InteractionActorABookMenuInteractionActorEditAnywhere, BlueprintReadOnlyReference to the actor that redirects the interaction to a widget interaction component
### Functions #### Set Book Menu Data --- Can be used to set the book menu data after begin play, during the game
**Pin****Direction****Type****Description**
In Book Menu DataInputUBookMenuDataThe new Book Menu Data. Will be cloned internally.
#### #### Get Book Menu Data --- Can be used to set the book menu data after begin play, during the game
**Pin****Direction****Type****Description**
Return ValueOutputUBookMenuDataA clone of the current Book Menu Data
#### Get Current Page Section Index --- Can be used to get the current page section index. The page section index indicates the currently shown pair of pages. (Index of the PageSection Array inside the BookMenuData)
**Pin****Direction****Type****Description**
Return ValueOutputIntegerthe current page section index; -1 in case Anim Instance is not defined
#### Get Pending Page Section Index --- Can be used to get the pending page section index. The pending page section index indicates the currently pending pair of pages while switching pages is in progress.
**Pin****Direction****Type****Description**
Return ValueOutputIntegerthe pending page section index; -1 in case Anim Instance is not defined
#### Get Current Page Index --- Can be used to get the index of the current page, where the interaction pointer points on.
**Pin****Direction****Type****Description**
Return ValueOutputIntegerthe current page index 0 = Left ; 1 = Right returns -1 in case Anim Instance is not defined
#### Get Book Is Open --- Can be used to check if the book is in an opened state
**Pin****Direction****Type****Description**
Return ValueOutputBooleantrue if the book is in open state; false if the book is in closed state
#### Get Book Should Open --- Can be used to check if the book should be in an opened state but opening is still in progress.
**Pin****Direction****Type****Description**
Return ValueOutputBooleantrue if the book should be in open state
#### Get Book Should Close --- Can be used to check of the book should be in a closed state but closing is still in progress.
**Pin****Direction****Type****Description**
Return ValueOutputBooleantrue if the book should be in closed state
#### Get Page Sections --- Can be used to get the Page Sections.
**Pin****Direction****Type****Description**
Return ValueOutputTMap<int32,FPageSectionDataStruct>an Map of the page sections of the book
#### Get Interaction Actor --- Returns the reference to the Book Menu Interaction Actor
**Pin****Direction****Type****Description**
Return ValueOutputABookMenuInteractionActorReturns the reference to the Book Menu Interaction Actor
#### Set Interaction Actor --- Registers the Book Menu Interaction Actor to be used for Interaction with the Book
**Pin****Direction****Type****Description**
In Interaction ActorInputABookMenuInteractionActorThe Book Menu Interaction Actor to be set
#### #### Register Interaction Component --- Method to register a Book Menu Interaction Component
**Pin****Direction****Type****Description**
In Interaction ComponentInputUBookMenuInteractionComponentThe Book Menu Interaction Component to be registered.
#### Register Interaction Actor --- Method to register a Book Menu Interaction Component
**Pin****Direction****Type****Description**
In Interaction ActorInputUBookMenuInteractionActorThe Book Menu Interaction Actor to be registered.
#### Jump to Page Section --- Determines if a forward or backward page turn need to be performed based on the current page section index.
**Pin****Direction****Type****Description**
Section IndexInputint32The index of the Page Section to be displayed
#### Open Book At --- If the book is closed, this triggers the open book animation and upfront sets the correct section to display.
**Pin****Direction****Type****Description**
Section IndexInputint32The Page Section Index to be displayed while opening the book
#### #### Close Book --- Triggers the Close Book animation #### Pause Book Update --- Pauses the animation update of the anim instance without closing the book first. #### Resume Book Update --- Resume the animation update of the anim instance. Will only resume if the book is already open. Closed books don't need to consume render time #### Interact --- Performs a Line Trace based on the Start and End Parameters and moves the Widget Interaction pointer of the Book Menu Interaction Actor if it is set. Also tells the Animation Blueprint which page was traced to.
**Pin****Direction****Type****Description**
StartInputFVectorStart of the Line Trace
EndInputFVectorEnd of the Line Trace
Debug TraceInputboolShows a debug trace if true.
Trace ChannelInputECollisionChannelThe Collision Channel to be used for the line trace.
SuccessOutputEXECIndicates if the Interaction was executed successfully
FailedOutputEXECIndicates if the Interaction was not executed successfully
Return ValueOutputboolreturns tru if the operation was successful. Otherwise false
#### InteractExt (Release 1.4+) --- Performs a Line Trace based on the Start and End Parameters and moves the Widget Interaction pointer of the Book Menu Interaction Actor if it is set. Also tells the Animation Blueprint which page was traced to.
**Pin****Direction****Type****Description**
StartInputFVectorStart of the Line Trace
EndInputFVectorEnd of the Line Trace
OutUVCoordinatesOutputFVectro2dThe UV coordinates of the traced page
Debug TraceInputboolShows a debug trace if true.
Trace ChannelInputECollisionChannelThe Collision Channel to be used for the line trace.
SuccessOutputEXECIndicates if the Interaction was executed successfully
FailedOutputEXECIndicates if the Interaction was not executed successfully
Return ValueOutputboolreturns tru if the operation was successful. Otherwise false
#### Set Keyboard Focus ---
**Pin****Direction****Type****Description**
In Page IndexInputIntegerThe page index to set the focus to
Debug TraceInputboolShows a debug trace if true.
SuccessOutputEXECIndicates if the Interaction was executed successfully
FailedOutputEXECIndicates if the Interaction was not executed successfully
Return ValueOutputboolreturns tru if the operation was successful. Otherwise false
#### Get Anim Instance --- Returns the Animation Instance of the Animation Blueprint
**Pin****Direction****Type****Description**
Return ValueOutputUBookMenuAnimInstance
#### #### Get Left Page Collision Box --- Returns the Collision Box of the left page
**Pin****Direction****Type****Description**
Return ValueOutputUBoxComponent
#### #### Get Right Page Collision Box --- Returns the Collision Box of the right page
**Pin****Direction****Type****Description**
Return ValueOutputUBoxComponent
#### #### Get Static Mesh Component --- Returns the Static Mesh Component
**Pin****Direction****Type****Description**
Return ValueOutputUStaticMeshComponent
# ABookMenuInteractionActor ### Properties
**Property Name****Type****Access****Description**
WidgetInteractionComponentUWidgetInteractionComponentVisibleAnywhere, BlueprintReadOnlyThe widget interaction component used to redirect the book interaction onto a Widget Component
PageWidgetComponentAUWidgetComponentVisibleAnywhere, BlueprintReadOnlyThe widget component used to display the first page
PageWidgetComponentBUWidgetComponentVisibleAnywhere, BlueprintReadOnlyThe widget component used to display the second page
PageWidgetComponentCUWidgetComponentVisibleAnywhere, BlueprintReadOnlyThe widget component used to display the third page
PageWidgetComponentDUWidgetComponentVisibleAnywhere, BlueprintReadOnlyThe widget component used to display the fourth page
ActiveWidgetComponentUWidgetComponentVisibleAnywhere, BlueprintReadOnlyThe widget component which is currently under interaction
DrawSizeUStaticMeshComponentVisibleAnywhere, BlueprintReadOnlyThe Draw Size of the Widget. User Widgets and Render Targets must have the same resolution. Will be set via the Book Menu Data of the Book Menu Actor
### Functions #### Move Pointer --- Calculates the world location on the Page Widget based on the UV Coordinates of the Book Actors Book Mesh
**Pin****Direction****Type****Description**
UV CoordinatesInputFVector2D UV Coordinates of the Book Page
Debug TraceInputboolShows a debug trace if true
Return ValueOutputboolreturns true if the operation was successful. Otherwise false.
#### Reset Pointer --- Sets the Interaction Pointer to a safe spot which triggers no interaction
**Pin****Direction****Type****Description**
Debug TraceInputboolShows a debug trace if true
Return ValueOutputboolreturns true if the operation was successful. Otherwise false.
#### Get Interaction Component --- returns the Widget Interaction Component. Can be used to do further interaction with the widget such as send keys etc.
**Pin****Direction****Type****Description**
Return ValueOutputUWidgetInteractionComponent
# UBookMenuData ### Properties
**Property Name****Type****Access****Description**
SkeletalMeshUSkeletalMeshEditAnywhereThe Skeletal Mesh to be set after Begin Play
AnimInstanceClassTSubclassOf<UBookMenuAnimInstance>EditAnywhereThe Animation Blueprint class to be set after Begin Play
PageMaterialIndexMappingFPageMaterialIndexMappingEditAnywhereMapping that tells us which Material Index of the Skeletal Mesh shall be used for which Page
DefaultPageSectionFPageSectionDataStructEditAnywhere, BlueprintReadWriteThe Default Page Section to be used if no concrete Page Section is defined
PageSectionsTArray<FPageSectionDataStruct>EditAnywhere, BlueprintReadWriteList of Page Sections to be used inside the Book Menu Actor
CoverMaterialUMaterialInterfaceEditAnywhere, BlueprintReadWriteMaterial for the Cover
bBookBeginsPlayOpenboolEditAnywhere, BlueprintReadWriteIf the book shall begin play in an open state or closed state
StartPageSectionint32EditAnywhere, BlueprintReadWriteIf the book shall begin play in an open state, this is the page section to open the book at. Can also be accessed by the Book Menu Actor to handle respective behavior.
DrawSizeFVector2DEditDefaultsOnlyDraw Size of the Render Targets and the Widgets. Used to set the Draw Size on all involved Actors and components
RedrawTime (Release 1.4+)floatEditDefaultsOnlyTime between redraws. if 0 we would redraw every frame
### Functions No functions # UBookMenuAnimInstance ### Properties
**Property Name****Type****Access****Description**
BookMenuActorABookMenuActorBlueprintReadOnlyThe Owning Book Menu Actor
PageSectionsTMap<int32,FPageSectionDataStruct>BlueprintReadOnlyList of all available Page Sections of the current book
PageTextureAUTextureRenderTarget2DBlueprintReadWriteTexture Render Target of the page one. Left side.
PageTextureBUTextureRenderTarget2DBlueprintReadWriteTexture Render Target of the page two. Right side.
PageTextureCUTextureRenderTarget2DBlueprintReadWriteTexture Render Target of the page three. Backside of page two.
PageTextureDUTextureRenderTarget2DBlueprintReadWriteTexture Render Target of the page four. Backside of page one.
MaterialPageAUMaterialInstanceDynamicBlueprintReadWriteDynamic Material Instance of page one. Must have a Texture Parameter called BC
MaterialPageBUMaterialInstanceDynamicBlueprintReadWriteDynamic Material Instance of page two. Must have a Texture Parameter called BC
MaterialPageCUMaterialInstanceDynamicBlueprintReadWriteDynamic Material Instance of page three. Must have a Texture Parameter called BC
MaterialPageDUMaterialInstanceDynamicBlueprintReadWriteDynamic Material Instance of page four. Must have a Texture Parameter called BC
MaterialCoverUMaterialInstanceDynamicBlueprintReadWriteDynamic Material Instance of The Cover.
PageSectionAIndexint32BlueprintReadOnlyPage Section Index for Pages one and two
PageSectionBIndexint32BlueprintReadOnlyPage Section Index for Pages three and four
DefaultPageSectionFPageSectionDataStructBlueprintReadOnlyThe Default Page Section in case there is no defined page section.
CurrentPageSectionIndexint32BlueprintReadOnlyThe Current Page Section Index to be displayed on page one and two
CurrentPageIndexint32BlueprintReadOnlyThe current Page the Interaction point on. Can be either the Left or the Right Page.
PendingPageSectionIndexint32BlueprintReadOnlyThe Page Section Index that is pending while switching pages.
DrawSizeFVector2DBlueprintReadOnlyThe Draw Size of the render targets. Must match the Widget Component Draw Size of the Book Interaction Actor.
bBookIsOpenboolEditAnywhere, BlueprintReadOnlyIndicates if the book is or shall be in an opened state
bBookShouldOpenboolBlueprintReadWriteIndicates if the book should open
bBookShouldCloseboolBlueprintReadWriteIndicates if the book should close
bBookShouldSetKeyboardFocusboolBlueprintReadOnlyIndicates if KeyboardFocus is pending
### Functions #### Set Page Sections --- Sets or replaces the current list of Page sections
**Pin****Direction****Type****Description**
InPageSectionsInputTArray<FPageSectionDataStruct>List of Page Sections to be set.
#### Init --- Method to Initialize the Animation Instance and set configurations such as Book Data.
**Pin****Direction****Type****Description**
InDataInputUBookMenuDataThe Book Menu Data
InBookMenuActorInoutABookMenuActorThe Book Menu Actor
#### Jump to Page Section --- Determines if a forward or backward page turn need to be performed based on the current page section index.
**Pin****Direction****Type****Description**
SectionIndexInputint32the index of the Page Section to be displayed
#### Open Book At --- If the book is closed, this triggers the open book animation and upfront sets the correct section to display.
**Pin****Direction****Type****Description**
SectionIndexInputint32The Page Section Index to be displayed while opening the book
#### Close Book --- Triggers the Close Book animation #### Play Page Turn Forward Anim --- 34yv0-ma Method to be overwritten in the Anim Blueprint. Shall start the Page Turn forward animation. #### Play Page Turn Reverse Anim --- Method to be overwritten in the Anim Blueprint. Shall start the Page Turn backward animation. #### Play Open Book Anim --- 5kdaq6c5 Method to be overwritten in the Anim Blueprint. Shall start the Open Book animation. #### Play Close Book Anim --- Method to be overwritten in the Anim Blueprint. Shall start the Close Book animation. #### Play Idle Book Anim --- Method to be overwritten in the Anim Blueprint. Shall start the Idle animation. #### On Page Turn Anim End --- If the book is closed, this triggers the open book animation and upfront sets the correct section to display.
**Pin****Direction****Type****Description**
IsTurnForwardInputboolIndicates if a page forward (true) or a page backward (false) animation was executed.
#### On Book Open Anim End --- Method to be called at the end of the Open Book Animation. You want to use Anim Notifies to find out when to call this Method. #### On Book Close Anim End --- Method to be called at the end of the Close Book Animation. You want to use Anim Notifies to find out when to call this Method. #### On Book Idle Anim End --- Method to be called at the end of the Idle Book Animation. e.g. to restart the Idle animation. You want to use Anim Notifies to find out when to call this Method. #### On Paused --- Called when the Anim Blueprint gets Paused to do some "pausing" stuff in the Blueprint #### On Resumed --- Called when the Anim Blueprint gets Resumed to do some "resuming" stuff in the Blueprint # UBookMenuComponent ### Properties
**Property Name****Type****Access****Description**
BookMenuActorABookMenuActorVisibleAnywhere, BlueprintReadOnlyThe spawned Book Menu Actor
BookMenuDataUBookMenuDataVisibleAnywhere, BlueprintReadOnlyThe Book Menu Data to initialize the spawned Book Menu Actor
BookMenuActorClassTSubclassOf<ABookMenuActor>VisibleAnywhere, BlueprintReadOnlyThe Class of the Book Menu Actor to be spawned at Begin Play
### Functions #### Register Interaction Component --- Calculates the world location on the Page Widget based on the UV Coordinates of the Book Actors Book Mesh
**Pin****Direction****Type****Description**
In Interaction ComponentInput
#### #### Register Interaction Actor --- Calculates the world location on the Page Widget based on the UV Coordinates of the Book Actors Book Mesh
**Pin****Direction****Type****Description**
In Interaction ActorInput
#### Interact --- Performs a Line Trace based on the Start and End Parameters and moves the Widget Interaction pointer of the Book Menu Interaction Actor if it is set. Also tells the Animation Blueprint which page was traced to.
**Pin****Direction****Type****Description**
StartInputFVectorStart of the Line Trace
EndInputFVectorEnd of the Line Trace
Debug TraceInputboolShows a debug trace if true.
Trace ChannelInputECollisionChannelThe Collision Channel to be used for the line trace.
SuccessOutputEXECIndicates if the Interaction was executed successfully
FailedOutputEXECIndicates if the Interaction was not executed successfully
Return ValueOutputboolreturns true if the operation was successful. Otherwise false
#### Interact Ext --- Performs a Line Trace based on the Start and End Parameters and moves the Widget Interaction pointer of the Book Menu Interaction Actor if it is set. Also tells the Animation Blueprint which page was traced to.
**Pin****Direction****Type****Description**
StartInputFVectorStart of the Line Trace
EndInputFVectorEnd of the Line Trace
Out UV CoordinatesOutputFVector2dThe UV Coordinate of the trace page
Debug TraceInputboolShows a debug trace if true.
Trace ChannelInputECollisionChannelThe Collision Channel to be used for the line trace.
SuccessOutputEXECIndicates if the Interaction was executed successfully
FailedOutputEXECIndicates if the Interaction was not executed successfully
Return ValueOutputboolreturns true if the operation was successful. Otherwise false
# UBookMenuInteractionComponent ### Properties
**Property Name****Type****Access****Description**
BookMenuInteractionActorClassTSubclassOf<ABookMenuInteractionActor>EditAnywhereThe Class of the Book Menu Interaction Actor to be spawned at Begin Play
InteractionActorABookMenuInteractionActorBlueprintReadOnlyThe spawned Book Menu Interaction Actor
### Functions #### Get Widget Interaction Component --- returns the Widget Interaction Component
**Pin****Direction****Type****Description**
Return ValueOutputUWidgetInteractionComponent
# UBookMenuStatics ### Properties The static Blueprint Function Library does not define any properties. ### Functions #### Create Mouse Trace Parameters --- **Description** Method to translate the mouse position into trace parameters such as start and end
**Pin****Direction****Type****Description**
Player ControllerInputAPlayerControllerThe Player controller
Trace DistanceInputfloatThe distance (length) used to perform the trace
SuccessOutputEXECIndicates if the operation was successful
FailedOutputEXECIndicates if the operation was failed
Out StartOutputFVectorThe resulting Start Coordinate of the Trace Parameters
Out EndOutputFVectorhe resulting End Coordinate of the Trace Parameters
#### Move Widget Interaction Pointer --- **Description** Calculates the world location on the Page Widget based on the UV Coordinates of the Book Actors Book Mesh
**Pin****Direction****Type****Description**
In Widget Interaction ComponentInputUWidgetInteractionComponentThe Widget Interaction Component that shall be influenced
In Widget ComponentInputUWidgetComponentThe Widget Component the Pointer shall be moved on
In Reference RotationInputFRotatorA reference rotation in order to do some relative calculations. e.g. the World Rotation of the Book Interaction Actor.
UV CoordinatesInputFVector2DUV Coordinates to be translated onto the Widget
Debug TraceInputboolshows a debug trace if true.
Return ValueOutputboolreturns true if the operation was successful. Otherwise false.
#### Book Uv Trace --- **Description** Creates a trace based on the given collision channel. If a Book Men uActor was hit the Method determines if the book was hit from the front and tries to determine the current page and the UV Coordinates. This requires the Project Settings to be set to use the generation of UV coordinates from hit results.
**Pin****Direction****Type****Description**
Book Menu ActorInputABookMenuActorThe Book Menu Actor we ar looking for
StartInputFVectorStart of the Trace
EndInputFVectorEnd of the Trace
Debug TraceInputboolshows a debug trace if true
Trace ChannelInputECollisionChannelThe Collision Channel to be used for the Trace
Out UV CoordinatesOutputFVector2DThe found UV Coordinates
Out Page IndexOutputint32The found page index 0 = Left ; 1 = Right
Return ValueOutputboolreturns true if the operation was successful. Otherwise false.
#### Get Local Player Controller --- **Description:** Method to get the First local Player Controller based on the World Context #### Create Texture Render Target 2D --- **Description** Creates a new Render Target with the specified parameters
**Parameter****Direction****Type****Description**
Draw SizeInputFVector2DThe DrawSize of the Render Target
FilterInputTextureFilterThe Texture Filter to be applied
Use Gamma CorrectionInputboolUses Gamma Correction if true
Return ValueOutputUTextureRenderTarget2Dreturns the created Render Target
#### #### Draw UserWidget to Render Target 2D --- **Description** Method to render a UserWidget onto a TextureRenderTarget2D
**Parameter****Direction****Type****Description**
User WidgetInputUUserWidgetThe UserWidget to be rendered
Render TargetInputUTextureRenderTarget2DThe Target to be rendered on
Draw SizeInputFVector2DThe DrawSize of the Render Target
Delta TimeInputfloatDelta time
Use Gamma CorrectionInputboolUses Gamma Correction if true
# UBookPageWidget ### Properties
**Property Name****Type****Access****Description**
BookMenuActorABookMenuActorEditAnywhereThe Owning Book Menu Actor of the widget. Can be used to control the Book Menu actor from the widget
PageSectionIndexint32VisibleAnywhere, BlueprintReadOnlyThe page section index of this widget. Can be used for navigation.
PageIndexint32VisibleAnywhere, BlueprintReadOnlyThe page index. 0 = Left page, 1 = Right page
### Functions #### Init --- Method to initialize the most important data in the Widget
**Pin****Direction****Type****Description**
InBookMenuActorInputABookMenuActorThe Owning Book Menu Actor of the widget. Can be used to control the Book Menu actor from the widget
InPageSectionIndexInputint32The page section index of this widget. Can be used for navigation.
InPageIndexInputint32The page index. 0 = Left page, 1 = Right page
#### #### OnSetKeyboardFocus --- Use this event to handle custom code after the widget received keyboard focus. This function is the counter part the SetKeyBoardFocus Function of the BookMenuActor.