Candy Logo Copyright © 2025-2026 Candy Arts
Media
Dialogues play audio, video and images, and animate the UI, in sync with their Lines: a jingle on a reveal, a video before a conversation, a sketch displayed beside the speaker, a screen shake on a blow. Each playback belongs to a media player: a UI Element that plays one kind of media. Audio players play sounds, video players videos, image players still images and frame animations, and effect players animations of the UI. A Dialogue addresses a player by its name, and every Media Command acts on several players at once, each with its own settings. Media Players A media player is a node of the dialogue UI with the matching script attached, listed by name in the Engine's media_players_paths. The name designates the player in Lines, and names the folder its files are loaded from: Candy_DE/Media/General/Audio/{player}, Videos/{player} or Images/{player}. How to build players, and their settings, are explained in Media Players (UI section). Where files are placed and how they are named, including frame animations and sprite sheets, is explained in Media Files. Media Commands
CommandPurpose
Media_PlayPlay a file on a player.
Media_WaitWait for a player's playback.
Media_PausePause a player, with an optional pause loop.
Media_ResumeResume a paused player.
Media_SkipSeek a player's playback to another position.
Media_VolumeSet the volume of an audio or video player, with an optional fade.
Media_StopStop a player, at once or at a scheduled point.
Effect_ commandsPlay animations on effect players: see Effects.
PageCovers
Playing MediaThe file, loops and duration, the frame on which playback ends, the frame rate, and the dialogue UI's place above or below the media.
WaitingLines that wait for media, and media that wait for Lines.
Pausing and ResumingPauses, pauses for a number of Lines, and pause loops.
Volume and SeekingVolume changes and fades, and seeking by time or frame.
StoppingImmediate and scheduled stops, and what remains on screen.
EffectsAnimations of the UI, played from animation libraries.
Shared PlayersPlayers controlled by several Dialogues.
When the Dialogue Ends When a Dialogue ends, the Engine stops the Private players it owns. Whether it also stops the Public players it holds is decided by the end_held_media setting; a player it doesn't stop continues to play (see Shared Players). Suspension When a Dialogue is suspended (see Suspending Dialogues), the media it plays pause with it. The Engine's settings decide what pauses:
  • suspend_media: pause media at all.
  • suspend_audio, suspend_video, suspend_images and suspend_animations: pause each kind of player.
  • media_suspend_immune: the names of players that are never paused, such as the music player.
Only the players the Engine sent a command to are paused: a player started by your own code, or last commanded by another Engine, continues to play.