1. Epic GamesDeveloper
  3. UPaperFlipbookComponent

UPaperFlipbookComponent

API > API/Plugins > API/Plugins/Paper2D

   
Name UPaperFlipbookComponent
Type class
Header File /Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperFlipbookComponent.h
Include Path #include "PaperFlipbookComponent.h"

Syntax

UCLASS (MinimalAPI, ShowCategories=(Mobility, ComponentReplication), ClassGroup=Paper2D,  
       Meta=(BlueprintSpawnableComponent))  
class UPaperFlipbookComponent : public UMeshComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPaperFlipbookComponent ( const FObjectInitializer& ObjectInitializer
)

   PaperFlipbookComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnFinishedPlaying FFlipbookFinishedPlaySignature Event called whenever a non-looping flipbook finishes playing (either reaching the beginning or the end, depending on the play direction) PaperFlipbookComponent.h
  • BlueprintAssignable

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual UPaperFlipbook * GetFlipbook()

 Gets the flipbook used by this instance. PaperFlipbookComponent.h
  • BlueprintPure
  • Category="Sprite"

float GetFlipbookFramerate()

 Get the nominal framerate that the flipbook will be played back at (ignoring PlayRate), in frames per second PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

float GetFlipbookLength()

 Get length of the flipbook (in seconds) PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

int32 GetFlipbookLengthInFrames()

 Get length of the flipbook (in frames) PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

float GetPlaybackPosition()

 Get the current playback position (in seconds) of the flipbook PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

int32 GetPlaybackPositionInFrames()

 Get the current playback position (in frames) of the flipbook PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

float GetPlayRate()

 Get the current play rate for this flipbook PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

FLinearColor GetSpriteColor()

 Returns the current color of the sprite PaperFlipbookComponent.h
  • BlueprintPure
  • Category="Sprite"

bool IsLooping()

 Get whether we are looping or not PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

bool IsPlaying()

 Get whether this flipbook is playing or not. PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

bool IsReversing()

 Get whether we are reversing or not PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

void Play()

 Start playback of flipbook PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

void PlayFromStart()

 Start playback of flipbook from the start PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

void Reverse()

 Start playback of flipbook in reverse PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

void ReverseFromEnd()

 Start playback of flipbook in reverse from the end PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

virtual bool SetFlipbook ( UPaperFlipbook* NewFlipbook
)

 Change the flipbook used by this instance (will reset the play time to 0 if it is a new flipbook). PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Sprite"

void SetLooping ( bool bNewLooping
)

 True means we should loop, false means we should not. PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

void SetNewTime ( float NewTime
)

 Set the new playback position time to use PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

void SetPlaybackPosition ( float NewPosition,
bool bFireEvents
)

 Jump to a position in the flipbook (expressed in seconds). PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

void SetPlaybackPositionInFrames ( int32 NewFramePosition,
bool bFireEvents
)

 Jump to a position in the flipbook (expressed in frames). PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

void SetPlayRate ( float NewRate
)

 Sets the new play rate for this flipbook PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

void SetSpriteColor ( FLinearColor NewColor
)

 Set color of the sprite PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Sprite"

void Stop()

 Stop playback of flipbook PaperFlipbookComponent.h
  • BlueprintCallable
  • Category="Components|Flipbook"

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   PaperFlipbookComponent.h  

virtual UBodySetup * GetBodySetup()

   PaperFlipbookComponent.h  

virtual UMaterialInterface * GetMaterial ( int32 MaterialIndex
) const

   PaperFlipbookComponent.h  

virtual int32 GetNumMaterials()

   PaperFlipbookComponent.h  

virtual void GetStreamingRenderAssetInfo ( FStreamingTextureLevelContext& LevelContext,
TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingTextures
) const

   PaperFlipbookComponent.h  

virtual void GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
) const

   PaperFlipbookComponent.h  

virtual void GetUsedTextures ( TArray< UTexture* >& OutTextures,
EMaterialQualityLevel::Type QualityLevel
)

   PaperFlipbookComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   PaperFlipbookComponent.h  

virtual bool DoesSocketExist ( FName InSocketName
) const

   PaperFlipbookComponent.h  

virtual FTransform GetSocketTransform ( FName InSocketName,
ERelativeTransformSpace TransformSpace
) const

   PaperFlipbookComponent.h  

virtual bool HasAnySockets()

   PaperFlipbookComponent.h  

virtual void QuerySupportedSockets ( TArray< FComponentSocketDescription >& OutSockets
) const

   PaperFlipbookComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual const UObject * AdditionalStatObject()

   PaperFlipbookComponent.h  

virtual void CheckForErrors()

   PaperFlipbookComponent.h  

virtual void SendRenderDynamicData_Concurrent()

   PaperFlipbookComponent.h  

virtual void TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   PaperFlipbookComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   PaperFlipbookComponent.h  

virtual void Serialize ( FArchive& Ar
)

   PaperFlipbookComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CalculateCurrentFrame()

   PaperFlipbookComponent.h  

void FlipbookChangedPhysicsState()

   PaperFlipbookComponent.h  

UPaperSprite * GetSpriteAtCachedIndex()

   PaperFlipbookComponent.h  

void OnRep_SourceFlipbook ( UPaperFlipbook* OldFlipbook
)

   PaperFlipbookComponent.h  

void TickFlipbook ( float DeltaTime
)

   PaperFlipbookComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Material_DEPRECATED TObjectPtr< UMaterialInterface > DEPRECATED in 4.5: The material override for this flipbook component (if any); replaced by the Materials array inherited from UMeshComponent. PaperFlipbookComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page