Candy Logo Copyright © 2025-2026 Candy Arts
Audio Players
Audio Players play audio files with the Media commands: music, ambience, sound effects, or speech outside of Spoken Lines.
  • Scripts: Audio_Player.gd (AudioStreamPlayer), Audio_Player_2D.gd (AudioStreamPlayer2D), Audio_Player_3D.gd (AudioStreamPlayer3D)
  • Updates: the scripts are '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 AudioStreamPlayer node (or its 2D or 3D version, for sound emitted from a position in the game world), attach the matching script, and list it in the Engine's media_players_paths. Assign each Audio Player its audio bus (e.g. a Music bus), in the node's bus property, so players can adjust each kind of sound separately. Each player plays one file at a time: use one player for each kind of sound that may play at the same time (music, ambience, sound effects...). Nodes
VariableNode
audio_playerRequired. The audio node. Defaults to the node the script is attached to.
Settings
SettingPurpose
default_audio_extensionExtension added to audio files named without one. Leave empty to use the Engine's.