Skip to content
ct

Class

TerrainCatalogFilter

Generated GDScript class reference for GridPlacement.TerrainCatalogFilter.

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.

Pure data filter that reconciles a [PlacementCatalog] and [TerrainPalette] into a single view of "which terrains are actually available for this session". Extracted from [TerrainPaletteUI] so the catalog-first filtering contract is testable without UI scene-tree assumptions (no [Node] instantiation, no [code]_ready[/code]/[code]_validate[/code] asserts, no parent/child wiring). Catalog-first means: if the session's catalog has [code]tile_entries[/code], those are the canonical entries and the palette is treated as a display theme (icons + colors) rather than the source of truth. The palette's own entries are still available for visual continuity, but the catalog owns what the user can actually select. When no catalog is provided, falls back to the legacy palette-only resolution so scenes that pre-date the catalog contract keep working.

Source: addons/grid_placement/placement/terrain/terrain_catalog_filter.gd

Syntax

class TerrainCatalogFilter extends RefCounted

Members

NameKindSummary
catalog_from_sessionMethod
catalog_vProperty
get_available_terrain_namesMethod
namesProperty
resolve_entry_for_terrainMethod