Skip to content

Class

TerrainPaletteUI

Generated GDScript class reference for GridPlacement.TerrainPaletteUI.

Status
Current
Version
v6.3.0
Source updated
2026-10-29
Generated on
2026-10-29

6.3. These pages document the 6.3 release, where placeable is now entry (what changed) and PlacementOwner is deprecated (migration). Still on 6.2? Your version's guides ship inside the plugin itself, under addons/grid_placement/guides/; the 6.2 URLs on this site now redirect to this series.

The terrain palette: a grid of terrains players can pick to paint with. Shows the terrains in terrain_palette, or the bundle's default palette (GridPlacementBundle.terrain_palette) when that is empty.

Source: addons/grid_placement/ui/terrain/terrain_palette_ui.gd

Syntax

class TerrainPaletteUI extends PlacementControl

Members

NameKindSummary
terrain_selectedSignalEmitted when a picked terrain is accepted and painting can start.
valid_changedSignalEmitted after the palette is rebuilt: true when it shows terrains, false when it could not.
terrain_palettePropertyTerrains to show. When empty, the bundle's default palette is used.
terrain_entry_templatePropertyScene for each terrain. Its root must be a TerrainPaletteEntryView.
fixed_template_heightPropertyHeight of each entry, in pixels. 0 lets entries size to their content.
hide_ui_on_selectionPropertyHides the palette after a terrain is picked.
ui_rootPropertyRoot control shown and hidden as a whole.
grid_containerPropertyGrid the terrain entries are added to.
resolve_placement_dependenciesMethod
resolve_placement_runtimeMethod
rebuildMethod
clearMethod
get_runtime_issuesMethod
mesh_library_item_swatch_colorMethod