Skip to content

Class

PlaceableListEntry

Generated GDScript class reference for GridPlacement.PlaceableListEntry.

Status
Current
Version
v6.0
Source updated
Active v6.0 guide line from Grid Placement repo
Generated on
2026-09-01

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

NameKindSummary
selectedSignalEmitted when this entry is selected by the user.
variant_changedSignalEmitted after cycling to a different variant. Use `variant_index` to query the active object.
placeablePropertySingle placeable resource to display/select when no sequence is provided.
sequencePropertyOptional sequence wrapper providing variants (e.g. `PlaceableSequence`). Should implement `count()` and `get_variant(index)`.
icon_sizeProperty
fixed_entry_heightPropertyFixed 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_lockedMethod
set_selectedMethod
is_selectedMethod
get_active_placeableMethod
get_active_variant_indexMethod
get_active_display_nameMethod