PlaceableListEntry | Grid Placement Docs

Draft — Unreleased:This page is in active development. APIs, class names, and behavior may change before the release is finalized. Use it as a preview of what's coming — not as a stable integration target.

Rich, keyboard- and mouse-friendly list entry for selecting a ScenePlacementEntry or sequence variant. Purpose

Drop-in UI cell meant to replace a plain ItemList row with a richer control that shows an icon, name, and optional variant index with left/right arrows.
Works either with a single placeable Resource or with a sequence of variants (for example a PlaceableSequence containing multiple ScenePlacementEntry resources). Key Features
Emits selected when the user clicks or presses Enter/Space.
Emits variant_changed when cycling variants via arrow buttons or Left/Right keys.
Provides public getters so documentation and examples never rely on private helpers:
get_active_placeable() returns the currently active resource in this entry.
get_active_variant_index() returns the active variant index.
get_active_display_name() resolves a display name from the active object. Input and Accessibility
Mouse: left click selects; on-screen left/right buttons cycle variants.
Keyboard: when focused, Left/Right cycle variants; Enter/Space select. Data requirements
The active object should provide a display_name: String and optional icon: Texture2D.
When sequence is used, it should expose count() and get_variant(index).

Source: addons/grid_placement/ui/placeable/sequence/placeable_list_entry.gd

Syntax

class PlaceableListEntry extends HBoxContainer

Members

Name	Kind	Summary
`selected`	Event	Emitted when this entry is selected by the user.
`variant_changed`	Event	Emitted after cycling to a different variant. Use `variant_index` to query the active object.
`placeable`	Property	Single placeable resource to display/select when no sequence is provided.
`sequence`	Property	Optional sequence wrapper providing variants (e.g. `PlaceableSequence`). Should implement `count()` and `get_variant(index)`.
`icon_size`	Property
`fixed_entry_height`	Property	Fixed height for list entries to maintain consistent sizing.[br][br] When set to a positive value, enforces a fixed height regardless of content.[br] When set to 0, height enforcement is disabled and the entry will size naturally.[br] Default: 56 pixels to match template standard sizing.
`set_locked`	Method
`set_selected`	Method
`is_selected`	Method
`total`	Property
`get_active_placeable`	Method
`get_active_variant_index`	Method
`get_active_display_name`	Method
`obj`	Property
`dn`	Property
`nprop`	Property
`show_variants`	Property
`obj`	Property
`name_text`	Property
`icon_tex`	Property
`dn`	Property
`nprop`	Property
`it`	Property
`total`	Property
`total_variants`	Property

Source

addons/grid_placement/ui/placeable/sequence/placeable_list_entry.gd

Plugin docs root:gdscript/plugins/grid_placement_dev/docs