Copyright © 2025-2026 Candy ArtsBG Resume
The BG_Resume command resumes background layers paused by BG_Pause, and cancels the automatic resume set by its Lines key. It also starts a layer 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 accepts the following keys.
Pause_Loop_Resume
Description:
Overrides the BG_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_Pause's value.
Resume_Volume_Time
Description:
Overrides the BG_Pause's Resume_Volume_Time, for an entry in a pause loop. Video layers 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 BG_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 layer 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.