Class PaperFlipbook

Contains an animation sequence of sprite frames

Inheritance
System.Object
UObject
PaperFlipbook
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Paper2D
Assembly: UE4DotNet.dll
Syntax
public class PaperFlipbook : UObject

Properties

| Improve this Doc View Source

CollisionSource

Collision source

Declaration
public byte CollisionSource { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

DefaultMaterial

The material to use on a flipbook player instance if not overridden

Declaration
public MaterialInterface DefaultMaterial { get; }
Property Value
Type Description
MaterialInterface
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static PaperFlipbook DefaultObject { get; }
Property Value
Type Description
PaperFlipbook
| Improve this Doc View Source

FramesPerSecond

The nominal frame rate to play this flipbook animation back at

Declaration
public float FramesPerSecond { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

GetKeyFrameIndexAtTime(Single, Boolean)

Returns the keyframe index that covers the specified time (in seconds), or INDEX_NONE if none exists.

Declaration
public int GetKeyFrameIndexAtTime(float Time, bool bClampToEnds)
Parameters
Type Name Description
System.Single Time
System.Boolean bClampToEnds
Returns
Type Description
System.Int32
Remarks

When bClampToEnds is true, it will choose the first or last keyframe if the time is out of range.

| Improve this Doc View Source

GetNumFrames()

Returns the total number of frames

Declaration
public int GetNumFrames()
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetNumKeyFrames()

Returns the number of key frames

Declaration
public int GetNumKeyFrames()
Returns
Type Description
System.Int32
| Improve this Doc View Source

GetSpriteAtFrame(Int32)

Returns the sprite at the specified keyframe index, or nullptr if none exists

Declaration
public PaperSprite GetSpriteAtFrame(int FrameIndex)
Parameters
Type Name Description
System.Int32 FrameIndex
Returns
Type Description
PaperSprite
| Improve this Doc View Source

GetSpriteAtTime(Single, Boolean)

Returns the sprite at the specified time (in seconds), or nullptr if none exists.

Declaration
public PaperSprite GetSpriteAtTime(float Time, bool bClampToEnds)
Parameters
Type Name Description
System.Single Time
System.Boolean bClampToEnds
Returns
Type Description
PaperSprite
Remarks

When bClampToEnds is true, it will choose the first or last sprite if the time is out of range.

| Improve this Doc View Source

GetTotalDuration()

Returns the total duration in seconds

Declaration
public float GetTotalDuration()
Returns
Type Description
System.Single
| Improve this Doc View Source

IsValidKeyFrameIndex(Int32)

Is the specified Index within the valid range of key frames?

Declaration
public bool IsValidKeyFrameIndex(int Index)
Parameters
Type Name Description
System.Int32 Index
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static PaperFlipbook New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
PaperFlipbook

Operators

| Improve this Doc View Source

Implicit(IntPtr to PaperFlipbook)

Convert from IntPtr to UObject

Declaration
public static implicit operator PaperFlipbook(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
PaperFlipbook