Skip to content

Class

PlacementInputHandler3D

Generated GDScript class reference for GridPlacement.PlacementInputHandler3D.

Status
Current
Version
v6.2.0
Source updated
2026-09-24
Generated on
2026-10-01

Resolves where a 3D EDGE or TOP piece mounts under the cursor: sticky wall-line picking with a tremor band, explicit face slots, room-aware re-hosting, same-type run continuation, and replacement of the piece already on the aimed slot. The handler keeps only pick state (the held wall line and the held TOP socket). Input events, the rotate keys, the camera ray, the ghost and the commit stay with the caller: the caller sets [member wall_axis_lock] from its rotate keys and passes the cursor's surface-plane point as the fallback when the positioner's physics pick does not belong to the cell. Usage: var handler := PlacementInputHandler3D.new() handler.configure(grid_map, object_service, positioner) var mount := handler.resolve_edge_mount(cell, plane_hit) # [cell, edge]

Source: addons/grid_placement/systems/building/3d/placement_input_handler_3d.gd

Syntax

class PlacementInputHandler3D extends RefCounted

Members

NameKindSummary
AXIS_XFieldWall axes: X runs east/west edges, Z runs north/south edges.
AXIS_ZField
NO_AXISFieldNo axis latch: the cursor picks the nearest edge freely.
DEFAULT_EDGEFieldEdge used when the cursor gives no usable point (no camera, level ray).
wall_axis_lockPropertyAxis the rotate keys latched, or [constant NO_AXIS].
configureMethod
resetMethod
reset_wallMethod
get_held_edgeMethod
get_held_cellMethod
hold_wallMethod
axis_of_edgeMethod
cells_nearMethod
shared_hit_forMethod
resolve_edge_mountMethod
edge_under_cursorMethod
edge_pick_for_hitMethod
hysteresis_sideMethod
stick_marginMethod
axis_side_edgeMethod
face_mount_for_hitMethod
room_mount_forMethod
continues_same_type_runMethod
is_interior_columnMethod
occupant_mount_forMethod
top_under_cursorMethod
top_pick_for_hitMethod
constrain_face_to_axisMethod
toggle_wall_axisMethod