Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Paper2D > PAPER2UPaperFlipbook

Light Theme

Dark Theme

PAPER2UPaperFlipbook

Contains an animation sequence of sprite frames

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

PAPER2UPaperFlipbook

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Meta=(DisplayThumbnail="true"))
class PAPER2UPaperFlipbook : public UObject

Remarks

Contains an animation sequence of sprite frames

Variables

	Name	Description
TEnumAsByte< EF...	CollisionSource	Collision source.
UMaterialInterf...	DefaultMaterial	The material to use on a flipbook player instance if not overridden.
float	FramesPerSecond	The nominal frame rate to play this flipbook animation back at.
TArray< FPaperF...	KeyFrames	The set of key frames for this flipbook animation (each one has a duration and a sprite to display)

Constructors

	Name	Description
	PAPER2UPaperFlipbook ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	ContainsSprite ( UPaperSprite* SpriteAsset )	Returns true if the flipbook asset contains the specified sprite asset in any frames.
bool	DoesSocketExist ( FName SocketName )	Returns true if the flipbook has a specific named socket.
bool	FindSocket ( FName SocketName, int32 KeyFrameIndex, FTransform& OutLocalTransform )	Search for a socket at the specified frame.
TEnumAsByte<...	GetCollisionSource()	Returns the collision source of this flipbook animation (if any)
UMaterialInt...	GetDefaultMaterial()	Return the default material for this flipbook.
float	GetFramesPerSecond()	Returns the nominal frame rate to play this flipbook animation back at.
const FPaper...	GetKeyFrameChecked ( int32 Index )	Returns the key frame at the specified index, make sure the index is valid before use.
int32	GetKeyFrameIndexAtTime ( float Time, bool bClampToEnds )	Returns the keyframe index that covers the specified time (in seconds), or INDEX_NONE if none exists.
int32	GetNumFrames()	Returns the total number of frames.
int32	GetNumKeyFrames()	Returns the number of key frames.
FBoxSphereBo...	GetRenderBounds()	Returns the render bounds of this sprite.
UPaperSprite...	GetSpriteAtFrame ( int32 FrameIndex )	Returns the sprite at the specified keyframe index, or nullptr if none exists.
UPaperSprite...	GetSpriteAtTime ( float Time, bool bClampToEnds )	Returns the sprite at the specified time (in seconds), or nullptr if none exists.
float	GetTotalDuration()	Returns the total duration in seconds.
bool	HasAnySockets()	Returns true if the flipbook has any sockets.
void	InvalidateCachedData()	Rebuilds cached data about the animation (such as total number of frames that the keyframes span, etc...)
bool	IsValidKeyFrameIndex ( int32 Index )	Is the specified Index within the valid range of key frames?
void	QuerySupportedSockets ( TArray< FComponentSocketDescription... )	Returns a list of all of the sockets.

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss