Candy Logo Copyright © 2025-2026 Candy Arts
Effect Players
Effect Players play animations with the Effect commands: screen flashes, shakes, fades, or any animation of your UI.
  • Script: Effect_Player.gd
  • Updates: the script is 'unsafe' (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 Add an AnimationPlayer node, attach Effect_Player.gd, and list it in the Engine's media_players_paths. An Effect Player plays the animations it already contains, or animations loaded from AnimationLibrary files saved in the effects folder. What an effect animates Like any AnimationPlayer, it animates nodes relative to its root_node. The node paths in your animations must lead from there to the nodes to animate. A common setup is a full-screen ColorRect next to the player, which effects animate to flash or fade the screen. Nodes
VariableNode
effect_playerRequired. The AnimationPlayer. Defaults to the node the script is attached to.
Settings
SettingPurpose
default_effect_extensionExtension added to AnimationLibrary files named without one (default .tres).
default_effect_fpsThe frame rate used to count frames, for animations that have no frames of their own to count. Leave at 0 to use the Engine's.