Candy Logo Copyright © 2025-2026 Candy Arts
Image Players
Image Players display images and frame-folder animations with the Media commands, such as illustrations, splash screens or item pictures.
  • Script: Image_Player.gd
  • Templates: Scenes/Image_Players
  • Updates: the script is 'unsafe', and so is every template except Default.tscn (see Customizing UI Elements, on the UI page)
  • Engine path: a key of your choice in media_players_paths
  • Files: see Media Files
Access settings and hook functions are shared by every media player: see Media Players. Setting Up Use a TextureRect, NinePatchRect or TextureButton as the player, attach Image_Player.gd, and list it in the Engine's media_players_paths. The template scene is ready to use. The Timer An Image Player requires a Timer child, named Timer, with its timeout signal connected to the player's _on_timer_timeout() function. It steps animations from frame to frame and times how long an image stays on screen. Without it, animations don't play, and an image's display time ends at once. The template scene already contains it: retain it when building your own. Nodes
VariableNode
image_playerRequired. The TextureRect, NinePatchRect or TextureButton. Defaults to the node the script is attached to.
Settings
SettingPurpose
default_image_extensionExtension added to image files named without one. Leave empty to use the Engine's.
default_animated_image_fpsFrame rate of frame-folder animations. Leave at 0 to use the Engine's.
animation_folder_cacheMemory budget (MB) of one animation folder: one that fits stays loaded, one that doesn't is streamed. Leave at -1 to use the Engine's.
animation_folder_streamHow many frames are loaded ahead while an animation folder is streamed. Leave at -1 to use the Engine's.
default_zThe player's Z-order.
A config.txt in an animation's folder overrides these for that animation: see Media Files.