Skip to content

Class

PlacementPickDecision

Generated GDScript class reference for GridPlacement.PlacementPickDecision.

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.

How one 3D hover resolved: which record won, through which pick authority, over which volume, and where it sat in the near-to-far ranking. Built from the same registry queries the hover itself used — no second ray, no private field — so a demolition can name its victim and the geometry that claimed it. Diagnostic-only: to_dict() is the JSON-safe form the attempt trace and the failure block read.

Source: addons/grid_placement/services/placement_pick_decision.gd

Syntax

class PlacementPickDecision extends RefCounted

Members

NameKindSummary
RAY_HITFieldThe ray's narrow phase engaged the winner.
COLUMN_FALLBACKFieldThe ray missed and the aimed column answered.
NO_LIVE_RAYFieldNo pointer ray exists (keyboard or injected seat).
NO_RECORDFieldNothing was hovered.
BROAD_PHASE_NOTEFieldBroad phase → narrow phase, in the registry's own order.
decisionPropertyWhich authority resolved the hover. See the constants above.
pick_marginPropertyRegistry pick growth (PlacementWorldRegistry.PICK_MARGIN_3D).
winner_record_idProperty
winner_kindPropertyNarrow-phase kind that decided the winner (PlacementWorldRegistry.classify_pick_3d()).
winner_pick_volumePropertyThe grown volume the winner was picked through, and the two bounds it was built from, so a mesh-derived box is never read as a mesh triangle.
winner_evidenceProperty
winner_mesh_boundsProperty
winner_rankPropertyNear-to-far position of the winner, or -1 when it was not ranked.
winner_hit_distanceProperty
winner_entry_distanceProperty
behindPropertyRecords the winner stands in front of, in ranking order.
captureMethod
resultProperty
recordProperty
rootProperty
candidateProperty
is_ray_hitMethod
to_dictMethod