1. Epic GamesDeveloper
  3. PAPER2UPaperFlipbookComponent

PAPER2UPaperFlipbookComponent

API > API/Plugins > API/Plugins/Paper2D

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;ShowCategories&61;&40;Mobility, ComponentReplication&41;, ClassGroup&61;Paper2D,  
       Meta&61;&40;BlueprintSpawnableComponent&41;&41;  
class PAPER2UPaperFlipbookComponent : public UMeshComponent

Variables

  Type Name Description
Protected variable UProperty float AccumulatedTime Current position in the timeline
Protected variable UProperty uint32: 1 bLooping Whether the flipbook should loop when it reaches the end, or stop
Protected variable UProperty uint32: 1 bPlaying Are we currently playing (moving Position)
Protected variable UProperty uint32: 1 bReversePlayback If playback should move the current position backwards instead of forwards
Protected variable UProperty Transient TObjectPtr< UBodySetup > CachedBodySetup The cached body setup
Protected variable UProperty int32 CachedFrameIndex Last frame index calculated
Public variable UProperty BlueprintAssignable FFlipbookFinishedPlaySignature OnFinishedPlaying Event called whenever a non-looping flipbook finishes playing (either reaching the beginning or the end, depending on the play direction)
Protected variable UProperty Category, EditAnywhere float PlayRate Current play rate of the flipbook
Protected variable UProperty Category, EditAnywhere, Meta replicatedusing TObjectPtr< UPaperFlipbook > SourceFlipbook Flipbook currently being played
Protected variable UProperty Category, Interp BlueprintReadOnly FLinearColor SpriteColor Vertex color to apply to the frames

Constructors

  Type Name Description
Public function  

PAPER2UPaperFlipbookComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void  
Protected function void  
Public function Virtual UFunction BlueprintPure, Category UPaperFlipbook * Gets the flipbook used by this instance.
Public function Const UFunction BlueprintCallable, Category float Get the nominal framerate that the flipbook will be played back at (ignoring PlayRate), in frames per second
Public function Const UFunction BlueprintCallable, Category float Get length of the flipbook (in seconds)
Public function Const UFunction BlueprintCallable, Category int32 Get length of the flipbook (in frames)
Public function Const UFunction BlueprintCallable, Category float Get the current playback position (in seconds) of the flipbook
Public function Const UFunction BlueprintCallable, Category int32 Get the current playback position (in frames) of the flipbook
Public function Const UFunction BlueprintCallable, Category float Get the current play rate for this flipbook
Protected function Const UPaperSprite *  
Public function Const UFunction BlueprintPure, Category FLinearColor Returns the current color of the sprite
Public function Const UFunction BlueprintCallable, Category bool Get whether we are looping or not
Public function Const UFunction BlueprintCallable, Category bool Get whether this flipbook is playing or not.
Public function Const UFunction BlueprintCallable, Category bool Get whether we are reversing or not
Protected function UFunction void

OnRep_SourceFlipbook ( UPaperFlipbook* OldFlipbook
)

  
Public function UFunction BlueprintCallable, Category void

Play ()

 Start playback of flipbook
Public function UFunction BlueprintCallable, Category void Start playback of flipbook from the start
Public function UFunction BlueprintCallable, Category void

Reverse ()

 Start playback of flipbook in reverse
Public function UFunction BlueprintCallable, Category void Start playback of flipbook in reverse from the end
Public function Virtual UFunction BlueprintCallable, Category bool

SetFlipbook ( UPaperFlipbook* NewFlipbook
)

 Change the flipbook used by this instance (will reset the play time to 0 if it is a new flipbook).
Public function UFunction BlueprintCallable, Category void

SetLooping ( bool bNewLooping
)

 True means we should loop, false means we should not.
Public function UFunction BlueprintCallable, Category void

SetNewTime ( float NewTime
)

 Set the new playback position time to use
Public function UFunction BlueprintCallable, Category void

SetPlaybackPosition ( float NewPosition,
bool bFireEvents
)

 Jump to a position in the flipbook (expressed in seconds).
Public function UFunction BlueprintCallable, Category void

SetPlaybackPositionInFrames ( int32 NewFramePosition,
bool bFireEvents
)

 Jump to a position in the flipbook (expressed in frames).
Public function UFunction BlueprintCallable, Category void

SetPlayRate ( float NewRate
)

 Sets the new play rate for this flipbook
Public function UFunction BlueprintCallable, Category void Set color of the sprite
Public function UFunction BlueprintCallable, Category void

Stop ()

 Stop playback of flipbook
Protected function void

TickFlipbook ( float DeltaTime
)

  

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual UBodySetup * Return the BodySetup to use for this PrimitiveComponent (single body case)
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const void Enumerates the streaming textures/meshes used by the primitive.
Public function Virtual Const void

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

 Retrieves the materials used in this component
Public function Virtual void

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

 Returns the material textures used to render this primitive for the given platform.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Public function Virtual Const bool

DoesSocketExist ( FName InSocketName
)

 Return true if socket with the given name exists
Public function Virtual Const FTransform

GetSocketTransform ( FName InSocketName,
ERelativeTransformSpace TransformSpace
)

 Get world-space socket transform.
Public function Virtual Const bool Returns true if this component has any sockets
Public function Virtual Const void Get a list of sockets this component contains

Overridden from UActorComponent

  Type Name Description
Public function Virtual Const const UObject * Give a readable name for this component, including asset name if applicable
Public function Virtual void Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
Public function Virtual void Called to send dynamic data for this component to the rendering thread
Public function Virtual void

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

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
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.

Deprecated Variables

  Type Name Description
Protected variable UProperty TObjectPtr< UMaterialInterface > Material_DEPRECATED DEPRECATED in 4.5: The material override for this flipbook component (if any); replaced by the Materials array inherited from UMeshComponent.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page