SpriteSheet Info

Overview

The entry-point node that converts an ordinary sheet image imported from outside into the SpriteSheet type. Supply hints such as "4 columns × 4 rows" or "32×32 per frame" to normalize it for playback and frame-extraction nodes.

Usage tips

• This is the first node when playing or splitting a sheet made in another tool: image_load → sprite_sheet_info → sprite_sheet_playback.
• Supply only the hints you know, such as columns=4. The remaining values are inferred from the image size. Explicit frame_width/height is more reliable than inference.
• You can also set fps here, which becomes the default downstream playback speed.

Common pitfalls

• Connecting a multi-frame sheet with no hints: with no information, it is conservatively interpreted as one image. Supply at least columns or frame_width.
• frame_width or frame_height exceeds the image: the node reports a NodeError instead of creating metadata that downstream frame extraction cannot use.
• Hints conflict or do not divide the image evenly: the node normalizes to a usable grid and reports adjusted frame_count/columns/rows and unused edge pixels in warnings.

Related nodes

• sprite_sheet_playback / sprite_sheet_frame_get — use the normalized result
• sprite_sheet_pack — generate a sheet inside the app
• image_load — load an external sheet image

Examples

1. Connect an externally imported spritesheet image to spritesheet.
2. Enter only the known information in columns, frame_width, or other fields.
3. Pass the output SpriteSheet to SpriteSheetPlayback or SpriteSheetFrameGet.

Additional notes:

• SpriteSheetInfo is an adapter from raw Image to SpriteSheet.
• If the information is incomplete, it fills in as much as possible from image size and connected hints.
• With no hints, it uses the conservative interpretation of a single image first.
• Use summary for the resolved result and warnings to see what changed from the hints.