1. Epic GamesDeveloper
  3. PAPER2UPaperFlipbook

PAPER2UPaperFlipbook

Contains an animation sequence of sprite frames

API > API/Plugins > API/Plugins/Paper2D

Inheritance Hierarchy

References

   
Module Paper2D
Header /Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperFlipbook.h
Include #include "PaperFlipbook.h"

Syntax

UCLASS&40;BlueprintType, Meta&61;&40;DisplayThumbnail&61;"true"&41;&41;  
class PAPER2UPaperFlipbook : public UObject

Remarks

Contains an animation sequence of sprite frames

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TEnumAsByte< EFlipbookCollisionMode::Type > CollisionSource Collision source.
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< UMaterialInterface > DefaultMaterial The material to use on a flipbook player instance if not overridden.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float FramesPerSecond The nominal frame rate to play this flipbook animation back at.
Protected variable UProperty Category, EditAnywhere TArray< FPaperFlipbookKeyFrame > KeyFrames The set of key frames for this flipbook animation (each one has a duration and a sprite to display)

Constructors

  Type Name Description
Public function  

PAPER2UPaperFlipbook ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool

ContainsSprite ( UPaperSprite* SpriteAsset
)

 Returns true if the flipbook asset contains the specified sprite asset in any frames.
Public function Const bool

DoesSocketExist ( FName SocketName
)

 Returns true if the flipbook has a specific named socket.
Public function bool

FindSocket ( FName SocketName,
int32 KeyFrameIndex,
FTransform& OutLocalTransform
)

 Search for a socket at the specified frame.
Public function Const TEnumAsByte< EFlipbookCollisionMode::Type > Returns the collision source of this flipbook animation (if any)
Public function Const UMaterialInterface * Return the default material for this flipbook.
Public function Const float Returns the nominal frame rate to play this flipbook animation back at.
Public function Const const FPaperFlipbookKeyFrame &

GetKeyFrameChecked ( int32 Index
)

 Returns the key frame at the specified index, make sure the index is valid before use.
Public function Const UFunction BlueprintCallable, Category int32

GetKeyFrameIndexAtTime ( float Time,
bool bClampToEnds
)

 Returns the keyframe index that covers the specified time (in seconds), or INDEX_NONE if none exists.
Public function Const UFunction BlueprintCallable, Category int32 Returns the total number of frames.
Public function Const UFunction BlueprintCallable, Category int32 Returns the number of key frames.
Public function Const FBoxSphereBounds Returns the render bounds of this sprite.
Public function Const UFunction BlueprintCallable, Category UPaperSprite *

GetSpriteAtFrame ( int32 FrameIndex
)

 Returns the sprite at the specified keyframe index, or nullptr if none exists.
Public function Const UFunction BlueprintCallable, Category UPaperSprite *

GetSpriteAtTime ( float Time,
bool bClampToEnds
)

 Returns the sprite at the specified time (in seconds), or nullptr if none exists.
Public function Const UFunction BlueprintCallable, Category float Returns the total duration in seconds.
Public function Const bool Returns true if the flipbook has any sockets.
Public function void Rebuilds cached data about the animation (such as total number of frames that the keyframes span, etc...)
Public function Const UFunction BlueprintCallable, Category bool

IsValidKeyFrameIndex ( int32 Index
)

 Is the specified Index within the valid range of key frames?
Public function Const void Returns a list of all of the sockets.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page