Copyright © 2025-2026 Candy ArtsMedia Wait
The Media_Wait command pauses the Dialogue until each listed media player has played for the duration set by its Wait_Loops and Wait_Time, or has stopped. It waits for a playback that was started without a wait, for example a few Lines later. A player that isn't playing, or has already finished, doesn't delay the Dialogue. It is also accepted on a player that another Engine owns or holds, since it doesn't control the player: it only pauses this Dialogue.
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.
Wait_Loops
Description:
The number of completed loops the Dialogue waits for before resuming. The Dialogue resumes after Wait_Loops loops plus Wait_Time into the following loop, or earlier if playback ends or is stopped. When several entries of the Line have a wait, the Dialogue resumes once all of them have reached it.
Values:
• 0: Don't wait for any loops. If Wait_Time is also 0, the Dialogue doesn't wait at all.
• Positive number: The number of loops to wait for.
Wait_Time
Description:
The additional time the Dialogue waits after Wait_Loops, measured into the following loop. A time longer than the media carries over into additional loops.
Values:
• Number of seconds: Such as 2.5.
• Timestamp: In the format SS.xx, MM:SS.xx or HH:MM:SS.xx, such as 01:30.5.
• f=N: N frames, on video and image players only. An audio player with an f= value reports an error and only waits for its Wait_Loops.
• 0 or empty: No additional wait.
FPS
Description:
Video players only. The frame rate used to count f= values, overriding the video's own.
Values:
• Frames per second: Such as 24.
• Empty: The video's own frame rate, otherwise the default frame rate.
Box
Description:
Changes the z index of the dialogue UI relative to this player, once every wait of the Line has completed, 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.