Copyright © 2025-2026 Candy ArtsCustom Command
The Custom command runs your own code from a Dialogue, without writing a full Command script. Its Command key names a script extending CandyCustomEvent in Candy_DE/Scripts/Custom_Events (for example Open_Shop.gd for open_shop). That script's handle() method receives the Engine, the evaluated Data and the Line's context, and can run any code, including awaiting other operations or running Commands through engine.commands(); the Dialogue waits until it finishes. Its return value then decides whether the Dialogue continues, returns from the current Block, or ends. Candy Dialogue Engine ships none of these scripts, so until you add one every Command value is reported as unknown and the Dialogue continues. The scripts you add to Custom_Events are 'safe': updates never change them.
Keys
Every key also accepts a ¢ expression instead of a fixed value, unless its description says otherwise. See CandyRef Expressions.
Command
Description:
The name of the custom Command to run, which is the file name of its script. The value is case-insensitive.
Values:
• Script name: Such as open_shop for Open_Shop.gd.
Data
Description:
The value passed to the script's handle() method as its data argument, after evaluation.
Values:
• Any value