Class PaperFlipbookComponent

Paper Flipbook Component

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
PrimitiveComponent
MeshComponent
PaperFlipbookComponent
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 PaperFlipbookComponent : MeshComponent

Properties

| Improve this Doc View Source

AccumulatedTime

Current position in the timeline

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

bLooping

Declaration
public bool bLooping { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bPlaying

Declaration
public bool bPlaying { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bReversePlayback

Declaration
public bool bReversePlayback { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CachedBodySetup

The cached body setup

Declaration
public BodySetup CachedBodySetup { get; set; }
Property Value
Type Description
BodySetup
| Improve this Doc View Source

CachedFrameIndex

Last frame index calculated

Declaration
public int CachedFrameIndex { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

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

PlayRate

Current play rate of the flipbook

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

SourceFlipbook

Flipbook currently being played

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

SpriteColor

Vertex color to apply to the frames

Declaration
public LinearColor SpriteColor { get; }
Property Value
Type Description
LinearColor
| 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

GetFlipbook()

Gets the flipbook used by this instance.

Declaration
public PaperFlipbook GetFlipbook()
Returns
Type Description
PaperFlipbook
| Improve this Doc View Source

GetFlipbookFramerate()

Get the nominal framerate that the flipbook will be played back at (ignoring PlayRate), in frames per second

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

GetFlipbookLength()

Get length of the flipbook (in seconds)

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

GetFlipbookLengthInFrames()

Get length of the flipbook (in frames)

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

GetPlaybackPosition()

Get the current playback position (in seconds) of the flipbook

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

GetPlaybackPositionInFrames()

Get the current playback position (in frames) of the flipbook

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

GetPlayRate()

Get the current play rate for this flipbook

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

IsLooping()

Get whether we are looping or not

Declaration
public bool IsLooping()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsPlaying()

Get whether this flipbook is playing or not.

Declaration
public bool IsPlaying()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsReversing()

Get whether we are reversing or not

Declaration
public bool IsReversing()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static PaperFlipbookComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
PaperFlipbookComponent
| Improve this Doc View Source

Play()

Start playback of flipbook

Declaration
public void Play()
| Improve this Doc View Source

PlayFromStart()

Start playback of flipbook from the start

Declaration
public void PlayFromStart()
| Improve this Doc View Source

Reverse()

Start playback of flipbook in reverse

Declaration
public void Reverse()
| Improve this Doc View Source

ReverseFromEnd()

Start playback of flipbook in reverse from the end

Declaration
public void ReverseFromEnd()
| Improve this Doc View Source

SetFlipbook(PaperFlipbook)

Change the flipbook used by this instance (will reset the play time to 0 if it is a new flipbook).

Declaration
public bool SetFlipbook(PaperFlipbook NewFlipbook)
Parameters
Type Name Description
PaperFlipbook NewFlipbook
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetLooping(Boolean)

true means we should loop, false means we should not.

Declaration
public void SetLooping(bool bNewLooping)
Parameters
Type Name Description
System.Boolean bNewLooping
| Improve this Doc View Source

SetNewTime(Single)

Set the new playback position time to use

Declaration
public void SetNewTime(float NewTime)
Parameters
Type Name Description
System.Single NewTime
| Improve this Doc View Source

SetPlaybackPosition(Single, Boolean)

Jump to a position in the flipbook (expressed in seconds). If bFireEvents is true, event functions will fire, otherwise they will not.

Declaration
public void SetPlaybackPosition(float NewPosition, bool bFireEvents)
Parameters
Type Name Description
System.Single NewPosition
System.Boolean bFireEvents
| Improve this Doc View Source

SetPlaybackPositionInFrames(Int32, Boolean)

Jump to a position in the flipbook (expressed in frames). If bFireEvents is true, event functions will fire, otherwise they will not.

Declaration
public void SetPlaybackPositionInFrames(int NewFramePosition, bool bFireEvents)
Parameters
Type Name Description
System.Int32 NewFramePosition
System.Boolean bFireEvents
| Improve this Doc View Source

SetPlayRate(Single)

Sets the new play rate for this flipbook

Declaration
public void SetPlayRate(float NewRate)
Parameters
Type Name Description
System.Single NewRate
| Improve this Doc View Source

SetSpriteColor(LinearColor)

Set color of the sprite

Declaration
public void SetSpriteColor(LinearColor NewColor)
Parameters
Type Name Description
LinearColor NewColor
| Improve this Doc View Source

Stop()

Stop playback of flipbook

Declaration
public void Stop()

Operators

| Improve this Doc View Source

Implicit(IntPtr to PaperFlipbookComponent)

Convert from IntPtr to UObject

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