Copyright © 2025-2026 Candy ArtsBG Effect Resume
The BG_Effect_Resume command resumes background effects paused by BG_Effect_Pause, and cancels the automatic resume set by its Lines key. It also starts an effect held on its first frame by a Loops of 0, which then plays once.
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.
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.
Pause_Loop_Resume
Description:
Overrides the BG_Effect_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 BG_Effect_Pause's value.
Take_Hold
Description:
Whether this command takes hold of the background scene, 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 applies to the whole scene, and lasts until the holding Engine's Dialogue ends. Setting Take_Hold on any effect of the Line applies it to the whole scene.
Values:
• Empty: The background scene decides, from its own list of commands that take hold.
• 1: Take hold, even if the background scene doesn't list this command.
• -1: Never take hold.