Grid Placement

Start here

New to the addon? Read these four guides in order, then stop until your game needs more:

1. Getting Started — from the customer download to one real placement: Setup Scene, Setup UI, one entry, one click, and what a refusal looks like.
2. Placement Workflow — preview, validate, commit, then manipulate or demolish.
3. Choosing Terrain vs Objects — decide between 2D terrain cells and entry scene objects.
4. Surface & Brush Reference — support matrix and 2D brush semantics.

What changed in 6.3

• placeable is now entry — no deprecated alias and no shim, so an old property name fails at parse time instead of silently reading nothing. The rename and its one-to-one mapping.
• The session owns the placer. PlacementOwner still loads and still works in a 6.2 scene, but it is deprecated and no new setup needs one. Placer Ownership, migrating from PlacementOwner.
• Placement can run with no actor, and a rule that needs one refuses with a reason instead of placing: Actor-Free Placement.

Minimal scene setup

A working 2D scene needs five pieces. Names are yours; types and links are what matter:

• Nodes: a GridPlacementHost (registers the session, routes input), a level with the PlacementLevelContext script, a GridPositioner2D for grid targeting, and the shipped selection UI on a CanvasLayer. No PlacementOwner node.
• Resources: one PlacementSession (bundle, settings, actions, catalog) plus one ScenePlacementEntry per entry pointing at its scene.
• Linking: call host.configure(session) with the same session assigned to the positioner; point the level context at your TileMapLayer (target_map) and a separate Node2D (objects_parent); set GridPositioner2D.placer_root to your player, or bind the placer on the session in code.
• Settings: install the default input actions, keep collision layers and masks consistent across targeting, validation, and objects, and size the indicator to your tiles.

Still on 6.2?

This site publishes one guide set, for 6.3. The full plugin archive ships the guides for the version inside it — extract your download and open addons/grid_placement/guides/. That copy matches the API your project actually has, including placeable. The old 6.2 URLs on this site redirect here.

Learn from the demos

Five reference demos ship with the plugin (top-down, isometric, platformer, hex, and 3D) and follow exactly this wiring. Open the top-down demo first and read Getting Started alongside it.