Skip to content

Class

TerrainPalette

Generated GDScript class reference for GridPlacement.TerrainPalette.

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.

A set of terrains players can paint, such as "Dungeon Pack". Only terrains listed in entries are offered. Everything else about a terrain (its tiles, color, and connections) still comes from the TileSet, matched by name when painting. var floor_entry := TilePlacementEntry.new() floor_entry.terrain_name = &"dungeon_floor" var wall_entry := TilePlacementEntry.new() wall_entry.terrain_name = &"stone_wall" var palette := TerrainPalette.new() palette.display_name = &"Dungeon Pack" palette.entries = [floor_entry, wall_entry]

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

Syntax

class TerrainPalette extends Resource

Members

NameKindSummary
display_namePropertyName shown in the UI.
iconPropertyOptional icon shown in the UI.
placement_rulesPropertyRules checked when painting any terrain in this palette.
ignore_base_rulesPropertyWhen on, PlacementSettings.base_tile_paint_rules are skipped for this palette.
entriesPropertyThe terrains players can paint. Each name must match a terrain in the target map's TileSet.
default_target_layer_namePropertyOptional TileMapLayer name, such as &"Fences", that every terrain in this palette paints on. An entry's own TilePlacementEntry.target_layer_name takes priority. Leave empty to paint on the level's target map.
get_editor_issuesMethod
get_entriesMethod