One row of a near-to-far pick ranking: the record the ray's grown pick box enters, the narrow-phase kind that decided it, and the exact distances. A typed struct so ranking consumers read fields, not string keys; the JSON-safe dictionary form exists only at the evidence boundary.
Source: addons/grid_placement/services/placement_pick_candidate.gd
Syntax
class PlacementPickCandidate extends RefCountedMembers
| Name | Kind | Summary |
|---|---|---|
NARROW_MISS | Field | `hit_distance` when the narrow phase misses (broad-phase entry only). |
record_id | Property | Stable id of the ranked record (PlacementWorldRecord.placement_instance_id). |
kind | Property | Narrow-phase kind from PlacementWorldRegistry.classify_pick_3d(). |
hit_distance | Property | Distance along the ray to the narrow-phase hit, or NARROW_MISS. |
entry_distance | Property | Distance along the ray to the grown-box entry (always finite: only entered boxes are ranked). |
pick_box | Property | The grown pick volume the ray crossed (broad phase), and the two bounds it was built from: the registry's footprint evidence (null when the record certifies none) and the root's mesh-derived bounds (zero size when it has no meshes). Together they say which geometry the number came from instead of implying that any box is mesh-accurate. Diagnostic-only, so the commit path never pays for it. |
evidence_bounds | Property | |
mesh_bounds | Property | |
has_hit | Method | |
to_dict | Method |
Tutorials built on Grid Placement
- Godot multiplayer grid placement: one host, four sessions
- Godot 2D grid building system: paint, place, save
- Godot 3D grid building system: the runtime loop
- Godot 4 grid-building plugins: build mode vs editor tools
- 3D room placement in Godot: build rooms and stack storeys
- 3D grid placement in Godot 4: full setup tutorial
- Snap to a TileMap in Godot: 2D grid placement
- How to make a farming system in Godot
- How to snap objects to a 3D grid in Godot