Candy Logo Copyright © 2025-2026 Candy Arts
Video Players
Video Players play video files with the Media commands, such as cutscene videos.
  • Script: Video_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 a VideoStreamPlayer node, attach Video_Player.gd, and list it in the Engine's media_players_paths. Size and place it as the video should appear on screen. The video's sound plays through the VideoStreamPlayer's own bus property. Nodes
VariableNode
video_playerRequired. The VideoStreamPlayer. Defaults to the node the script is attached to.
Settings
SettingPurpose
default_video_extensionExtension added to video files named without one. Leave empty to use the Engine's.
default_video_fpsThe frame rate used to count frames, for videos whose own frame rate can't be read from their file. Leave at 0 to use the Engine's.
default_zThe player's Z-order.