Skip to content

Class

PlacementEntry

Generated GDScript class reference for GridPlacement.PlacementEntry.

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.

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 - [TilePlacementEntry] — terrain/tile painting (replaces the internal [code]TerrainEntry[/code]) Abstract base — never instantiated directly. Subclass this to build catalog entries (ScenePlacementEntry, TilePlacementEntry). Do not mark @tool.

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.
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