Skip to content
ct

Class

TilePlacementEntry

Generated GDScript class reference for GridPlacement.TilePlacementEntry.

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.

Placement entry for terrain/tile painting into a [TileMapLayer]. Associates a terrain name with optional placement rules and UI metadata. This is the canonical name replacing the internal-only [code]TilePlacementEntry[/code] (which was never released — no consumer migration needed). Usage: var entry := TilePlacementEntry.new() entry.terrain_name = "dungeon_floor" entry.icon = preload("res://art/icon.png")

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

Syntax

class TilePlacementEntry extends PlacementEntry

Members

NameKindSummary
terrain_namePropertyInherits [member PlacementEntry.placement_rules] typed as [Array][PlacementRule]. [TilePaintRule]s stored here are valid [PlacementRule]s; use [code]rule is TilePaintRule[/code] or [code]rule as TilePaintRule[/code] to access tile-specific methods. The terrain name that must match [method TileSet.get_terrain_name]. This is the single source of truth for terrain identification.
demolishablePropertyEnables DEMOLISH mode to erase this terrain entirely. Keep false for normal ground terrains like grass/snow; set true for removable terrain features such as fence tiles.
build_costPropertyOptional BuildCost refunded on terrain demolish.
get_display_nameMethod
is_validMethod
get_color_from_tilesetMethod