Candy Logo
Symbols
Settings > Project > Symbols Candy Dialogue Engine identifies some kinds of values by a symbol, such as ¢ in front of an expression. Each game project can choose its own symbols, in its Candy_Properties.gd and CandyRef_Shortcuts.gd. This page records the symbols your project uses. What each symbol means, and the rules for choosing them, are in the Candy Dialogue Engine documentation, under Getting Started > Next Steps > Symbols.
Settings Symbols
Scripts
SettingDescription
Candy PropertiesYour project's Candy_Properties.gd. It's the same setting as on the Paths page.
CandyRef ShortcutsYour project's CandyRef_Shortcuts.gd.
Update from scriptsReads the symbols below from both scripts. The note under the button states what was read from each one.
The scripts are read as text, never run. Symbols
SymbolDefault in Candy Dialogue EngineDesignates
Expression¢A value evaluated when the Line runs.
Variable dictionary€Inside an expression, a value of the variables dictionary.
Role°A Role.
Text variable start, Text variable end¤In a Spoken Line's text, a variable to display.
Substitution start, Substitution end•In a Spoken Line's text, a Word Substitution.
Separator¦Separates the values of a Word Substitution.
Text event start, Text event end‡In a Spoken Line's text, a Text Event's marker: Wait‡boom‡...
Lexicon escape start, Lexicon escape end¬In a Spoken Line's text, text the Lexicon never formats: ¬Alice¬
Each symbol can also be typed by hand. CandyRef Symbols The CandyRef symbols section lists the shortcut and lookup symbols of CandyRef_Shortcuts.gd (SHORTCUT_SYMBOLS and LOOKUP_SYMBOLS), each named after what it reads: Shortcut to globals.inventory, Lookup in globals.equipped, then globals.items. Update from scripts replaces the list with the script's. A symbol can be typed by hand; to add or remove one, modify the script, then update. If the script can't be read, the list is left as it is. Candy Dialogue Creator retains these symbols to update the files written with other ones (see Updating Symbols). A CandyRef symbol is identified by what it reads: change what a symbol reads in the script, and Candy Dialogue Creator treats it as a new symbol. Where Candy Dialogue Creator Uses Them
  • In the help of every field, which displays the values a field accepts with your symbols.
  • In dropdowns: Roles are written with your Role symbol.
  • In checks: a value that starts with your Expression symbol is treated as an expression, and isn't checked.
  • In the Symbols inserts of the Inserts panel, which type them.
  • In rules that show or hide fields.
  • In the Text Event markers the speech drop-downs of the Inserts panel type, and which the Counters exclude, along with the lexicon escape symbols.
  • In the Dialogue Converter, which escapes the 1.2 symbols it encounters in a 1.1 Line's text, so that they are still displayed as written.
  • In the files Candy Dialogue Creator writes, which store the symbols they were written with (see Updating Symbols).
If the symbols here don't match your project's, Candy Dialogue Creator misinterprets your values: expressions are reported as errors, and the game can't resolve the Roles Candy Dialogue Creator writes. Update them whenever a symbol changes in Candy_Properties.gd or CandyRef_Shortcuts.gd. Candy Dialogue Creator also offers to update them from the scripts before it updates the symbols of a file (see Updating Symbols). Changing a symbol here doesn't rewrite the open Dialogue at once: Candy Dialogue Creator asks to update it before the next save, export, test, load or import, and asks the same for every file written with other symbols when it reads one. See Updating Symbols. 1.1 Symbols The folded 1.1 symbols section contains the symbols of a Candy Dialogue Engine 1.1 project. Only the Dialogue Converter reads them, to read Dialogues written for 1.1 (see Converting 1.1 Files). Enter them by hand, from your 1.1 project's Candy_Properties.gd. They aren't read from a script: 1.1 and 1.2 use some of the same variable names for different things.