Candy Logo Copyright © 2025-2026 Candy Arts
Category UI
The Category UI contains a group of choices inside a choice menu, with its own title and prompt. See Choice Menus for how menus are built.
  • Script: Choice_Category.gd
  • Templates: Scenes/Choice_Categories
  • Updates: the script is 'unsafe', and so is every template except Default.tscn (see Customizing UI Elements, on the UI page)
Nodes
VariableNode
button_listRequired. The parent node of the category's buttons.
title_nodeOptional. A Label or RichTextLabel for the category's title.
prompt_nodeOptional. A Label or RichTextLabel for the category's prompt.
Buttons are added in the order the Choice_List command lists them, and retain that order when a Choice_Status command adds one later. Customizable Functions These functions are in the UI Element's script, an 'unsafe' file. To change them, work in a copy of the script, attached to your own scenes, or updates will overwrite your changes (see Customizing UI Elements, on the UI page).
FunctionCalled / Default
setup(custom_data)Once the category's data is assigned. Displays its title and prompt.
refresh_language()When its menu's refresh_language() is called. Displays its title and prompt again in the current language, then calls refresh_language() on each button (see Translating UI Texts).
custom_data is [[menu values], [category values]]: the Custom Data of the Choice_List command, then of this category.