Candy Logo

Inserts
An insert is a piece of text that a button types into the field being edited. The Inserts panel displays those buttons, sorted in categories that fold. Inserts spare the typing of BBCode tags, of your project's symbols, and of anything written often: a variable to display, a pause, a character's name.
Inserts
Using an Insert Click in a text field, then click an insert button. An insert has up to three parts: Left, Middle and Right.
SituationWhat is typed
No text selectedLeft and Right are typed at the caret, and the caret is left between them.
Some text selectedLeft is typed before the selection and Right after it. If the insert has a Middle, it replaces each space inside the selection.
For example, the B insert has [b] as Left and [/b] as Right. With "very" selected, it produces [b]very[/b]. A button's tooltip lists its three parts. Built-In Inserts A new Inserts panel displays the built-in inserts:
  • The BBCode tags, in groups: styles (bold, italic, underline, strikethrough), alignment, colors, font, effects, formatting, lists and tables, and data (hints, links, images).
  • Symbols: your project's Candy Dialogue Engine symbols, as set in Settings > Project > Symbols. They follow that setting. The Text Event insert types the two marker symbols, with the caret between them for the Event's name.
To type a Text Event's whole marker, or a Lexicon keyword, picked from those of your project, use the speech drop-downs (below). Built-in inserts can't be edited or deleted, but which ones a panel displays is chosen in its Buttons dialog (below). Color Tags The color inserts (Color, BG Color, FG Color, OL Color) type the color of a Color Selector panel: the one that has the same reference as the Inserts panel. Pick the color there first, then click the insert. See Color Selector. With no Color Selector for that reference, they type white. Speech Drop-Downs Three drop-downs type a Text Event marker or a Lexicon keyword into the text, picked from those of your project and of the Line:
  • A Text Event runs Commands while a Spoken Line is written, when the writing reaches its marker in the text: Wait‡boom‡... what was that? Picking one types its marker.
  • A Lexicon keyword is a word Candy Dialogue Engine formats in the text, with a tooltip or a link. Picking one types the keyword.
Drop-downLists
Text EventsThe Text Events the Variation can use: the Line's own (created in the Text Event Editor), and those of your project's Text Events dictionary. The tooltip of each item names its origin.
LexiconThe Lexicon keywords the Variation can use.
Speech InsertsBoth, in one drop-down, under a heading each, for a panel with room for only one.
A new Inserts panel displays Text Events and Lexicon in a Speech category. The drop-downs are placed, moved and removed like inserts, in the Buttons dialog, where Available lists them under Speech. See Candy Dialogue Engine's documentation for Text Events and the Lexicon. Using a Drop-Down Click in the text where the insert belongs, then open a drop-down and pick an item: it's typed at the caret. If no text field has the focus, the drop-down displays a note at its top. The lists follow the Speech Editor being typed in: its Line, and the Variation it displays, including in the Groups of a Variation Editor. In any other text field, they list what the Default Variation of the Line being edited can use, and the drop-down displays a note at its top. Text Events and Lexicon keywords are sorted by Variation in your project: * for every Variation, Default* for every Variation whose name starts with Default, or a Variation's exact name. A drop-down lists every entry that matches the Variation. List Sources The drop-downs read your project's Lexicon.gd and Text_Events.gd each time the project is scanned: when the profile opens, and when you click Refresh in the top bar. After changing one of them, click Refresh. Which scripts and variables are read is set in Settings > Project > Data, under Speech inserts (see Data). The marker's symbols are the Text Event symbols of Settings > Project > Symbols (see Symbols). Without them, the Text Events drop-down displays a note. Your Own Inserts Right-click the panel and choose Create Insert....
FieldDescription
TypeUser: available in every profile of the user. Profile: only in this profile.
CategoryThe category the insert is listed under in the Buttons dialog. Type a new one, or pick an existing one.
LabelThe text on the button.
LeftTyped before the selected text.
MiddleReplaces each space inside the selected text. Unused without a selection.
RightTyped after the selected text.
Text, Background, Text Outline, Button OutlineThe button's colors. An unchecked color follows the theme.
At least one of Left, Middle and Right must be filled in. A preview of the button is displayed at the bottom. To use the Color Selector's color in an insert of your own, write {color} where the color belongs, as in [color={color}]. To change or remove an insert, right-click its button and choose Edit Insert or Delete Insert. Deleting an insert removes it from every Inserts panel. A new insert isn't displayed in the panel automatically: add it with Buttons, below. Button Selection Right-click the panel and choose Buttons.
  • Displayed, on the left, lists the panel's categories and the inserts in each.
  • Available, on the right, lists the inserts the panel doesn't display yet, grouped by the category they were saved under, then the speech drop-downs, under Speech.
ToDo this
Add insertsSelect a category on the left, select the inserts on the right, and press ← Add. Double-clicking an insert adds it too.
Remove insertsSelect them on the left and press Remove →.
ReorderDrag inserts on the left, into any category. With no insert selected, dragging moves the selected categories.
Add a categoryPress Add Category.
Add a line between insertsPress Add Separator: a horizontal line after the selected insert.
Start a new rowPress Add Row: the inserts after the selected one start on a new row.
Rename a categorySelect it and press Rename.
Delete categories, separators and rowsSelect them and press Delete. The inserts of a deleted category return to Available.
The categories and their content belong to the panel: the same insert can be in different categories in two panels. An insert appears once per panel at most. Category names are stored in the panel as they were typed, so they're never translated. The categories of a new panel and of the built-in layout, such as Speech and Symbols, are displayed in English in every language: rename them to display them in your language (see Language). Options Right-click the panel and choose Options.
OptionDescription
ReferenceThe color tags use the color of the Color Selector with this reference.
Layout, Columns, Minimum button width, AlignmentHow the buttons are arranged, as in the Dialogue Buttons panel.
Scroll when the buttons don't fitWhen off, the panel can't shrink below its buttons.
Minimum Size, Maximum SizeThe minimum and maximum size of the panel's Area.
Keyboard Every insert can be assigned a keyboard shortcut in Settings > Shortcuts > Inserts. The shortcut types the insert into the field being edited, whether a panel displays it or not.