Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UMeshComponent → UPaperFlipbookComponent
Implements Interfaces
- IAsyncPhysicsStateProcessor
- IInterface_AssetUserData
- IInterface_AsyncCompilation
- INavRelevantInterface
- IPhysicsComponent
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 |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UPaperFlipbook * GetFlipbook() |
Gets the flipbook used by this instance. | PaperFlipbookComponent.h |
|
float GetFlipbookFramerate() |
Get the nominal framerate that the flipbook will be played back at (ignoring PlayRate), in frames per second | PaperFlipbookComponent.h |
|
float GetFlipbookLength() |
Get length of the flipbook (in seconds) | PaperFlipbookComponent.h |
|
int32 GetFlipbookLengthInFrames() |
Get length of the flipbook (in frames) | PaperFlipbookComponent.h |
|
float GetPlaybackPosition() |
Get the current playback position (in seconds) of the flipbook | PaperFlipbookComponent.h |
|
int32 GetPlaybackPositionInFrames() |
Get the current playback position (in frames) of the flipbook | PaperFlipbookComponent.h |
|
float GetPlayRate() |
Get the current play rate for this flipbook | PaperFlipbookComponent.h |
|
FLinearColor GetSpriteColor() |
Returns the current color of the sprite | PaperFlipbookComponent.h |
|
bool IsLooping() |
Get whether we are looping or not | PaperFlipbookComponent.h |
|
bool IsPlaying() |
Get whether this flipbook is playing or not. | PaperFlipbookComponent.h |
|
bool IsReversing() |
Get whether we are reversing or not | PaperFlipbookComponent.h |
|
void Play() |
Start playback of flipbook | PaperFlipbookComponent.h |
|
void PlayFromStart() |
Start playback of flipbook from the start | PaperFlipbookComponent.h |
|
void Reverse() |
Start playback of flipbook in reverse | PaperFlipbookComponent.h |
|
void ReverseFromEnd() |
Start playback of flipbook in reverse from the end | PaperFlipbookComponent.h |
|
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 |
|
void SetLooping
(
bool bNewLooping |
True means we should loop, false means we should not. | PaperFlipbookComponent.h |
|
void SetNewTime
(
float NewTime |
Set the new playback position time to use | PaperFlipbookComponent.h |
|
void SetPlaybackPosition
(
float NewPosition, |
Jump to a position in the flipbook (expressed in seconds). | PaperFlipbookComponent.h |
|
void SetPlaybackPositionInFrames
(
int32 NewFramePosition, |
Jump to a position in the flipbook (expressed in frames). | PaperFlipbookComponent.h |
|
void SetPlayRate
(
float NewRate |
Sets the new play rate for this flipbook | PaperFlipbookComponent.h |
|
void SetSpriteColor
(
FLinearColor NewColor |
Set color of the sprite | PaperFlipbookComponent.h |
|
void Stop() |
Stop playback of flipbook | PaperFlipbookComponent.h |
|
Overridden from UPrimitiveComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPrimitiveSceneProxy * CreateSceneProxy() |
PaperFlipbookComponent.h | ||
virtual UBodySetup * GetBodySetup() |
PaperFlipbookComponent.h | ||
virtual UMaterialInterface * GetMaterial
(
int32 MaterialIndex |
PaperFlipbookComponent.h | ||
virtual int32 GetNumMaterials() |
PaperFlipbookComponent.h | ||
virtual void GetStreamingRenderAssetInfo
(
FStreamingTextureLevelContext& LevelContext, |
PaperFlipbookComponent.h | ||
virtual void GetUsedMaterials
(
TArray< UMaterialInterface* >& OutMaterials, |
PaperFlipbookComponent.h | ||
virtual void GetUsedTextures
(
TArray< UTexture* >& OutTextures, |
PaperFlipbookComponent.h |
Overridden from USceneComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBoxSphereBounds CalcBounds
(
const FTransform& LocalToWorld |
PaperFlipbookComponent.h | ||
virtual bool DoesSocketExist
(
FName InSocketName |
PaperFlipbookComponent.h | ||
virtual FTransform GetSocketTransform
(
FName InSocketName, |
PaperFlipbookComponent.h | ||
virtual bool HasAnySockets() |
PaperFlipbookComponent.h | ||
virtual void QuerySupportedSockets
(
TArray< FComponentSocketDescription >& OutSockets |
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, |
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 |