Copyright © 2025-2026 Candy ArtsBG Scene
The BG_Scene command replaces the Background Scene with another one, to switch to a different layout of layers. From then on, BG commands act on the new scene. If the new scene fails to load, the current one stays in place. With an empty Scene, it removes the Background Scene instead, until a later BG_Scene loads one.
Keys
Every key also accepts a ¢ expression instead of a fixed value, unless its description says otherwise. See CandyRef Expressions.
Scene
Description:
The Background Scene to switch to.
Values:
• Scene name: A scene in bg_scenes_folder (Candy_Properties.gd), such as Forest. The .tscn extension is added when missing.
• res:// or user:// path: Loaded from that path.
• ¢ expression: Can also return a loaded PackedScene, such as ¢load("res://Scenes/Cave.tscn").
• Empty: Remove the current Background Scene, with its layers and effects. BG commands report the missing scene until a scene is loaded.
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.
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.