Skip to content

Class

PlacementPickCandidate

Generated GDScript class reference for GridPlacement.PlacementPickCandidate.

Status
Current
Version
v6.3.2
Source updated
2026-11-06
Generated on
2026-11-12

6.3. These pages document the 6.3 release, where placeable is now entry (what changed) and PlacementOwner is deprecated (migration). Still on 6.2? Your version's guides ship inside the plugin itself, under addons/grid_placement/guides/; the 6.2 URLs on this site now redirect to this series.

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 RefCounted

Members

NameKindSummary
NARROW_MISSField`hit_distance` when the narrow phase misses (broad-phase entry only).
record_idPropertyStable id of the ranked record (PlacementWorldRecord.placement_instance_id).
kindPropertyNarrow-phase kind from PlacementWorldRegistry.classify_pick_3d().
hit_distancePropertyDistance along the ray to the narrow-phase hit, or NARROW_MISS.
entry_distancePropertyDistance along the ray to the grown-box entry (always finite: only entered boxes are ranked).
pick_boxPropertyThe 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_boundsProperty
mesh_boundsProperty
has_hitMethod
to_dictMethod