Copyright © 2025-2026 Candy ArtsBG Effect Wait
The BG_Effect_Wait command pauses the Dialogue until each listed background effect 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. An effect that isn't playing doesn't delay the Dialogue. It is also accepted on a Background Scene that another Engine owns or holds, since it doesn't control the scene: 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.
Layers
Description:
The layers of the Background Scene to act on. Each key is a layer's name, and its value is a Dictionary of settings for that layer (see below), or an empty Dictionary for none. Every layer must be listed by name; there is no shorthand for all layers. An entry that can't be found is reported and skipped, without affecting the others.
Values:
• Layer name: The name of a layer node in the Background Scene's bg_container, such as Sky.
• ¢ expression: Can also return the layer node itself.
Layer Settings
Each layer in Layers lists its effects under the following key.
Effects
Description:
The effects to act on for this layer. Each key is the name of the animation the effect plays, and its value is a Dictionary of settings for that effect (see below), or an empty Dictionary for none.
Values:
• Animation name: An animation of the AnimationLibrary set in Library, such as Shake.
• Library/Name: When Library is empty, an animation already available on one of the layer's AnimationPlayers.
Effect Settings
Each effect in Effects 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, counted on the animation's own frames, otherwise at FPS.
• 0 or empty: No additional wait.
FPS
Description:
The frame rate used to count f= values in animations that have no frames of their own. An animation's frames are the keys of its most-keyed discrete track, or its step value.
Values:
• Frames per second: Such as 12.
• Empty: The default frame rate, default_effect_fps.
Library
Description:
Needed only when two effects on one layer have the same name. When empty, the effect's name matches the layer's effect of that name, whichever library it belongs to.
Values:
• Library name: The library containing the effect's animation.
• Empty: The layer's effect with that name.