| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperFlipbookComponent.h |
Include |
#include "PaperFlipbookComponent.h" |
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ShowCategories=(Mobility, ComponentReplication), ClassGroup=Paper2D,
Meta=(BlueprintSpawnableComponent))
class PAPER2UPaperFlipbookComponent : public UMeshComponent
Name | Description | ||
---|---|---|---|
|
float |
AccumulatedTime |
Current position in the timeline |
|
uint32: 1 |
bLooping |
Whether the flipbook should loop when it reaches the end, or stop |
|
uint32: 1 |
bPlaying |
Are we currently playing (moving Position) |
|
uint32: 1 |
bReversePlayback |
If playback should move the current position backwards instead of forwards |
|
UBodySetup *... |
CachedBodySetup |
The cached body setup |
|
CachedFrameIndex |
Last frame index calculated |
|
|
OnFinishedPlaying |
Event called whenever a non-looping flipbook finishes playing (either reaching the beginning or the end, depending on the play direction) |
|
|
float |
PlayRate |
Current play rate of the flipbook |
|
UPaperFlipbook ... |
SourceFlipbook |
Flipbook currently being played |
|
SpriteColor |
Vertex color to apply to the frames |
Name | Description | |
---|---|---|
|
PAPER2UPaperFlipbookComponent ( |
Name | Description | ||
---|---|---|---|
|
CalculateCurrentFrame() |
||
|
FlipbookChangedPhysicsState() |
||
|
UPaperFlipbo... |
GetFlipbook() |
Gets the flipbook used by this instance. |
|
float |
GetFlipbookFramerate() |
Get the nominal framerate that the flipbook will be played back at (ignoring PlayRate), in frames per second |
|
float |
GetFlipbookLength() |
Get length of the flipbook (in seconds) |
|
GetFlipbookLengthInFrames() |
Get length of the flipbook (in frames) |
|
|
float |
GetPlaybackPosition() |
Get the current playback position (in seconds) of the flipbook |
|
GetPlaybackPositionInFrames() |
Get the current playback position (in frames) of the flipbook |
|
|
float |
GetPlayRate() |
Get the current play rate for this flipbook |
|
UPaperSprite... |
GetSpriteAtCachedIndex() |
|
|
IsLooping() |
Get whether we are looping or not |
|
|
IsPlaying() |
Get whether this flipbook is playing or not. |
|
|
IsReversing() |
Get whether we are reversing or not |
|
|
OnRep_SourceFlipbook ( |
||
|
Play() |
Start playback of flipbook |
|
|
PlayFromStart() |
Start playback of flipbook from the start |
|
|
Reverse() |
Start playback of flipbook in reverse |
|
|
ReverseFromEnd() |
Start playback of flipbook in reverse from the end |
|
|
SetFlipbook ( |
Change the flipbook used by this instance (will reset the play time to 0 if it is a new flipbook). |
|
|
SetLooping ( |
True means we should loop, false means we should not. |
|
|
SetNewTime ( |
Set the new playback position time to use |
|
|
SetPlaybackPosition ( |
Jump to a position in the flipbook (expressed in seconds). |
|
|
SetPlaybackPositionInFrames |
Jump to a position in the flipbook (expressed in frames). |
|
|
SetPlayRate ( |
Sets the new play rate for this flipbook |
|
|
SetSpriteColor ( |
Set color of the sprite |
|
|
Stop() |
Stop playback of flipbook |
|
|
TickFlipbook ( |
Name | Description | ||
---|---|---|---|
|
FPrimitiveSc... |
CreateSceneProxy() |
Creates a proxy to represent the primitive to the scene manager in the rendering thread. |
|
UBodySetup &... |
GetBodySetup() |
Return the BodySetup to use for this PrimitiveComponent (single body case) |
|
UMaterialInt... |
GetMaterial ( |
Returns the material used by the element at the specified index |
|
GetNumMaterials() |
Return number of material elements in this primitive |
|
|
GetStreamingRenderAssetInfo ( |
Enumerates the streaming textures/meshes used by the primitive. |
|
|
GetUsedMaterials ( |
Retrieves the materials used in this component |
|
|
GetUsedTextures ( |
Returns the material textures used to render this primitive for the given platform. |
Name | Description | ||
---|---|---|---|
|
FBoxSphereBo... |
CalcBounds ( |
Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. |
|
DoesSocketExist ( |
Return true if socket with the given name exists |
|
|
GetSocketTransform ( |
Get world-space socket transform. |
|
|
HasAnySockets() |
Returns true if this component has any sockets |
|
|
QuerySupportedSockets |
Get a list of sockets this component contains |
Name | Description | ||
---|---|---|---|
|
const UObjec... |
AdditionalStatObject() |
Give a readable name for this component, including asset name if applicable |
|
CheckForErrors() |
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. |
|
|
SendRenderDynamicData_Concurrent() |
Called to send dynamic data for this component to the rendering thread |
|
|
TickComponent ( |
Function called every frame on this ActorComponent. |
Name | Description | ||
---|---|---|---|
|
Material_DEPRECATED |
DEPRECATED in 4.5: The material override for this flipbook component (if any); replaced by the Materials array inherited from UMeshComponent. |