Skip to content

Class

PlacementEntry

Generated GDScript class reference for GridPlacement.PlacementEntry.

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

Base class for all placement entries — objects and terrains. Carries the shared surface ([member icon], [member placement_rules], [member ignore_base_rules]) so the placement pipeline and catalog can hold one canonical type: [Array] of [PlacementEntry]. Subclasses add domain-specific fields: - [ScenePlacementEntry] — object/scene placement (replaces [Placeable]) - [TilePlacementEntry] — terrain/tile painting (replaces the internal [code]TerrainEntry[/code]) [Placeable] is kept as a deprecated alias through the 6.0 deprecation window and scheduled for removal in a future release.

Source: addons/grid_placement/placement/placement_entry.gd

Syntax

class PlacementEntry extends PlacementResource

Members

NameKindSummary
iconPropertyTexture icon for UI elements.
idPropertyStable gameplay id for saves and external references. When empty, [method get_entry_id] falls back to [method get_display_name] so existing resources keep current behavior without migration.
placement_rulesPropertyPlacement rules specific to this entry. [TilePlacementEntry] stores [TilePaintRule]s here (they are [PlacementRule]s).
ignore_base_rulesPropertyWhen [code]true[/code], base config and profile rules are skipped; only [member placement_rules] are evaluated.
get_display_nameMethod
get_entry_idMethod
get_editor_issuesMethod
get_runtime_issuesMethod