Overview
Plays a spritesheet for inspection. Given a time or frame number, it extracts and returns the corresponding frame image. Use it for animation playback previews, extracting a particular frame, or starting further processing from a sheet.
Usage tips
- The basic playback preview is
animation_render(orsprite_sheet_pack).spritesheet → playback, andtime_source.time→time. Watch the image output to see the animation play. - To retrieve a particular frame, enter its number in
frame, which takes priority over time. This also supports static tasks such as extracting only frame 4 for processing. - With
loopenabled, playback wraps and continues even when time leaves the range.
Common pitfalls
- Trying to connect a raw Image: this node accepts only the SpriteSheet type. Add
contract information to an externally loaded sheet image with
sprite_sheet_infofirst.
Related nodes
sprite_sheet_pack/animation_render— supply sheetssprite_sheet_info— turn an external image into a sheet inputsprite_sheet_frame_get— focused on frame extraction instead of playbacktime_source— supply playback time
Examples
- Connect the
spritesheetfromKeyframeClip,AnimationRender,SpriteSheetPack, orSpriteSheetInfo. - Connect
TimeSource.timetotime. - Connect the
imageoutput to Preview.
Additional notes:
- Use the
frameinput orframeparameter to switch frames by index directly. SpriteSheetPlaybackdoes not accept a rawImage. When starting from an external image, pass it throughSpriteSheetInfofirst.- The node also passes through
spritesheetand helper metadata outputs, so it can preserve the playback preview in the Inspector while feeding downstream nodes.
Frame selection rules
- Indices are zero-based (the second frame is
frame = 1). Anyframe >= 0always overrides time. Secondsselectsfloor(time * FPS). With loop on, positive and negative values wrap by frame count; with loop off, they clamp to the first/last frame.- Looping
Normalizedtime usesfloor(fract(time) * frame_count), sotime = 1.0returns to the first frame. Non-looping Normalized mode keeps the endpoint mapping from 0 to the first frame and 1 to the last.