Skip to content

Class

PlaceableSelectionUI

Generated GDScript class reference for GridPlacement.PlaceableSelectionUI.

Status
Draft
Version
v6.0
Updated
Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

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 PlacementControl

Members

NameKindSummary
valid_changedSignalEmitted when UI validity changes.
placeable_activatedSignalEmitted whenever a placeable entry is clicked, including when [member read_only_catalog] suppresses the built-in dispatch. 3D sessions listen to this.
category_selectedSignalEmitted when the visible category changes or its tabs are rebuilt.
icon_singlePropertyIcon for the single-cell tool button.
icon_linePropertyIcon for the line tool button.
icon_rectangle_fillPropertyIcon for the filled rectangle tool button.
icon_rectangle_outlinePropertyIcon for the rectangle outline tool button.
category_profiles_folderPropertyFolder of category tag resources, loaded into [member category_profiles].
placeables_folderPropertyFolder of placeable resources, loaded into [member placeables].
sequences_folderPropertyFolder of sequence resources, loaded into [member sequences].
category_profilesPropertyExtra category tags combined with [member category_profiles_folder].
placeablesPropertyExtra placeables combined with [member placeables_folder].
sequencesPropertyExtra sequences combined with [member sequences_folder]; variants cycle in one grid slot.
grid_columnsPropertyGrid column count; 1 gives a single-column list.
placeable_entry_templatePropertyTemplate for individual entries; a [PlaceableView] showing icon and name.
sequence_entry_templatePropertyTemplate for sequence entries; a [PlaceableListEntry] that cycles variants.
fixed_template_heightPropertyFixed template height in pixels; 0 disables enforcement. Individual [PlaceableView] nodes may still enforce their own fixed_view_height.
fixed_icon_sizePropertyFixed icon width and height in pixels; 0 uses template defaults.
show_category_tab_namesPropertyWhether category tab titles render; when false only icons/grid show.
hide_ui_on_selectionPropertyHides the UI after an item is selected.
read_only_catalogPropertyRenders catalog entries without entering placement mode on click. Use for demos whose placement pipeline does not yet support the entry type.
ui_rootPropertyRoot control shown and hidden as a whole.
tab_containerPropertyTab per category tag, each holding a grid of matching entries.
tool_shape_containerPropertyContainer for brush-shape buttons; null hides tool selection.
get_mode_stateMethod
resolve_placement_dependenciesMethod
resolve_placement_runtimeMethod
rebuildMethod
clearMethod
set_active_placeableMethod
get_active_placeableMethod
clear_active_selectionMethod
available_object_toolsMethod
get_runtime_issuesMethod