Blueprint reference

FlipbookWidget API

Playback, frame, sizing, appearance, variation, and event controls for animated UMG.

blueprint_apiruntime

Widget Reference
  -> Set Flipbook
  -> Set Playback Speed
  -> Play

On Frame Changed
  -> Update dependent UI

Functions

Asset & Playback

Set Flipbook / Get Flipbook

Assign or retrieve the PaperFlipbook asset.

Play

Start or resume automatic playback. Manual mode intentionally ignores Play.

Pause

Pause at the current playback position.

Stop

Stop and reset to the direction-appropriate end.

Restart

Reset and begin playback again.

Is Playing

Return whether automatic playback is active.

Set Playback Speed / Get Playback Speed

Set or read the non-negative playback multiplier.

Set Looping

Switch between Loop and Play Once behavior.

Set Reverse Playback

Change playback direction.

Set Playback Position / Get Playback Position

Set or read time in seconds.

Set Frame Index / Get Frame Index

Set or read the current PaperFlipbook keyframe index.

Functions

Sizing & Appearance

Set Desired Size

Set the Custom size and desired layout size.

Set Preserve Aspect Ratio

Enable or disable proportional Fit and Fill behavior.

Set Tint

Set RGB tint while preserving current opacity.

Set Opacity

Set alpha while preserving current RGB tint.

Set Color Variation by Index

Select one variation from Color Variations.

Randomize Color Variation

Choose a random configured color variation.

Assignable delegates

Blueprint Events

Playback Started

Broadcast when playback begins.

Playback Paused

Broadcast when active playback is paused.

Playback Stopped

Broadcast when active playback is stopped.

Playback Finished

Broadcast when Play Once reaches its terminal position.

Frame Changed

Broadcast with the new PaperFlipbook keyframe index.

Loop Completed

Broadcast after a loop or Ping Pong round trip.