Copyright © 2025-2026 Candy ArtsMedia Resume
The Media_Resume command resumes media players paused by Media_Pause, and cancels the automatic resume set by its Lines key. It also starts media held on its first frame by a Loops of 0, which then plays once and can be waited for. A static image is only held when it has no Duration, and stays displayed.
Keys
Every key also accepts a ¢ expression instead of a fixed value, unless its description says otherwise. See CandyRef Expressions.
Players
Description:
The media players to act on. Each key is a player's name, and its value is a Dictionary of settings for that player (see below), or an empty Dictionary for none. A single Line can control several players, each with its own settings. An entry that can't be found is reported and skipped, without affecting the others.
Values:
• Player name: A key of the Engine's media_players_paths, such as Music or Video.
• ¢ expression: Can also return the player node itself, such as ¢$UI/Radio.
Player Settings
Each player in Players accepts the following keys. Some apply only to certain types of player.
Pause_Loop_Resume
Description:
Overrides the Media_Pause's Pause_Loop_Resume, for an entry in a pause loop. The value is case-insensitive.
Values:
• Return: Resume immediately, from the pause point.
• Continue: Resume immediately, from the loop's current position.
• Finish_Return: Resume once the loop reaches its end, from the pause point.
• Finish_Continue: Resume once the loop reaches its end, continuing from there.
• null: Use the Media_Pause's value.
Resume_Volume_Time
Description:
Overrides the Media_Pause's Resume_Volume_Time, for an entry in a pause loop. Audio and video players only.
Values:
• Number of seconds: Fade over that duration.
• 0: Change the volume instantly.
• !N: Fade over N seconds, and hold the Dialogue until the fade completes.
• null: Use the Media_Pause's value.
Box
Description:
Changes the z index of the dialogue UI relative to this player, so the Dialogue can be drawn in front of or behind it. The dialogue box with its portrait, the subtitles, the chat and barks all move together. Video and image players only.
Values:
• Empty: Leave the z index unchanged, so that several players in the same Line don't override each other.
• Reset (case-insensitive): Restore each UI element's default z index.
• Number: Set the z index to exactly that value, such as 150.
• +N / -N: The player's z index plus or minus N. For example, +1 draws the dialogue in front of the player.
Take_Hold
Description:
Whether this command takes hold of the player, if it is Public. While an Engine holds it, its Public Mode determines what other Engines can do with it: nothing (Exclusive), only the commands it lists (Semi-Exclusive), or anything (Free). The hold lasts until the playback ends or is stopped.
Values:
• Empty: The player decides, from its own list of commands that take hold.
• 1: Take hold, even if the player doesn't list this command.
• -1: Never take hold.