Copyright © 2025-2026 Candy ArtsInput
The Input command instantiates an Input scene, such as a text field for the player's name, and pauses the Dialogue until the scene emits the Engine's input_received signal with a finish or close event. Any scene can serve as an Input scene: the Variable, Mode, Instructions, Text and Placeholder keys are passed to its setup() method, which interprets them freely. Other keys aren't passed. The descriptions below apply to the default scene (Input_Text.gd). See Input Menus.
Keys
Every key also accepts a ¢ expression instead of a fixed value, unless its description says otherwise. See CandyRef Expressions.
File
Description:
The Input scene to open.
Values:
• Scene name: A scene in input_menus_folder (Candy_Properties.gd), such as Name_Entry. The .tscn extension is added when missing.
• res:// or user:// path: Loaded from that path.
• Empty: Default.tscn.
Parent
Description:
The scene's parent node, named like the targets of the CS_Scene Command. A parent that can't be found is reported, and the Line is skipped. This key isn't passed to the scene.
Values:
• null: The node at input_node_path, in the Engine's ui_elements_paths (the default).
• Container/Name: A node inside one of the containers listed in the Engine's cs_paths, such as Actors/Hero for the node Hero in the Actors container. The name can be a longer path, such as Actors/Hero/Screen.
• Container/°role: The node named after the Actor assigned to that Role, such as Actors/°guard. A Role always needs its container.
• Node path: A path relative to the Engine, or an absolute path such as /root/Game/Terminal.
• ¢ expression: Can also return the node itself, such as ¢$Level/Terminal (a path from the Engine).
Variable
Description:
The variable the scene stores its result in. The scene writes it, not the Command.
Values:
• Variable path: Written without ¢, such as globals.hp, $UI/Box/Label.text or file_var('user://save.json').gold.
Mode
Description:
A mode the scene reads. The default scene is a barebones template that only supports Default, so set this key to Default to use it as it is. To support other modes, add them to a copy of Input_Text.gd, since the script itself is 'unsafe' (see Input Menus).
Values:
• Default: The default scene's text field, with every check turned off.
• Text: A mode your own scene, or your copy of the template, supports.
• Empty: The default scene configures nothing: it displays no instructions and doesn't store the player's text in Variable.
Instructions
Description:
Text the default scene displays above its field, after translation.
Values:
• Text
• Empty: No instructions.
Placeholder
Description:
The default scene's placeholder text, displayed while the field is empty.
Values:
• Text
• Empty: No placeholder.
Text
Description:
The default scene's initial text.
Values:
• Text
• Empty: An empty field.