Navigation
API > API/Plugins > API/Plugins/Paper2D
Contains an animation sequence of sprite frames
| Name | UPaperFlipbook |
| Type | class |
| Header File | /Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperFlipbook.h |
| Include Path | #include "PaperFlipbook.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Meta=(DisplayThumbnail="true"))
class UPaperFlipbook : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPaperFlipbook
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPaperFlipbook
(
const FObjectInitializer& ObjectInitializer |
PaperFlipbook.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool ContainsSprite
(
UPaperSprite* SpriteAsset |
Returns true if the flipbook asset contains the specified sprite asset in any frames. | PaperFlipbook.h | |
bool DoesSocketExist
(
FName SocketName |
Returns true if the flipbook has a specific named socket. | PaperFlipbook.h | |
bool FindSocket
(
FName SocketName, |
Search for a socket at the specified frame. | PaperFlipbook.h | |
TEnumAsByte< EFlipbookCollisionMode::Type > GetCollisionSource() |
Returns the collision source of this flipbook animation (if any) | PaperFlipbook.h | |
UMaterialInterface * GetDefaultMaterial() |
Return the default material for this flipbook. | PaperFlipbook.h | |
float GetFramesPerSecond() |
Returns the nominal frame rate to play this flipbook animation back at. | PaperFlipbook.h | |
const FPaperFlipbookKeyFrame & GetKeyFrameChecked
(
int32 Index |
Returns the key frame at the specified index, make sure the index is valid before use. | PaperFlipbook.h | |
int32 GetKeyFrameIndexAtTime
(
float Time, |
Returns the keyframe index that covers the specified time (in seconds), or INDEX_NONE if none exists. | PaperFlipbook.h |
|
int32 GetNumFrames() |
Returns the total number of frames. | PaperFlipbook.h |
|
int32 GetNumKeyFrames() |
Returns the number of key frames. | PaperFlipbook.h |
|
FBoxSphereBounds GetRenderBounds() |
Returns the render bounds of this sprite. | PaperFlipbook.h | |
UPaperSprite * GetSpriteAtFrame
(
int32 FrameIndex |
Returns the sprite at the specified keyframe index, or nullptr if none exists. | PaperFlipbook.h |
|
UPaperSprite * GetSpriteAtTime
(
float Time, |
Returns the sprite at the specified time (in seconds), or nullptr if none exists. | PaperFlipbook.h |
|
float GetTotalDuration() |
Returns the total duration in seconds. | PaperFlipbook.h |
|
bool HasAnySockets() |
Returns true if the flipbook has any sockets. | PaperFlipbook.h | |
void InvalidateCachedData() |
Rebuilds cached data about the animation (such as total number of frames that the keyframes span, etc...) | PaperFlipbook.h | |
bool IsValidKeyFrameIndex
(
int32 Index |
Is the specified Index within the valid range of key frames? | PaperFlipbook.h |
|
void QuerySupportedSockets
(
TArray< FComponentSocketDescription >& OutSockets |
Returns a list of all of the sockets. | PaperFlipbook.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
PaperFlipbook.h | ||
virtual void PostLoad() |
PaperFlipbook.h | ||
virtual void Serialize
(
FArchive& Ar |
PaperFlipbook.h |