| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/2D/Paper2D/Source/Paper2D/Classes/PaperFlipbook.h |
Include |
#include "PaperFlipbook.h" |
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Meta=(DisplayThumbnail="true"))
class PAPER2UPaperFlipbook : public UObject
Contains an animation sequence of sprite frames
Name | Description | ||
---|---|---|---|
|
TEnumAsByte< EF... |
CollisionSource |
Collision source. |
|
DefaultMaterial |
The material to use on a flipbook player instance if not overridden. |
|
|
float |
FramesPerSecond |
The nominal frame rate to play this flipbook animation back at. |
|
KeyFrames |
The set of key frames for this flipbook animation (each one has a duration and a sprite to display) |
Name | Description | |
---|---|---|
|
PAPER2UPaperFlipbook ( |
Name | Description | ||
---|---|---|---|
|
ContainsSprite ( |
Returns true if the flipbook asset contains the specified sprite asset in any frames. |
|
|
DoesSocketExist ( |
Returns true if the flipbook has a specific named socket. |
|
|
FindSocket ( |
Search for a socket at the specified frame. |
|
|
TEnumAsByte<... |
GetCollisionSource() |
Returns the collision source of this flipbook animation (if any) |
|
UMaterialInt... |
GetDefaultMaterial() |
Return the default material for this flipbook. |
|
float |
GetFramesPerSecond() |
Returns the nominal frame rate to play this flipbook animation back at. |
|
const FPaper... |
GetKeyFrameChecked ( |
Returns the key frame at the specified index, make sure the index is valid before use. |
|
GetKeyFrameIndexAtTime ( |
Returns the keyframe index that covers the specified time (in seconds), or INDEX_NONE if none exists. |
|
|
GetNumFrames() |
Returns the total number of frames. |
|
|
GetNumKeyFrames() |
Returns the number of key frames. |
|
|
FBoxSphereBo... |
GetRenderBounds() |
Returns the render bounds of this sprite. |
|
UPaperSprite... |
GetSpriteAtFrame ( |
Returns the sprite at the specified keyframe index, or nullptr if none exists. |
|
UPaperSprite... |
GetSpriteAtTime ( |
Returns the sprite at the specified time (in seconds), or nullptr if none exists. |
|
float |
GetTotalDuration() |
Returns the total duration in seconds. |
|
HasAnySockets() |
Returns true if the flipbook has any sockets. |
|
|
InvalidateCachedData() |
Rebuilds cached data about the animation (such as total number of frames that the keyframes span, etc...) |
|
|
IsValidKeyFrameIndex ( |
Is the specified Index within the valid range of key frames? |
|
|
QuerySupportedSockets |
Returns a list of all of the sockets. |
Name | Description | ||
---|---|---|---|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |