Tabbed, grid-based UI for selecting placeables and sequences. Loads content from configured folders via [PlacementAssetResolver] and integrates with [GridPlacementHost] to enter placement mode on selection. Prefer instancing the shipped starter scene, which wires the required internal nodes: [codeblock] var selection_ui_scene = preload("res://templates/grid_placement_templates/ui/placement_selection/placeable_selection_ui.tscn") var selection_ui := selection_ui_scene.instantiate() as PlaceableSelectionUI selection_ui.placeables_folder = "res://my_placeables" selection_ui.category_profiles_folder = "res://my_profiles" selection_ui.fixed_template_height = 48 selection_ui.fixed_icon_size = 40 [/codeblock] A custom scene must assign [member ui_root] and [member tab_container] before the node enters the tree.
Source: addons/grid_placement/ui/placeable/single/placeable_selection_ui.gd
Syntax
class PlaceableSelectionUI extends PlacementControlMembers
| Name | Kind | Summary |
|---|---|---|
valid_changed | Signal | Emitted when UI validity changes. |
placeable_activated | Signal | Emitted whenever a placeable entry is clicked, including when [member read_only_catalog] suppresses the built-in dispatch. 3D sessions listen to this. |
icon_single | Property | Icon for the single-cell tool button. |
icon_line | Property | Icon for the line tool button. |
icon_rectangle_fill | Property | Icon for the filled rectangle tool button. |
icon_rectangle_outline | Property | Icon for the rectangle outline tool button. |
category_profiles_folder | Property | Folder of category tag resources, loaded into [member category_profiles]. |
placeables_folder | Property | Folder of placeable resources, loaded into [member placeables]. |
sequences_folder | Property | Folder of sequence resources, loaded into [member sequences]. |
category_profiles | Property | Extra category tags combined with [member category_profiles_folder]. |
placeables | Property | Extra placeables combined with [member placeables_folder]. |
sequences | Property | Extra sequences combined with [member sequences_folder]; variants cycle in one grid slot. |
grid_columns | Property | Grid column count; 1 gives a single-column list. |
placeable_entry_template | Property | Template for individual entries; a [PlaceableView] showing icon and name. |
sequence_entry_template | Property | Template for sequence entries; a [PlaceableListEntry] that cycles variants. |
fixed_template_height | Property | Fixed template height in pixels; 0 disables enforcement. Individual [PlaceableView] nodes may still enforce their own fixed_view_height. |
fixed_icon_size | Property | Fixed icon width and height in pixels; 0 uses template defaults. |
show_category_tab_names | Property | Whether category tab titles render; when false only icons/grid show. |
hide_ui_on_selection | Property | Hides the UI after an item is selected. |
read_only_catalog | Property | Renders catalog entries without entering placement mode on click. Use for demos whose placement pipeline does not yet support the entry type. |
ui_root | Property | Root control shown and hidden as a whole. |
tab_container | Property | Tab per category tag, each holding a grid of matching entries. |
tool_shape_container | Property | Container for brush-shape buttons; null hides tool selection. |
get_mode_state | Method | |
resolve_placement_dependencies | Method | |
resolve_placement_runtime | Method | |
rebuild | Method | |
clear | Method | |
set_active_placeable | Method | |
get_active_placeable | Method | |
clear_active_selection | Method | |
add_placeables | Method | |
remove_placeables | Method | |
get_runtime_issues | Method |