Skip to main content

ABookMenuActor

Properties

Property NameTypeAccessDescription
BookMenuData
**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

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

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

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