Candy Logo Copyright © 2025-2026 Candy Arts
History Display
The History Display displays the Dialogue History: the Lines spoken so far, so the player can read back what they missed. What the history contains, and how it's recorded, is explained in Dialogue History.
  • Script: History_UI.gd
  • Templates: Scenes/History_Menus
  • Updates: the script is 'unsafe', and so is every template except Default.tscn (see Customizing UI Elements, on the UI page)
  • Engine path: history_display_path in ui_elements_paths
A History Display displays the Engine history of its caller, or the general history when caller is null. Opening and Closing Nothing opens the History Display on its own: your game decides when, such as on a key press or a menu button. Call one of these functions on the candy_de autoload:
FunctionOpens
open_instance_history(engine)The Engine history of engine, in that Engine's History Display (history_display_path).
open_general_history()The general history.
Both are written in User_Data/Functions (Open_Instance_History.gd, Open_General_History.gd), and can be modified freely. These are 'safe' files: updates never overwrite them. open_general_history() requires setup: write the path to the History Display it should use in its get_node_or_null() call. To close the History Display, call its close_history() function, for example from a close button's pressed signal. Nodes
VariableNode
log_nodeRequired. RichTextLabel: the history text. Its BBCode is turned on automatically.
Place log_node in a ScrollContainer, or turn on its scroll_active, so long histories can be scrolled. Settings
SettingPurpose
end_markerText written where a Dialogue ended.
jump_markerText written where a Dialogue jumped to another Conversation.
bridge_markerText written where a Dialogue bridged to another Conversation.
return_markerText written where a Dialogue returned.
default_zThe History Display's Z-order.
Markers support BBCode (e.g. [hr] for a horizontal Line). Customizing the Text Each spoken Line is written as Name: "Text". To modify that format, edit update_history_display(), which builds the whole text from the history each time the History Display opens. The function is in History_UI.gd, an 'unsafe' file: edit it in a copy of the script, under a new name, attached to your own History Display (see Customizing UI Elements, on the UI page).