Skip to content

Class

PlacementContactRing3D

Generated GDScript class reference for GridPlacement.PlacementContactRing3D.

Status
Current
Version
v6.1.0
Source updated
2026-09-24
Generated on
2026-09-23

Ground contact ring for the 3D placement preview. Owns one pooled [MeshInstance3D] and one [ShaderMaterial] per profile, so cursor movement updates a shader uniform and a transform only — no per-frame material or mesh churn. Presentation only: it copies the authoritative ghost transform and validity, never computes them.

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

Syntax

class PlacementContactRing3D extends RefCounted

Members

NameKindSummary
RING_SHADERField
SURFACE_LIFTFieldSmall lift above the resolved support height to avoid z-fighting.
updateMethod
radiusProperty
originProperty
colorProperty
hideMethod
disposeMethod
is_ring_visibleMethod
get_ringMethod
get_materialMethod